algorithmz 0.1.8

This is the corresponding implemenation of the python module of the same name.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

### Welcome
<p align="center">
<a href="https://github.com/r3ap3rpy/algorithms/actions?query=workflow%3ABuild+event%3Apush+branch%3Amain" target="_blank">
    <img src="https://github.com/r3ap3rpy/algorithms/actions/workflows/build.yml/badge.svg?event=push&branch=main" alt="Build">
</a>
    <a href="https://github.com/r3ap3rpy/algorithms/actions?query=workflow%3ATest+event%3Aworkflow_run+branch%3Amain" target="_blank">
    <img src="https://github.com/r3ap3rpy/algorithms/actions/workflows/test.yml/badge.svg?branch=main" alt="Test">
</a>
        <a href="https://github.com/r3ap3rpy/algorithms/actions?query=workflow%3APublish+event%3Aworkflow_run+branch%3Amain" target="_blank">
    <img src="https://github.com/r3ap3rpy/algorithms/actions/workflows/publish.yml/badge.svg?branch=main" alt="Publish">
</a>
</p>

I found this neat little python modul called [algorithms](https://pypi.org/project/algorithms) and thought I would rewrite it in Rust.


The official github repository can be found here at [algorithms](https://github.com/r3ap3rpy/algorithms.git).

If you want to install it directly from here use the following commands.

``` bash
git clone https://github.com/r3ap3rpy/algorithms.git
cd algorithms
cargo test
cargo install --path .
```

If you want to use it in your project use the following commands. It is published on [crates.io](https://crates.io/crates/algorithmz)

``` bash
cargo new <myproject>
cd myproject
cargo add algorithmz
```

##### Sorting

The following algorithms are implemented:
- bubble sort
- bead sort 

##### Arrays

The following algorithms are implemented:
- flatten

> [!WARNING]
> This is still in progress.