# Stella

Rapid Elixir library providing implementations of the most famous algorithms, data structures and math functions. Key features of this library are:
- a high test coverage (near to 100%)
- good quality documentation with examples of usage to each function
- featured complexity of each action

## Installation

The package can be installed by adding `stella` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:stella, "~> 0.6.0"}
  ]
end
```

Link to hex package: https://hex.pm/packages/stella

## Documentation
Generated with ExDoc: https://hexdocs.pm/stella/Stella.html


## Content of version 0.6.0

### Math
- [x] Cartesian
- [x] Easing functions
- [x] Isometric
- [x] Common number operations like clamp, nearly equal, is power etc
- [x] Time converter (hms, sec, ms etc)
- [x] Vector 2D
- [x] Vector 3D
- [x] Ackermann function
- [x] Fibonacci sequence
- [x] Math intervals
 

### Algorithms
- [x] Quick sort
- [x] Counting sort
- [x] Insertion sort
- [x] Binary search
- [x] Bubble sort


### Data structures
- [x] Queue
- [x] Stack
- [x] Priority queue
- [x] Struct, converting a nested Struct to a nested Map 
- [x] Heap with heapsort

## Contributing

We appreciate any contribution to `Stella`. You will need to have installed the newest versions of Elixir and Erlang at your machine. Then, follow the steps bellow:

1.  Install project dependencies

    ```bash
    $ mix deps.get
    ```

2.  Watch tests

    ```bash
    $ mix test.watch
    ```

## Changelog

### Version 0.6.0 (24 September 2021)
- Create `Interval` module with `random_number` and `member?` methods
- Rewrite `Heap` data structure and add `heapsort` to it
- Add type specs to a whole project

### Version 0.5.0 (02 March 2021) 
- Add a new documentation test, expand the method descriptions 
- Add to Time module conversions from miliseconds or seconds to HMS format
- Add conversion of nested structures to nested maps

### Version 0.4.0 (21 October 2020) 
- Stella module can return current version of package
- Add Fibonacci sequence
- Add implementation of counting sort
- Create clamp method for a Number module that clamps number in min-max range
- Create nearly equal method to Number module that determines whether number is equal to the other by given epsilon
- Add Binary search algorithm
- Create implementation of insertion sort
- Create Elixir's implementation of bubble sort
- Create Binary Search Tree data structure (without deletion option)

### Version 0.3.1 (21 August 2020)
- Fix Heap documentation examples
- Fix unused variables
- Rename some unit test headers to more appropriate

### Version 0.3.0 (21 August 2020)
- Add Ackermann function
- Create implementation of Quicksort algorithm
- Create implementation of Queue data structure
- Create implementation of Stack data structure
- Add service of cartesian diagram
- Create implementation of two dimensional vector 
- Create implementation of three dimensional vector 
- Add quick sort
- Add easing functions
- Add service of isometric layout
- Implement max and min heap

### Version 0.2.1 (5 August 2020)
- fix documentation examples validation

### Version 0.2.0 (5 August 2020)
- Add basic number operations
- Create time converter

### Version 0.1.0 (5 August 2020)
- Create initial project package
- Create proof of concept