Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/princemaple/elixir-queue
Queue data structure for Elixir-lang
https://github.com/princemaple/elixir-queue
data-structure elixir hex queue wrapper
Last synced: about 1 month ago
JSON representation
Queue data structure for Elixir-lang
- Host: GitHub
- URL: https://github.com/princemaple/elixir-queue
- Owner: princemaple
- License: mit
- Created: 2016-12-26T09:42:28.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T01:58:28.000Z (5 months ago)
- Last Synced: 2024-10-30T10:07:07.761Z (about 1 month ago)
- Topics: data-structure, elixir, hex, queue, wrapper
- Language: Elixir
- Homepage: https://hexdocs.pm/qex
- Size: 93.8 KB
- Stars: 33
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Wraps `:queue`, with improved API and `Inspect`, `Collectable` and `Enumerable` protocol implementations. (Algorithms and Data structures)
- fucking-awesome-elixir - qex - Wraps `:queue`, with improved API and `Inspect`, `Collectable` and `Enumerable` protocol implementations. (Algorithms and Data structures)
- awesome-elixir - qex - Wraps `:queue`, with improved API and `Inspect`, `Collectable` and `Enumerable` protocol implementations. (Algorithms and Data structures)
README
# Qex
[](https://github.com/princemaple/elixir-queue/actions/workflows/elixir.yml)
[](https://hex.pm/packages/qex)
[](https://hexdocs.pm/qex/)
[](https://hex.pm/packages/qex)
[](https://github.com/princemaple/elixir-queue/blob/master/LICENSE.md)
[](https://github.com/princemaple/elixir-queue/commits/master)
A `:queue` wrapper with improvements in API and addition of Protocol implementations
### Protocols
`Inspect`, `Collectable` and `Enumerable` are implemented,
use Qex with `IO.inspect` and `Enum` functions!
### Function signatures
Parameters are re-ordered to better suit Elixir's awesome `|>`
## Installation
The package can be installed as:
1. Add `:qex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:qex, "~> 0.5"}
]
end
```
2. Run `mix deps.get`
## How to use
[Read the docs](https://hexdocs.pm/qex/Qex.html)
#### Protocols
```elixir
iex> inspect Qex.new
"#Qex<[]>"
iex> Enum.count Qex.new(1..5)
5
iex> Enum.empty? Qex.new
true
iex> Enum.map Qex.new([1, 2, 3]), &(&1 + 1)
[2, 3, 4]
iex> inspect Enum.into(1..5, %Qex{})
"#Qex<[1, 2, 3, 4, 5]>"
# Leverages :queue.member/2 under the hood for performance
iex> Enum.member? Qex.new(1..10_000), 9_999
true
```
#### Create a new queue from a range
```elixir
iex> inspect Qex.new(1..3)
"#Qex<[1, 2, 3]>"
```
#### Create a new queue from a list
```elixir
iex> inspect Qex.new([1, 2, 3])
"#Qex<[1, 2, 3]>"
```
#### Add an element to the back of the queue
```elixir
iex> q = Qex.new([:mid])
iex> Enum.to_list Qex.push(q, :back)
[:mid, :back]
```
#### Add an element to the front of the queue
```elixir
iex> q = Qex.new([:mid])
iex> Enum.to_list Qex.push_front(q, :front)
[:front, :mid]
```
#### Get and remove an element from the front of the queue
```elixir
iex> q = Qex.new([:front, :mid])
iex> {{:value, item}, _q} = Qex.pop(q)
iex> item
:front
iex> q = Qex.new
iex> {empty, _q} = Qex.pop(q)
iex> empty
:empty
```
#### Get and remove an element from the back of the queue
```elixir
iex> q = Qex.new([:mid, :back])
iex> {{:value, item}, _q} = Qex.pop_back(q)
iex> item
:back
iex> q = Qex.new
iex> {empty, _q} = Qex.pop_back(q)
iex> empty
:empty
```
#### Reverse a queue
```elixir
iex> q = Qex.new(1..3)
iex> Enum.to_list q
[1, 2, 3]
iex> Enum.to_list Qex.reverse(q)
[3, 2, 1]
```
#### Split a queue into two, the front n items are put in the first queue
```elixir
iex> q = Qex.new 1..5
iex> {q1, q2} = Qex.split(q, 3)
iex> Enum.to_list q1
[1, 2, 3]
iex> Enum.to_list q2
[4, 5]
```
#### Join two queues together
```elixir
iex> q1 = Qex.new 1..3
iex> q2 = Qex.new 4..5
iex> Enum.to_list Qex.join(q1, q2)
[1, 2, 3, 4, 5]
```
#### Return the first item
```elixir
iex> q1 = Qex.new 1..3
iex> Qex.first(q1)
{:value, 1}
iex> q2 = Qex.new []
iex> Qex.first(q2)
:empty
iex> q1 = Qex.new 1..3
iex> Qex.first!(q1)
1
```
#### Return the last item
```elixir
iex> q1 = Qex.new 1..3
iex> Qex.last(q1)
{:value, 3}
iex> q2 = Qex.new []
iex> Qex.last(q2)
:empty
iex> q1 = Qex.new 1..3
iex> Qex.last!(q1)
3
```
## Why not "Queue"?
The name is taken... [Hex link](https://hex.pm/packages/queue)
## Copyright and License
Copyright (c) 2022 Po Chen
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.