# LexorankEx

[![Module Version](https://img.shields.io/hexpm/v/lexorank_ex)](https://hex.pm/packages/lexorank_ex/0.1.0)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/lexorank_ex/0.1.0/LexorankEx.html)

LexoRank on Elixir. An implementation of a list ordering system.

The base62: (0-9A-Za-z) pre-generated symbol table are used
where minimum value is 0 and maximum value is z

## Installation

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

```elixir
def deps do
  [
    {:lexorank_ex, "~> 0.1.0"}
  ]
end
```


## Usage

```elixir
# Generates middle string between max and min value for provided division

divison = 8
LexorankEx.middle(divison) => "UzUzUzUz"

# Default step is 8

# Finds next, lexically greater value:

LexorankEx.next("00000") == "00008"
LexorankEx.next("00000", 1) == "00001"

LexorankEx.next("a") == "i"
LexorankEx.next("a", 1) == "b"

# Finds previous, lexically lesser value:

LexorankEx.prev("00008") == "00000"
LexorankEx.prev("00008", 1) == "00007"

LexorankEx.prev("i") == "a"
LexorankEx.prev("b", 1) == "a"

# Finds middle point between maximum and minimum value. Order doesn't matter:
LexorankEx.between("a", "b") == "aV"
LexorankEx.between("a", "c") == "b"
LexorankEx.between("aaaaz", "zzzzz") == "nHnHy"
```


## References

Thanks to the [mudderjs](https://github.com/fasiha/mudderjs) and its explanation of the algorithm