Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lnikkila/elixir-range-extras
Elixir range utilities: constant-time random sampling and set operations.
https://github.com/lnikkila/elixir-range-extras
Last synced: about 1 month ago
JSON representation
Elixir range utilities: constant-time random sampling and set operations.
- Host: GitHub
- URL: https://github.com/lnikkila/elixir-range-extras
- Owner: lnikkila
- Archived: true
- Created: 2015-12-07T00:05:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-07T17:51:24.000Z (about 9 years ago)
- Last Synced: 2024-09-06T12:00:12.063Z (3 months ago)
- Language: Elixir
- Homepage: https://hexdocs.pm/range_extras/
- Size: 11.7 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Elixir range utilities: constant-time random sampling and set operations. (Text and Numbers)
- fucking-awesome-elixir - elixir-range-extras - Elixir range utilities: constant-time random sampling and set operations. (Text and Numbers)
- awesome-elixir - elixir-range-extras - Elixir range utilities: constant-time random sampling and set operations. (Text and Numbers)
README
# RangeExtras
[![Hex.pm][hexpm-badge]][hexpm]
[![Build status][circleci-badge]][circleci]
[![Test coverage][coveralls-badge]][coveralls]
**Elixir range utilities: constant-time random sampling and set operations.**
## Installation
First, please make sure that you’re running Erlang/OTP 18.0 or newer.
Add `range_extras` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:range_extras, "~> 0.1.0"}]
end
```
Run `mix deps.get`.
Read the latest documentation at .
## Set operations
- `union/2`
- `difference/2`
- `intersection/2`
These functions take two ranges and return a list of zero to two ranges:
```elixir
iex> RangeExtras.union(1..4, 3..5)
[1..5]
iex> RangeExtras.difference(8..1, 4..4)
[8..5, 3..1]
iex> RangeExtras.intersection(8..1, -4..0)
[]
```
They’re implemented as simple `cond` clauses that match on the start and end
values of the ranges, so they run in constant time.
Ranges are always inclusive.
The direction of the resulting ranges is the same as the direction of the first
given range:
```elixir
iex> RangeExtras.union(1..4, 3..5)
[1..5]
iex> RangeExtras.union(4..1, 3..5)
[5..1]
```
## Random sampling
- `random/1`
Works in the same way as `Enum.random/1`, but runs in constant time as well
since it only uses the start and end values of the range.
The implementation uses Erlang’s `:rand` module. You don’t need to seed the
generator like you have to currently do with `Enum.random/1` that uses
`:random` instead.
(The development version of Elixir now uses `:rand`.)
## Licence
> ISC License (ISC)
>
> Copyright © 2015 Leo Nikkilä
>
> Permission to use, copy, modify, and/or distribute this software for any
> purpose with or without fee is hereby granted, provided that the above
> copyright notice and this permission notice appear in all copies.
>
> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
> REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
> AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
> INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
> LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
> OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
> PERFORMANCE OF THIS SOFTWARE.
[hexpm]: https://hex.pm/packages/range_extras
[hexpm-badge]: https://img.shields.io/hexpm/v/range_extras.svg
[circleci]: https://circleci.com/gh/lnikkila/elixir-range-extras
[circleci-badge]: https://img.shields.io/circleci/project/lnikkila/elixir-range-extras.svg
[coveralls]: https://coveralls.io/github/lnikkila/elixir-range-extras
[coveralls-badge]: https://img.shields.io/coveralls/lnikkila/elixir-range-extras.svg