Reduz o mapa a um único valor usando uma função callback

Descrição

public Ds\Map::reduce(callable $callback, mixed $initial = ?): mixed

Reduz o mapa a um único valor usando uma função callback.

Parâmetros

callback

callback(mixed $carry, mixed $key, mixed $value): mixed

carry: O valor de retorno do callback anterior, ou initial se for a primeira iteração.
key: A chave da iteração atual.
value: O valor da iteração atual.

initial

O valor inicial do valor de transporte. Pode ser null.

Valor Retornado

O valor de retorno do callback final.

Exemplos

Example #1 Exemplo de Ds\Map::reduce() com valor inicial

<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);

$callback = function($carry, $key, $value) {
    return $carry * $value;
};

var_dump($map->reduce($callback, 5));

// Iterações:
//
// $carry = $initial = 5
//
// $carry = $carry * 1 =  5
// $carry = $carry * 2 = 10
// $carry = $carry * 3 = 30
?>

O exemplo acima produzirá algo semelhante a:

int(30)

Example #2 Exemplo de Ds\Map::reduce() sem um valor inicial

<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);

var_dump($map->reduce(function($carry, $key, $value) {
    return $carry + $value + 5;
}));

// Iterations:
//
// $carry = $initial = null
//
// $carry = $carry + 1 + 5 =  6
// $carry = $carry + 2 + 5 = 13
// $carry = $carry + 3 + 5 = 21
?>

O exemplo acima produzirá algo semelhante a:

int(21)