https://github.com/seantanly/elixir-minmaxlist

Extension of Enum functions like min_by, max_by, min_max_by, returning a list of results instead of just one.
https://github.com/seantanly/elixir-minmaxlist

elixir-library

Last synced: 3 months ago
JSON representation

Extension of Enum functions like min_by, max_by, min_max_by, returning a list of results instead of just one.

• Host: GitHub
• URL: https://github.com/seantanly/elixir-minmaxlist
• Owner: seantanly
• License: mit
• Created: 2015-11-01T07:46:19.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-25T07:31:53.000Z (almost 7 years ago)
• Last Synced: 2024-10-04T07:07:42.579Z (4 months ago)
• Topics: elixir-library
• Language: Elixir
• Size: 114 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Elixir library extending `Enum.min_by/2`, `Enum.max_by/2` and `Enum.min_max_by/2` to return a list of results instead of just one. (Algorithms and Data structures)
• fucking-awesome-elixir - minmaxlist - Elixir library extending `Enum.min_by/2`, `Enum.max_by/2` and `Enum.min_max_by/2` to return a list of results instead of just one. (Algorithms and Data structures)
• awesome-elixir - minmaxlist - Elixir library extending `Enum.min_by/2`, `Enum.max_by/2` and `Enum.min_max_by/2` to return a list of results instead of just one. (Algorithms and Data structures)

README

        
Minmaxlist

========

[![Build Status](https://travis-ci.org/seantanly/elixir-minmaxlist.svg?branch=master)](https://travis-ci.org/seantanly/elixir-minmaxlist)

[![Hex.pm Version](http://img.shields.io/hexpm/v/minmaxlist.svg?style=flat)](https://hex.pm/packages/minmaxlist)

Elixir library extending `Enum.min_by/2`, `Enum.max_by/2` and `Enum.min_max_by/2` to return a list of results instead of just one.

This enables searching for all matching results based multiple min/max value criteria. See [Examples](#examples).

## Documentation

API documentation is available at [http://hexdocs.pm/minmaxlist](http://hexdocs.pm/minmaxlist)

## Adding Minmaxlist To Your Project

To use Minmaxlist with your projects, edit your `mix.exs` file and add it as a dependency:

```elixir

defp deps do

  [

    {:minmaxlist, "~> x.x.x"},

  ]

end

```

## Examples

Minmaxlist is designed to assist in filtering result sets by min/max value while returning list of results that matches the requirement. This is especially useful for example,

Find the youngest people with highest income.

```elixir

import Minmaxlist

[

  %{name: "A", age: 24, income: 4000},

  %{name: "B", age: 22, income: 3300},

  %{name: "C", age: 22, income: 2800},

  %{name: "D", age: 25, income: 5000},

  %{name: "E", age: 22, income: 3300},

  %{name: "F", age: 25, income: 5500},

  %{name: "G", age: 24, income: 4500},

] |> min_list_by(&(&1.age)) |> max_list_by(&(&1.income))

# => [%{name: "B", age: 22, income: 3300}, %{name: "E", age: 22, income: 3300}]

```

Find the youngest and oldest people,

```elixir

import Minmaxlist

[

  %{name: "A", age: 24, income: 4000},

  %{name: "B", age: 22, income: 3300},

  %{name: "C", age: 22, income: 2800},

  %{name: "D", age: 25, income: 5000},

  %{name: "E", age: 22, income: 3300},

  %{name: "F", age: 25, income: 5500},

  %{name: "G", age: 24, income: 4500},

] |> min_max_list_by(&(&1.age))

# => {

#   [%{name: "B", age: 22, income: 3300}, %{name: "C", age: 22, income: 2800}, %{name: "E", age: 22, income: 3300}],

#   [%{name: "D", age: 25, income: 5000}, %{name: "F", age: 25, income: 5500}]

# }

```

## LICENSE

This software is licensed under [MIT License](LICENSE.md).