1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>adjacent_difference</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="../numeric.html" title="Numeric algorithms"> 9<link rel="prev" href="accumulate.html" title="accumulate"> 10<link rel="next" href="inner_product.html" title="inner_product"> 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="accumulate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.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="inner_product.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.numeric.adjacent_difference"></a><a class="link" href="adjacent_difference.html" title="adjacent_difference">adjacent_difference</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.numeric.adjacent_difference.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.prototype"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">OutputIterator</span> 38 <span class="special">></span> 39<span class="identifier">OutputIterator</span> <span class="identifier">adjacent_difference</span><span class="special">(</span> 40 <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> 41 <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">);</span> 42 43<span class="keyword">template</span><span class="special"><</span> 44 <span class="keyword">class</span> <span class="identifier">SinglePassRange</span><span class="special">,</span> 45 <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> 46 <span class="keyword">class</span> <span class="identifier">BinaryOperation</span> 47 <span class="special">></span> 48<span class="identifier">OutputIterator</span> <span class="identifier">adjacent_difference</span><span class="special">(</span> 49 <span class="keyword">const</span> <span class="identifier">SinglePassRange</span><span class="special">&</span> <span class="identifier">source_rng</span><span class="special">,</span> 50 <span class="identifier">OutputIterator</span> <span class="identifier">out_it</span><span class="special">,</span> 51 <span class="identifier">BinaryOperation</span> <span class="identifier">op</span><span class="special">);</span> 52</pre> 53<p> 54 </p> 55<h6> 56<a name="range.reference.algorithms.numeric.adjacent_difference.h1"></a> 57 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.description"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.description">Description</a> 58 </h6> 59<p> 60 <code class="computeroutput"><span class="identifier">adjacent_difference</span></code> calculates 61 the differences of adjacent_elements in <code class="computeroutput"><span class="identifier">rng</span></code>. 62 </p> 63<p> 64 The first version of <code class="computeroutput"><span class="identifier">adjacent_difference</span></code> 65 uses <code class="computeroutput"><span class="keyword">operator</span><span class="special">-()</span></code> 66 to calculate the differences. The second version uses <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> 67 instead of <code class="computeroutput"><span class="keyword">operator</span><span class="special">-()</span></code>. 68 </p> 69<h6> 70<a name="range.reference.algorithms.numeric.adjacent_difference.h2"></a> 71 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.definition"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.definition">Definition</a> 72 </h6> 73<p> 74 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">numeric</span><span class="special">.</span><span class="identifier">hpp</span></code> 75 </p> 76<h6> 77<a name="range.reference.algorithms.numeric.adjacent_difference.h3"></a> 78 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.requirements"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.requirements">Requirements</a> 79 </h6> 80<h6> 81<a name="range.reference.algorithms.numeric.adjacent_difference.h4"></a> 82 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.for_the_first_version"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_first_version">For 83 the first version</a> 84 </h6> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"> 87 <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is 88 a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 89 Pass Range</a> Concept. 90 </li> 91<li class="listitem"> 92 <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is 93 a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. 94 </li> 95<li class="listitem"> 96 If <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code> are objects of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>'s value type, then 97 <code class="computeroutput"><span class="identifier">x</span> <span class="special">-</span> 98 <span class="identifier">y</span></code> is defined. 99 </li> 100<li class="listitem"> 101 The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> 102 is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 103 set of value types. 104 </li> 105<li class="listitem"> 106 The return type of <code class="computeroutput"><span class="identifier">x</span> <span class="special">-</span> <span class="identifier">y</span></code> 107 is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 108 set of value types. 109 </li> 110</ol></div> 111<h6> 112<a name="range.reference.algorithms.numeric.adjacent_difference.h5"></a> 113 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.for_the_second_version"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.for_the_second_version">For 114 the second version</a> 115 </h6> 116<div class="orderedlist"><ol class="orderedlist" type="1"> 117<li class="listitem"> 118 <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> is 119 a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 120 Pass Range</a> Concept. 121 </li> 122<li class="listitem"> 123 <code class="computeroutput"><span class="identifier">OutputIterator</span></code> is 124 a model of the <code class="computeroutput"><span class="identifier">OutputIteratorConcept</span></code>. 125 </li> 126<li class="listitem"> 127 <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> is 128 a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. 129 </li> 130<li class="listitem"> 131 The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> 132 is convertible to <code class="computeroutput"><span class="identifier">BinaryOperation</span></code>'s 133 first and second argument types. 134 </li> 135<li class="listitem"> 136 The value type of <code class="computeroutput"><span class="identifier">SinglePassRange</span></code> 137 is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 138 set of value types. 139 </li> 140<li class="listitem"> 141 The result type of <code class="computeroutput"><span class="identifier">BinaryOperation</span></code> 142 is convertible to a type in <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 143 set of value types. 144 </li> 145</ol></div> 146<h6> 147<a name="range.reference.algorithms.numeric.adjacent_difference.h6"></a> 148 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.precondition_"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.precondition_">Precondition:</a> 149 </h6> 150<p> 151 <code class="computeroutput"><span class="special">[</span><span class="identifier">result</span><span class="special">,</span> <span class="identifier">result</span> 152 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is a valid range. 153 </p> 154<h6> 155<a name="range.reference.algorithms.numeric.adjacent_difference.h7"></a> 156 <span class="phrase"><a name="range.reference.algorithms.numeric.adjacent_difference.complexity"></a></span><a class="link" href="adjacent_difference.html#range.reference.algorithms.numeric.adjacent_difference.complexity">Complexity</a> 157 </h6> 158<p> 159 Linear. If <code class="computeroutput"><span class="identifier">empty</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code> 160 then zero applications, otherwise <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> 161 applications are performed. 162 </p> 163</div> 164<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 165<td align="left"></td> 166<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 167 Neil Groves<p> 168 Distributed under the Boost Software License, Version 1.0. (See accompanying 169 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>) 170 </p> 171</div></td> 172</tr></table> 173<hr> 174<div class="spirit-nav"> 175<a accesskey="p" href="accumulate.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../numeric.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="inner_product.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 176</div> 177</body> 178</html> 179
