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