PHP 7.2.0 Release Candidate 4 Released

Ds\Deque::sorted

(PECL ds >= 1.0.0)

Ds\Deque::sortedReturns a sorted copy.

Description

public Ds\Deque Ds\Deque::sorted ([ callable $comparator ] )

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. Note that before PHP 7.0.0 this integer had to be in the range from -2147483648 to 2147483647.

int callback ( mixed $a, mixed $b )
Caution

Returning non-integer values from the comparison function, such as float, will result in an internal cast to integer 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 deque.

Examples

Example #1 Ds\Deque::sorted() example

<?php
$deque 
= new \Ds\Deque([45132]);

print_r($deque->sorted());
?>

The above example will output something similar to:

Ds\Deque Object
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
)

Example #2 Ds\Deque::sorted() example using a comparator

<?php
$deque 
= new \Ds\Deque([45132]);

$sorted $deque->sorted(function($a$b) {
    return 
$b <=> $a;
});

print_r($sorted);
?>

The above example will output something similar to:

Ds\Deque Object
(
    [0] => 5
    [1] => 4
    [2] => 3
    [3] => 2
    [4] => 1
)
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top