<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns a sorted copy</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-set.sort.html">Ds\Set::sort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-set.sum.html">Ds\Set::sum</a></div>
<div class="up"><a href="class.ds-set.html">Set</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ds-set.sorted" class="refentry">
<div class="refnamediv">
<h1 class="refname">Ds\Set::sorted</h1>
<p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Set::sorted</span> — <span class="dc-title">Returns a sorted copy</span></p>
</div>
<div class="refsect1 description" id="refsect1-ds-set.sorted-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type Ds\Set">Ds\Set</span></span> <span class="methodname"><strong>Ds\Set::sorted</strong></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$comparator</code></span>
] )</div>
<p class="para rdfs-comment">
Returns a sorted copy, using an optional <code class="parameter">comparator</code> function.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ds-set.sorted-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">comparator</code></dt>
<dd>
<p class="para">
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.
</p>
<div class="methodsynopsis dc-description"><span class="type">int</span> <span class="methodname"><span class="replaceable">callback</span></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$a</code></span>, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$b</code></span> )</div>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
Returning <em class="emphasis">non-integer</em> values from the comparison
function, such as <span class="type"><a href="language.types.float.html" class="type float">float</a></span>, will result in an internal cast to
<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> 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.
</p>
</div>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ds-set.sorted-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a sorted copy of the set.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ds-set.sorted-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5326">
<p><strong>Example #1 <span class="function"><strong>Ds\Set::sorted()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$set </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Set</span><span style="color: #007700">([</span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$set</span><span style="color: #007700">-></span><span style="color: #0000BB">sorted</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Ds\Set Object
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
[4] => 5
)
</pre></div>
</div>
</div>
<div class="example" id="example-5327">
<p><strong>Example #2 <span class="function"><strong>Ds\Set::sorted()</strong></span> example using a comparator</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$set </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Set</span><span style="color: #007700">([</span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">$sorted </span><span style="color: #007700">= </span><span style="color: #0000BB">$set</span><span style="color: #007700">-></span><span style="color: #0000BB">sorted</span><span style="color: #007700">(function(</span><span style="color: #0000BB">$a</span><span style="color: #007700">, </span><span style="color: #0000BB">$b</span><span style="color: #007700">) {<br /> return </span><span style="color: #0000BB">$b </span><span style="color: #007700"><=> </span><span style="color: #0000BB">$a</span><span style="color: #007700">;<br />});<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$sorted</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Ds\Set Object
(
[0] => 5
[1] => 4
[2] => 3
[3] => 2
[4] => 1
)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-set.sort.html">Ds\Set::sort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-set.sum.html">Ds\Set::sum</a></div>
<div class="up"><a href="class.ds-set.html">Set</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
