ashtanko/the-algorithms

# The Kotlin Algorithms

Implementation of different algorithms and data structures using Kotlin lang

[![Build](https://github.com/ashtanko/the-algorithms/actions/workflows/ci.yml/badge.svg)](https://github.com/ashtanko/the-algorithms/actions/workflows/ci.yml)

[![codebeat badge](https://codebeat.co/badges/f80b1c3d-d24b-4abb-b39c-b891c3b5c612)](https://codebeat.co/projects/github-com-ashtanko-the-algorithms-main)
[![CodeFactor](https://www.codefactor.io/repository/github/ashtanko/the-algorithms/badge)](https://www.codefactor.io/repository/github/ashtanko/the-algorithms)
[![Maintainability](https://api.codeclimate.com/v1/badges/1a2a2ecaee3023a36b87/maintainability)](https://codeclimate.com/github/ashtanko/the-algorithms/maintainability)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3eecbb4a701d426eb5d1d2dcbb9d7679)](https://app.codacy.com/gh/ashtanko/the-algorithms/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Hits-of-Code](https://hitsofcode.com/github/ashtanko/the-algorithms?branch=main&label=Hits-of-Code)](https://hitsofcode.com/github/ashtanko/the-algorithms/view?branch=main&label=Hits-of-Code)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ashtanko/the-algorithms/blob/main/LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fashtanko%2Fthe-algorithms.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fashtanko%2Fthe-algorithms?ref=badge_shield)
[![CodeStyle](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
[![Kotlin Version](https://img.shields.io/badge/kotlin-1.9.21-blue.svg)](http://kotlinlang.org/)

[![codacy test coverage](https://app.codacy.com/project/badge/Coverage/3eecbb4a701d426eb5d1d2dcbb9d7679)](https://app.codacy.com/gh/ashtanko/the-algorithms/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[![codeclimate test coverage](https://api.codeclimate.com/v1/badges/1a2a2ecaee3023a36b87/test_coverage)](https://codeclimate.com/github/ashtanko/the-algorithms/test_coverage)
[![codecov test coverage](https://codecov.io/gh/ashtanko/the-algorithms/branch/main/graph/badge.svg?token=6vzgrCAl5c)](https://codecov.io/gh/ashtanko/the-algorithms)
[![Coverage Status](https://coveralls.io/repos/github/ashtanko/the-algorithms/badge.svg?branch=main)](https://coveralls.io/github/ashtanko/the-algorithms?branch=main)

## Overview

The repository is a collection of open-source implementations of a variety of algorithms implemented in Kotlin and
licensed under MIT License.
The implementations and their associated documentations are meant to provide a learning resource for educators and
students.
Hence, one may find more than one implementation for the same objective but using different algorithm strategies and
optimizations.

## Features

* The repository provides implementations of various algorithms in one of the most fundamental general purpose languages
  - [Kotlin](https://kotlinlang.org/)).
* Well documented source code with detailed explanations provide a valuable resource for educators and students alike.
* Source codes are compiled and tested
* Self-checks within programs ensure correct implementations with confidence.
* Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other
  applications.
* Makefile
* JUnit 5
* Code checks (detekt, ktlint, spotless)
* CI
# detekt

## Metrics

* 275 number of properties

* 229 number of functions

* 140 number of classes

* 9 number of packages

* 84 number of kt files

## Complexity Report

* 7,573 lines of code (loc)

* 3,709 source lines of code (sloc)

* 2,870 logical lines of code (lloc)

* 3,288 comment lines of code (cloc)

* 425 cyclomatic complexity (mcc)

* 214 cognitive complexity

* 0 number of total code smells

* 88% comment source ratio

* 148 mcc per 1,000 lloc

* 0 code smells per 1,000 lloc

## Findings (0)

generated with [detekt version 1.23.7](https://detekt.dev/) on 2024-10-15 16:57:19 UTC