Ds\Sequence::sorted
(PECL ds >= 1.0.0)
Ds\Sequence::sorted — Returns a sorted copy
Description
Returns a sorted copy, using an optional comparator
function.
Parameters
-
comparator
-
The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
CautionReturning non-integer values from the comparison function, such as float, will result in an internal cast to int of the callback's return value. So values such as 0.99 and 0.1 will both be cast to an integer value of 0, which will compare such values as equal.
Return Values
Returns a sorted copy of the sequence.
Examples
Example #1 Ds\Sequence::sorted() example
<?php
$sequence = new \Ds\Vector([4, 5, 1, 3, 2]);
print_r($sequence->sorted());
?>
The above example will output something similar to:
Ds\Vector Object ( [0] => 1 [1] => 2 [2] => 3 [3] => 4 [4] => 5 )
Example #2 Ds\Sequence::sorted() example using a comparator
<?php
$sequence = new \Ds\Vector([4, 5, 1, 3, 2]);
$sorted = $sequence->sorted(function($a, $b) {
return $b <=> $a;
});
print_r($sorted);
?>
The above example will output something similar to:
Ds\Vector Object ( [0] => 5 [1] => 4 [2] => 3 [3] => 2 [4] => 1 )