Enum

Enum

El módulo Enum incluye más de 70 funciones para trabajar con colecciones. Todas las colecciones que aprendiste en la lección anterior, a excepción de las tuplas, son enumerables.

Esta sección solamente incluirá un subconjunto de las funciones disponibles, sin embargo, puedes examinarlas tú mismo. Hagamos un pequeño experimento en IEx.

iex
iex> Enum.__info__(:functions) |> Enum.each(fn({function, arity}) ->
...>   IO.puts "#{function}/#{arity}"
...> end)
all?/1
all?/2
any?/1
any?/2
at/2
at/3
...

Viendo esto queda claro que existe una gran cantidad de funcionalidad para Enum y esto es debido a una razón clara. La enumeración está en el corazón de la programación funcional y es un recurso muy útil. Al aprovecharlo y combinarlo con otras ventajas de Elixir es increíblemente empoderador para los desarrolladores.

Para ver la lista completa de funciones, visita la documentación oficial Enum; para enumeración diferida (lazy) usa el módulo Stream.

all?

Cuando usas all?/2, y muchas de las funciones de Enum, proveemos una función para aplicar a los elementos de nuestra colección. En este caso de all?/2, la colección entera debe ser evaluada a true, no siendo así, false será devuelto:

iex> Enum.all?(["foo", "bar", "hello"], fn(s) -> String.length(s) == 3 end)
false
iex> Enum.all?(["foo", "bar", "hello"], fn(s) -> String.length(s) > 1 end)
true

any?

Al contrario que la función anterior, any? devolverá true si al menos un elemento es evaluado a true:

iex> Enum.any?(["foo", "bar", "hello"], fn(s) -> String.length(s) == 5 end)
true

chunk_every

Si necesitas dividir tu colección en pequeños grupos, chunk_every/2 es la función que probablemente estés buscando:

iex> Enum.chunk_every([1, 2, 3, 4, 5, 6], 2)
[[1, 2], [3, 4], [5, 6]]

Hay algunas opciones para chunk_every/2 pero no vamos a entrar en detalle, revisa chunk_every/4 en la documentación oficial para aprender más.

chunk_by

Si necesitamos agrupar una colección basándonos en algo diferente al tamaño, podemos usar la función chunk_by/2. Esta función recibe un enumerable como parámetro y una función. Cada vez que la respuesta de esa función cambia, un nuevo grupo es creado y continúa con la creación del siguiente. En los ejemplos más abajo, cada cadena de la misma longitud es agrupada hasta que encontramos una nueva cadena con una nueva longitud:

iex> Enum.chunk_by(["one", "two", "three", "four", "five"], fn(x) -> String.length(x) end)
[["one", "two"], ["three"], ["four", "five"]]
iex> Enum.chunk_by(["one", "two", "three", "four", "five", "six"], fn(x) -> String.length(x) end)
[["one", "two"], ["three"], ["four", "five"], ["six"]]

map_every

Algunas veces hacer chunk a una colección no es suficiente para lograr lo que necesitas. Si este es el caso, map_every/3 puede ser muy útil para ejecutarse cada n elementos, siempre se ejecuta en el primero.

# Apply function every three items
iex> Enum.map_every([1, 2, 3, 4, 5, 6, 7, 8], 3, fn x -> x + 1000 end)
[1001, 2, 3, 1004, 5, 6, 1007, 8]

each

Puede ser necesario iterar sobre una colección sin producir un nuevo valor, para este caso podemos usar each/2:

iex> Enum.each(["one", "two", "three"], fn(s) -> IO.puts(s) end)
one
two
three
:ok

Nota: La función each/2 devuelve el átomo :ok.

map

Para aplicar una función a cada elemento y producir una nueva colección, revisa la función map/2:

iex> Enum.map([0, 1, 2, 3], fn(x) -> x - 1 end)
[-1, 0, 1, 2]

min

min/1 encuentra el mínimo valor de la colección:

iex> Enum.min([5, 3, 0, -1])
-1

min/2 realiza lo mismo, pero en caso que el enumerable sea vacío, este permite que se especifique una función que produzca el valor del mínimo.

iex> Enum.min([], fn -> :foo end)
:foo

max

max/1 devuelve el máximo valor de la colección:

iex> Enum.max([5, 3, 0, -1])
5

max/2 es a max/1 lo que min/2 es a min/1:

Enum.max([], fn -> :bar end)
:bar

filter

La función filter/2 nos permite filtrar una colección que incluya solamente aquellos elementos que evalúan a true utilizando la función provista.

iex> Enum.filter([1, 2, 3, 4], fn(x) -> rem(x, 2) == 0 end)
[2, 4]

reduce

Con reduce/3 podemos transformar nuestra colección a un único valor. Para hacer esto aplicamos un acumulador opcional (10 en este ejemplo) que será pasado a nuestra función; si no se provee un acumulador, se usa el primer elemento de la colección como acumulador:

iex> Enum.reduce([1, 2, 3], 10, fn(x, acc) -> x + acc end)
16

iex> Enum.reduce([1, 2, 3], fn(x, acc) -> x + acc end)
6

iex> Enum.reduce(["a","b","c"], "1", fn(x,acc) -> x <> acc end)
"cba1"

sort

Ordenar nuestras colecciones se hace fácil no con una, sino con dos funciones de ordenación.

sort/1 utiliza el ordenamiento de términos de Erlang para determinar el orden de ordenación:

iex> Enum.sort([5, 6, 1, 3, -1, 4])
[-1, 1, 3, 4, 5, 6]

iex> Enum.sort([:foo, "bar", Enum, -1, 4])
[-1, 4, Enum, :foo, "bar"]

Mientras que sort/2 nos permite usar una función de ordenación propia como segundo argumento:

# con nuestra función
iex> Enum.sort([%{:count => 4}, %{:count => 1}], fn(x, y) -> x[:count] > y[:count] end)
[%{count: 4}, %{count: 1}]

# sin nuestra función
iex> Enum.sort([%{:count => 4}, %{:count => 1}])
[%{count: 1}, %{count: 4}]

Por comodidad, sort/2 nos permite usar los átomos :asc o :desc como función de ordenación:

Enum.sort([2, 3, 1], :desc)
[3, 2, 1]

uniq

Podemos usar uniq/1 para eliminar los duplicados de nuestras colecciones:

iex> Enum.uniq([1, 2, 3, 2, 1, 1, 1, 1, 1])
[1, 2, 3]

uniq_by

uniq_by/2 también elimina duplicados de colecciones pero nos permite usar una función para la comprobación de la unicidad.

iex> Enum.uniq_by([%{x: 1, y: 1}, %{x: 2, y: 1}, %{x: 3, y: 3}], fn coord -> coord.y end)
[%{x: 1, y: 1}, %{x: 3, y: 3}]

Enum usando el operador de Captura (&)

Muchas funciones del módulo de Enum en Elixir reciben funciones anónimas como argumento para ejecutarla en cada elemento de la colección a la que se le pasa.

Estas funciones anónimas suelen escribirse habitualmente con el operador de Captura (&).

Aquí varios ejemplos que muestran cómo usar el operador de captura con el módulo Enum. Cada versión es funcionalmente equivalente.

Usando el operador de captura con una función anónima

Abajo el típico ejemplo de sintaxis estándar pasando una función anónima a Enum.map/2.

iex> Enum.map([1,2,3], fn number -> number + 3 end)
[4, 5, 6]

Ahora implementamos la misma funcionalidad pero con el operador de captura (&); capturando cada elemento de la lista de números ([1,2,3]) y asignándolo a la variable &1 cuando es pasada a la función de mapeado.

iex> Enum.map([1,2,3], &(&1 + 3))
[4, 5, 6]

Se puede refactorizar un poco más asignando la función anómina anterior a una variable y usando dicha variable desde la función Enum.map/2.

iex> plus_three = &(&1 + 3)
iex> Enum.map([1,2,3], plus_three)
[4, 5, 6]

Usando el operador de captura con una función con nombre (no anónima)

Primero creamos una función con nombre y la llamamos dentro de la función anónima definida en Enum.map/2.

defmodule Adding do
  def plus_three(number), do: number + 3
end

iex>  Enum.map([1,2,3], fn number -> Adding.plus_three(number) end)
[4, 5, 6]

A continuación, refactorizamos usando el operador de Captura.

iex> Enum.map([1,2,3], &Adding.plus_three(&1))
[4, 5, 6]

Usando una sintaxis más concisa aún, podemos usar directamente la función con nombre sin capturar explícitamente la variable.

iex> Enum.map([1,2,3], &Adding.plus_three/1)
[4, 5, 6]

¿Encontraste un error o quieres contribuir a la lección? ¡Edita esta lección en GitHub!