1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>random_shuffle</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> 8<link rel="up" href="../mutating.html" title="Mutating algorithms"> 9<link rel="prev" href="partition.html" title="partition"> 10<link rel="next" href="remove.html" title="remove"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="range.reference.algorithms.mutating.random_shuffle"></a><a class="link" href="random_shuffle.html" title="random_shuffle">random_shuffle</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.mutating.random_shuffle.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.prototype"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> 36<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> 37 38<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">></span> 39<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">);</span> 40 41<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> 42<span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span><span class="special">&</span> <span class="identifier">gen</span><span class="special">);</span> 43 44<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Generator</span><span class="special">></span> 45<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">random_shuffle</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Generator</span><span class="special">&</span> <span class="identifier">gen</span><span class="special">);</span> 46</pre> 47<p> 48 </p> 49<h6> 50<a name="range.reference.algorithms.mutating.random_shuffle.h1"></a> 51 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.description"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.description">Description</a> 52 </h6> 53<p> 54 <code class="computeroutput"><span class="identifier">random_shuffle</span></code> randomly 55 rearranges the elements in <code class="computeroutput"><span class="identifier">rng</span></code>. 56 The versions of <code class="computeroutput"><span class="identifier">random_shuffle</span></code> 57 that do not specify a <code class="computeroutput"><span class="identifier">Generator</span></code> 58 use an internal random number generator. The versions of <code class="computeroutput"><span class="identifier">random_shuffle</span></code> that do specify a <code class="computeroutput"><span class="identifier">Generator</span></code> use this instead. Returns 59 the shuffles range. 60 </p> 61<h6> 62<a name="range.reference.algorithms.mutating.random_shuffle.h2"></a> 63 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.definition"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.definition">Definition</a> 64 </h6> 65<p> 66 Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">random_shuffle</span><span class="special">.</span><span class="identifier">hpp</span></code> 67 </p> 68<h6> 69<a name="range.reference.algorithms.mutating.random_shuffle.h3"></a> 70 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.requirements"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.requirements">Requirements</a> 71 </h6> 72<p> 73 <span class="bold"><strong>For the version without a Generator:</strong></span> 74 </p> 75<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 76 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> 77 is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random 78 Access Range</a> Concept. 79 </li></ul></div> 80<p> 81 <span class="bold"><strong>For the version with a Generator:</strong></span> 82 </p> 83<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 84<li class="listitem"> 85 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code> 86 is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random 87 Access Range</a> Concept. 88 </li> 89<li class="listitem"> 90 <code class="computeroutput"><span class="identifier">Generator</span></code> is a model 91 of the <code class="computeroutput"><span class="identifier">RandomNumberGeneratorConcept</span></code>. 92 </li> 93<li class="listitem"> 94 <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s 95 distance type is convertible to <code class="computeroutput"><span class="identifier">Generator</span></code>'s 96 argument type. 97 </li> 98</ul></div> 99<h6> 100<a name="range.reference.algorithms.mutating.random_shuffle.h4"></a> 101 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.precondition_"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.precondition_">Precondition:</a> 102 </h6> 103<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 104 <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> 105 is less than <code class="computeroutput"><span class="identifier">gen</span></code>'s 106 maximum value. 107 </li></ul></div> 108<h6> 109<a name="range.reference.algorithms.mutating.random_shuffle.h5"></a> 110 <span class="phrase"><a name="range.reference.algorithms.mutating.random_shuffle.complexity"></a></span><a class="link" href="random_shuffle.html#range.reference.algorithms.mutating.random_shuffle.complexity">Complexity</a> 111 </h6> 112<p> 113 Linear. If <code class="computeroutput"><span class="special">!</span><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>, exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> 114 swaps are performed. 115 </p> 116</div> 117<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 118<td align="left"></td> 119<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 120 Neil Groves<p> 121 Distributed under the Boost Software License, Version 1.0. (See accompanying 122 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 123 </p> 124</div></td> 125</tr></table> 126<hr> 127<div class="spirit-nav"> 128<a accesskey="p" href="partition.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="remove.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 129</div> 130</body> 131</html> 132
