Packages

weighted_random

1.0.0-alpha.2
1.0.0 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 1.0.0-alpha.2 1.0.0-alpha.1 1.0.0-alpha.0 0.4.2 0.4.1 0.4.0 0.3.1 0.3.0 0.2.0 0.1.0

Fast and flexible framework for simulating weighted randomness with custom probabilities and bias.

HexDocs Report package

Current section

Files

Jump to
Readme
14 Versions
3 Dependencies
Dependants
Files
Activity
weighted_random README.md
Raw

README.md 

# README



## Quick example



Pick a random number between 0 and 10, but 7 is 50x more likely than any other number to occur.



```elixir

iex> outcomes = 0..10

iex> weights = [ %{target: 7, weight: 50} ]

iex> WeightedRandom.rand(outcomes, weights)

7

```



## Current state of the project



Version 1.0.0: In alpha. Actively being developed.



Version 0.4.x: Stable.



Improvements in v1.0.0:



- Significant performance Improvements

- Support for probabilities, not just weights

- Better user experience and quality of life improvements

- Polished docs and a livebook tutorial

- swappable backends, not locked into any particular algorithm.



## Docs



See [Hex docs](https://weighted-random.hexdocs.pm/1.0.0-alpha.1/WeightedRandom.html). I will not keep documentation in the README.