Skip to content

Add docs for collection avg & median. #5126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 28, 2017
Merged

Add docs for collection avg & median. #5126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a8d802
Add docs for collection avg & median.
markstory Jul 28, 2017
3bceb9f
Missing commas, some mandatory
ravage84 Jul 28, 2017
068629e
A set, not the set
ravage84 Jul 28, 2017
9058a4f
Add white line
ravage84 Jul 28, 2017
b5fbcba
Rename variables after their function
ravage84 Jul 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions en/appendices/3-5-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,12 @@ cache configuration to fall back to if the engine is misconfigured (or
unavailable). See :ref:`cache-configuration-fallback` for more information on
configuring fallbacks.

Collection
----------

* ``Cake\Collection\Collection::avg()`` was added.
* ``Cake\Collection\Collection::median()`` was added.

Core
----

Expand Down
76 changes: 55 additions & 21 deletions en/core-libraries/collections.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,27 +53,27 @@ List of Methods
.. table::
:class: docutils internal-toc

+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`append` | :php:meth:`buffered` | :php:meth:`combine` | :php:meth:`compile` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`contains` | :php:meth:`countBy` | :php:meth:`chunk` | :php:meth:`each` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`every` | :php:meth:`extract` | :php:meth:`filter` | :php:meth:`first` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`groupBy` | :php:meth:`indexBy` | :php:meth:`insert` | :php:meth:`isEmpty` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`last` | :php:meth:`listNested` | :php:meth:`map` | :php:meth:`match` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`max` | :php:meth:`min` | :php:meth:`nest` | :php:meth:`reduce` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`reject` | :php:meth:`sample` | :php:meth:`shuffle` | :php:meth:`skip` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`some` | :php:meth:`sortBy` | :php:meth:`stopWhen` | :php:meth:`sumOf` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`take` | :php:meth:`through` | :php:meth:`unfold` | :php:meth:`zip` |
+-----------------------+---------------------------+----------------------+---------------------+
| :php:meth:`transpose` | :php:meth:`chunkWithKeys` | | |
+-----------------------+---------------------------+----------------------+---------------------+
+---------------------------------------------------+----------------------+------------------------+
| :php:meth:`append` | :php:meth:`avg` | :php:meth:`buffered` | :php:meth:`combine` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`compile` | :php:meth:`contains` | :php:meth:`countBy` | :php:meth:`chunk` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`chunkWithKeys` | :php:meth:`each` | :php:meth:`every` | :php:meth:`extract` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`filter` | :php:meth:`first` | :php:meth:`groupBy` | :php:meth:`indexBy` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`insert` | :php:meth:`isEmpty` | :php:meth:`last` | :php:meth:`listNested` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`map` | :php:meth:`match` | :php:meth:`max` | :php:meth:`median` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`min` | :php:meth:`nest` | :php:meth:`reduce` | :php:meth:`reject` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`sample` | :php:meth:`shuffle` | :php:meth:`skip` | :php:meth:`some` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`sortBy` | :php:meth:`stopWhen` | :php:meth:`sumOf` | :php:meth:`take` |
+---------------------------+-----------------------+----------------------+------------------------+
| :php:meth:`through` | :php:meth:`transpose` | :php:meth:`unfold` | :php:meth:`zip` |
+---------------------------+-----------------------+----------------------+------------------------+

Iterating
=========
Expand Down Expand Up @@ -470,6 +470,40 @@ elements::

$sumOfDadAges = $collection->sumOf('dad.age');

.. php:method:: avg($matcher = null)

Calculate the average value of the elements in the collection. Optionally
provide a matcher path, or function to extract values to generate the average
for::

$items = [
['invoice' => ['total' => 100]],
['invoice' => ['total' => 200]],
];

// Average: 150
$average = (new Collection($items))->avg('invoice.total');

.. versionadded:: 3.5.0

.. php:method:: median($matcher = null)

Calculate the median value of a set of elements. Optionally provide a matcher
path, or function to extract values to generate the median for::

$items = [
['invoice' => ['total' => 400]],
['invoice' => ['total' => 500]],
['invoice' => ['total' => 100]],
['invoice' => ['total' => 333]],
['invoice' => ['total' => 200]],
];

// Median: 333
$median = (new Collection($items))->median('invoice.total');

.. versionadded:: 3.5.0

Grouping and Counting
---------------------

Expand Down