1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>inner_product</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="adjacent_difference.html" title="adjacent_difference"> 10<link rel="next" href="partial_sum.html" title="partial_sum"> 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="adjacent_difference.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="partial_sum.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.inner_product"></a><a class="link" href="inner_product.html" title="inner_product">inner_product</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.numeric.inner_product.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.prototype"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.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">SinglePassRange1</span><span class="special">,</span> 36 <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> 38 <span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> 39 <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> 40 <span class="identifier">Value</span> <span class="identifier">init</span> <span class="special">);</span> 41 42<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> 43 <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> 44 <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> 45 <span class="keyword">class</span> <span class="identifier">BinaryOperation1</span><span class="special">,</span> 46 <span class="keyword">class</span> <span class="identifier">BinaryOperation2</span><span class="special">></span> 47 <span class="identifier">Value</span> <span class="identifier">inner_product</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> 48 <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> 49 <span class="identifier">Value</span> <span class="identifier">init</span><span class="special">,</span> 50 <span class="identifier">BinaryOperation1</span> <span class="identifier">op1</span><span class="special">,</span> 51 <span class="identifier">BinaryOperation2</span> <span class="identifier">op2</span> <span class="special">);</span> 52</pre> 53<p> 54 </p> 55<h6> 56<a name="range.reference.algorithms.numeric.inner_product.h1"></a> 57 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.description"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.description">Description</a> 58 </h6> 59<p> 60 <code class="computeroutput"><span class="identifier">inner_product</span></code> calculates 61 a generalised inner product of the range <code class="computeroutput"><span class="identifier">rng1</span></code> 62 and <code class="computeroutput"><span class="identifier">rng2</span></code>. 63 </p> 64<p> 65 For further information on the <code class="computeroutput"><span class="identifier">inner_product</span></code> 66 algorithm please see <a href="http://www.sgi.com/tech/stl/inner_product.html" target="_top">inner_product</a>. 67 </p> 68<h6> 69<a name="range.reference.algorithms.numeric.inner_product.h2"></a> 70 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.definition"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.definition">Definition</a> 71 </h6> 72<p> 73 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> 74 </p> 75<h6> 76<a name="range.reference.algorithms.numeric.inner_product.h3"></a> 77 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.requirements"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.requirements">Requirements</a> 78 </h6> 79<h6> 80<a name="range.reference.algorithms.numeric.inner_product.h4"></a> 81 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.for_the_first_version"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_first_version">For 82 the first version</a> 83 </h6> 84<div class="orderedlist"><ol class="orderedlist" type="1"> 85<li class="listitem"> 86 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> 87 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 88 Pass Range</a> Concept. 89 </li> 90<li class="listitem"> 91 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> 92 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 93 Pass Range</a> Concept. 94 </li> 95<li class="listitem"> 96 <code class="computeroutput"><span class="identifier">Value</span></code> is a model 97 of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. 98 </li> 99<li class="listitem"> 100 If <code class="computeroutput"><span class="identifier">x</span></code> is an object 101 of type <code class="computeroutput"><span class="identifier">Value</span></code>, <code class="computeroutput"><span class="identifier">y</span></code> is an object of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s value type, 102 and <code class="computeroutput"><span class="identifier">z</span></code> is an object 103 of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s 104 value type, then <code class="computeroutput"><span class="identifier">x</span> <span class="special">+</span> <span class="identifier">y</span> <span class="special">*</span> <span class="identifier">z</span></code> 105 is defined. 106 </li> 107<li class="listitem"> 108 The result type of the expression <code class="computeroutput"><span class="identifier">x</span> 109 <span class="special">+</span> <span class="identifier">y</span> 110 <span class="special">*</span> <span class="identifier">z</span></code> 111 is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. 112 </li> 113</ol></div> 114<h6> 115<a name="range.reference.algorithms.numeric.inner_product.h5"></a> 116 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.for_the_second_version"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_second_version">For 117 the second version</a> 118 </h6> 119<div class="orderedlist"><ol class="orderedlist" type="1"> 120<li class="listitem"> 121 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> 122 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 123 Pass Range</a> Concept. 124 </li> 125<li class="listitem"> 126 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> 127 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 128 Pass Range</a> Concept. 129 </li> 130<li class="listitem"> 131 <code class="computeroutput"><span class="identifier">Value</span></code> is a model 132 of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. 133 </li> 134<li class="listitem"> 135 <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> 136 is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. 137 </li> 138<li class="listitem"> 139 <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> 140 is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. 141 </li> 142<li class="listitem"> 143 The value type of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> 144 is convertible to the first argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. 145 </li> 146<li class="listitem"> 147 The value type of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> 148 is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. 149 </li> 150<li class="listitem"> 151 <code class="computeroutput"><span class="identifier">Value</span></code> is convertible 152 to the value type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. 153 </li> 154<li class="listitem"> 155 The return type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> 156 is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. 157 </li> 158<li class="listitem"> 159 The return type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> 160 is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. 161 </li> 162</ol></div> 163<h6> 164<a name="range.reference.algorithms.numeric.inner_product.h6"></a> 165 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.precondition_"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.precondition_">Precondition:</a> 166 </h6> 167<p> 168 <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">>=</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span></code> is a valid range. 169 </p> 170<h6> 171<a name="range.reference.algorithms.numeric.inner_product.h7"></a> 172 <span class="phrase"><a name="range.reference.algorithms.numeric.inner_product.complexity"></a></span><a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.complexity">Complexity</a> 173 </h6> 174<p> 175 Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. 176 </p> 177</div> 178<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 179<td align="left"></td> 180<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 181 Neil Groves<p> 182 Distributed under the Boost Software License, Version 1.0. (See accompanying 183 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>) 184 </p> 185</div></td> 186</tr></table> 187<hr> 188<div class="spirit-nav"> 189<a accesskey="p" href="adjacent_difference.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="partial_sum.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 190</div> 191</body> 192</html> 193
