Ds\Map::reduce

Contents

(PECL ds >= 1.0.0)

Ds\Map::reduce — Reduces the map to a single value using a callback function

Description

public Ds\Map::reduce ( callable $callback [, mixed $initial ] ) : mixed

Reduces the map to a single value using a callback function.

PHP: Ds\Map::reduce - Manual Home of Manuel PHP Contents Haut

Parameters

callback

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

carry: The return value of the previous callback, or initial if it's the first iteration.
key: The key of the current iteration.
value: The value of the current iteration.

initial

The initial value of the carry value. Can be NULL.

PHP: Ds\Map::reduce - Manual Home of Manuel PHP Contents Haut

Return Values

The return value of the final callback.

PHP: Ds\Map::reduce - Manual Home of Manuel PHP Contents Haut

Examples

Example #1 Ds\Map::reduce() with initial value example


<?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));

// Iterations:
//
// $carry = $initial = 5
//
// $carry = $carry * 1 =  5
// $carry = $carry * 2 = 10
// $carry = $carry * 3 = 30
?>

The above example will output something similar to:

int(30)

Example #2 Ds\Map::reduce() without an initial value example


<?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
?>

The above example will output something similar to:

int(21)

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-ds-map.reduce.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut