libs/range/doc/html/range/reference/adaptors/reference/strided.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>strided</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="../reference.html" title="Reference">
   9 <link rel="prev" href="sliced.html" title="sliced">
  10 <link rel="next" href="type_erased.html" title="type_erased">
  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="sliced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="type_erased.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.adaptors.reference.strided"></a><a class="link" href="strided.html" title="strided">strided</a>
  28 </h5></div></div></div>
  29 <div class="toc"><dl class="toc"><dt><span class="section"><a href="strided.html#range.reference.adaptors.reference.strided.strided_example">strided
  30             example</a></span></dt></dl></div>
  31 <div class="informaltable"><table class="table">
  32 <colgroup>
  33 <col>
  34 <col>
  35 </colgroup>
  36 <thead><tr>
  37 <th>
  38                     <p>
  39                       Syntax
  40                     </p>
  41                   </th>
  42 <th>
  43                     <p>
  44                       Code
  45                     </p>
  46                   </th>
  47 </tr></thead>
  48 <tbody>
  49 <tr>
  50 <td>
  51                     <p>
  52                       Pipe
  53                     </p>
  54                   </td>
  55 <td>
  56                     <p>
  57                       <code class="computeroutput"><span class="identifier">rng</span> <span class="special">|</span>
  58                       <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">strided</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>
  59                     </p>
  60                   </td>
  61 </tr>
  62 <tr>
  63 <td>
  64                     <p>
  65                       Function
  66                     </p>
  67                   </td>
  68 <td>
  69                     <p>
  70                       <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">::</span><span class="identifier">stride</span><span class="special">(</span><span class="identifier">rng</span><span class="special">,</span>
  71                       <span class="identifier">n</span><span class="special">)</span></code>
  72                     </p>
  73                   </td>
  74 </tr>
  75 </tbody>
  76 </table></div>
  77 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  78 <li class="listitem">
  79                 <span class="bold"><strong>Precondition:</strong></span> <code class="computeroutput"><span class="number">0</span>
  80                 <span class="special">&lt;=</span> <span class="identifier">n</span></code>.
  81               </li>
  82 <li class="listitem">
  83                 <span class="bold"><strong>Returns:</strong></span> A new range based on <code class="computeroutput"><span class="identifier">rng</span></code> where traversal is performed
  84                 in steps of <code class="computeroutput"><span class="identifier">n</span></code>.
  85               </li>
  86 <li class="listitem">
  87                 <span class="bold"><strong>Range Category:</strong></span> <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single
  88                 Pass Range</a>
  89               </li>
  90 <li class="listitem">
  91                 <span class="bold"><strong>Returned Range Category:</strong></span> The range
  92                 category of <code class="computeroutput"><span class="identifier">rng</span></code>.
  93               </li>
  94 </ul></div>
  95 <div class="section">
  96 <div class="titlepage"><div><div><h6 class="title">
  97 <a name="range.reference.adaptors.reference.strided.strided_example"></a><a class="link" href="strided.html#range.reference.adaptors.reference.strided.strided_example" title="strided example">strided
  98             example</a>
  99 </h6></div></div></div>
 100 <p>
 101 </p>
 102 <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">adaptor</span><span class="special">/</span><span class="identifier">strided</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 103 <span class="preprocessor">#include</span> <span class="special">&lt;</span><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">copy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 104 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
 105 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iterator</span><span class="special">&gt;</span>
 106 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
 107 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">vector</span><span class="special">&gt;</span>
 108
 109 <span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span>
 110 <span class="special">{</span>
 111     <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">adaptors</span><span class="special">;</span>
 112     <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">;</span>
 113
 114     <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">input</span><span class="special">;</span>
 115     <span class="identifier">input</span> <span class="special">+=</span> <span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">6</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">8</span><span class="special">,</span><span class="number">9</span><span class="special">,</span><span class="number">10</span><span class="special">;</span>
 116
 117     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span>
 118         <span class="identifier">input</span> <span class="special">|</span> <span class="identifier">strided</span><span class="special">(</span><span class="number">2</span><span class="special">),</span>
 119         <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream_iterator</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span><span class="special">,</span> <span class="string">","</span><span class="special">));</span>
 120
 121     <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
 122 <span class="special">}</span>
 123 </pre>
 124 <p>
 125             </p>
 126 </div>
 127 <p>
 128             This would produce the output:
 129 </p>
 130 <pre class="programlisting"><span class="number">1</span><span class="special">,</span><span class="number">3</span><span class="special">,</span><span class="number">5</span><span class="special">,</span><span class="number">7</span><span class="special">,</span><span class="number">9</span><span class="special">,</span>
 131 </pre>
 132 <p>
 133           </p>
 134 </div>
 135 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 136 <td align="left"></td>
 137 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2010 Thorsten Ottosen,
 138       Neil Groves<p>
 139         Distributed under the Boost Software License, Version 1.0. (See accompanying
 140         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>)
 141       </p>
 142 </div></td>
 143 </tr></table>
 144 <hr>
 145 <div class="spirit-nav">
 146 <a accesskey="p" href="sliced.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="type_erased.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 147 </div>
 148 </body>
 149 </html>