libs/range/doc/html/range/reference/algorithms/mutating/rotate.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>rotate</title>
   5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Range 2.0">
   8 <link rel="up" href="../mutating.html" title="Mutating algorithms">
   9 <link rel="prev" href="reverse_copy.html" title="reverse_copy">
  10 <link rel="next" href="rotate_copy.html" title="rotate_copy">
  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="reverse_copy.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="rotate_copy.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.rotate"></a><a class="link" href="rotate.html" title="rotate">rotate</a>
  28 </h5></div></div></div>
  29 <h6>
  30 <a name="range.reference.algorithms.mutating.rotate.h0"></a>
  31             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.prototype"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.prototype">Prototype</a>
  32           </h6>
  33 <p>
  34 </p>
  35 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">&gt;</span>
  36 <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rotate</span><span class="special">(</span><span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
  37                      <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span>
  38
  39 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ForwardRange</span><span class="special">&gt;</span>
  40 <span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rotate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
  41                            <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">ForwardRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">);</span>
  42 </pre>
  43 <p>
  44           </p>
  45 <h6>
  46 <a name="range.reference.algorithms.mutating.rotate.h1"></a>
  47             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.description"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.description">Description</a>
  48           </h6>
  49 <p>
  50             <code class="computeroutput"><span class="identifier">rotate</span></code> rotates the elements
  51             in a range. It exchanges the two ranges <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code>
  52             and <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. Returns a reference to <code class="computeroutput"><span class="identifier">rng</span></code>.
  53           </p>
  54 <h6>
  55 <a name="range.reference.algorithms.mutating.rotate.h2"></a>
  56             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.definition"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.definition">Definition</a>
  57           </h6>
  58 <p>
  59             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">rotate</span><span class="special">.</span><span class="identifier">hpp</span></code>
  60           </p>
  61 <h6>
  62 <a name="range.reference.algorithms.mutating.rotate.h3"></a>
  63             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.requirements"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.requirements">Requirements</a>
  64           </h6>
  65 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  66 <li class="listitem">
  67                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is a
  68                 model of the <a class="link" href="../../../concepts/forward_range.html" title="Forward Range">Forward
  69                 Range</a> Concept.
  70               </li>
  71 <li class="listitem">
  72                 <code class="computeroutput"><span class="identifier">ForwardRange</span></code> is mutable.
  73               </li>
  74 </ul></div>
  75 <h6>
  76 <a name="range.reference.algorithms.mutating.rotate.h4"></a>
  77             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.precondition_"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.precondition_">Precondition:</a>
  78           </h6>
  79 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  80 <li class="listitem">
  81                 <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is a valid range.
  82               </li>
  83 <li class="listitem">
  84                 <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range.
  85               </li>
  86 </ul></div>
  87 <h6>
  88 <a name="range.reference.algorithms.mutating.rotate.h5"></a>
  89             <span class="phrase"><a name="range.reference.algorithms.mutating.rotate.complexity"></a></span><a class="link" href="rotate.html#range.reference.algorithms.mutating.rotate.complexity">Complexity</a>
  90           </h6>
  91 <p>
  92             Linear. At most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> swaps are performed.
  93           </p>
  94 </div>
  95 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  96 <td align="left"></td>
  97 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
  98       Neil Groves<p>
  99         Distributed under the Boost Software License, Version 1.0. (See accompanying
 100         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>)
 101       </p>
 102 </div></td>
 103 </tr></table>
 104 <hr>
 105 <div class="spirit-nav">
 106 <a accesskey="p" href="reverse_copy.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="rotate_copy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 107 </div>
 108 </body>
 109 </html>