| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>inner_product</title> |
| <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> |
| <link rel="up" href="../numeric.html" title="Numeric algorithms"> |
| <link rel="prev" href="adjacent_difference.html" title="adjacent_difference"> |
| <link rel="next" href="partial_sum.html" title="partial_sum"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <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> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h5 class="title"> |
| <a name="range.reference.algorithms.numeric.inner_product"></a><a class="link" href="inner_product.html" title="inner_product"> |
| inner_product</a> |
| </h5></div></div></div> |
| <a name="range.reference.algorithms.numeric.inner_product.prototype"></a><h6> |
| <a name="id862430"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.prototype">Prototype</a> |
| </h6> |
| <p> |
| |
| </p> |
| <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> |
| <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> |
| <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">></span> |
| <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> |
| <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> |
| <span class="identifier">Value</span> <span class="identifier">init</span> <span class="special">);</span> |
| |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> |
| <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> |
| <span class="keyword">class</span> <span class="identifier">Value</span><span class="special">,</span> |
| <span class="keyword">class</span> <span class="identifier">BinaryOperation1</span><span class="special">,</span> |
| <span class="keyword">class</span> <span class="identifier">BinaryOperation2</span><span class="special">></span> |
| <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> |
| <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> |
| <span class="identifier">Value</span> <span class="identifier">init</span><span class="special">,</span> |
| <span class="identifier">BinaryOperation1</span> <span class="identifier">op1</span> <span class="special">);</span> |
| </pre> |
| <p> |
| </p> |
| <a name="range.reference.algorithms.numeric.inner_product.description"></a><h6> |
| <a name="id862790"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.description">Description</a> |
| </h6> |
| <p> |
| <code class="computeroutput"><span class="identifier">inner_product</span></code> calculates |
| a generalised inner product of the range <code class="computeroutput"><span class="identifier">rng1</span></code> |
| and <code class="computeroutput"><span class="identifier">rng2</span></code>. |
| </p> |
| <p> |
| For further information on the <code class="computeroutput"><span class="identifier">inner_product</span></code> |
| algorithm please see <a href="http://www.sgi.com/tech/stl/inner_product.html" target="_top">inner_product</a>. |
| </p> |
| <a name="range.reference.algorithms.numeric.inner_product.definition"></a><h6> |
| <a name="id862869"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.definition">Definition</a> |
| </h6> |
| <p> |
| 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> |
| </p> |
| <a name="range.reference.algorithms.numeric.inner_product.requirements"></a><h6> |
| <a name="id862931"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.requirements">Requirements</a> |
| </h6> |
| <a name="range.reference.algorithms.numeric.inner_product.for_the_first_version"></a><h6> |
| <a name="id862955"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_first_version">For |
| the first version</a> |
| </h6> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> |
| is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single |
| Pass Range</a> Concept. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> |
| is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single |
| Pass Range</a> Concept. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">Value</span></code> is a model |
| of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. |
| </li> |
| <li class="listitem"> |
| If <code class="computeroutput"><span class="identifier">x</span></code> is an object |
| 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, |
| and <code class="computeroutput"><span class="identifier">z</span></code> is an object |
| of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s |
| 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> |
| is defined. |
| </li> |
| <li class="listitem"> |
| The result type of the expression <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> |
| is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. |
| </li> |
| </ol></div> |
| <a name="range.reference.algorithms.numeric.inner_product.for_the_second_version"></a><h6> |
| <a name="id863220"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.for_the_second_version">For |
| the second version</a> |
| </h6> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> |
| is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single |
| Pass Range</a> Concept. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> |
| is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single |
| Pass Range</a> Concept. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">Value</span></code> is a model |
| of the <code class="computeroutput"><span class="identifier">AssignableConcept</span></code>. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> |
| is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> |
| is a model of the <code class="computeroutput"><span class="identifier">BinaryFunctionConcept</span></code>. |
| </li> |
| <li class="listitem"> |
| The value type of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> |
| is convertible to the first argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. |
| </li> |
| <li class="listitem"> |
| The value type of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> |
| is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code>. |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">Value</span></code> is convertible |
| to the value type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. |
| </li> |
| <li class="listitem"> |
| The return type of <code class="computeroutput"><span class="identifier">BinaryOperation2</span></code> |
| is convertible to the second argument type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code>. |
| </li> |
| <li class="listitem"> |
| The return type of <code class="computeroutput"><span class="identifier">BinaryOperation1</span></code> |
| is convertible to <code class="computeroutput"><span class="identifier">Value</span></code>. |
| </li> |
| </ol></div> |
| <a name="range.reference.algorithms.numeric.inner_product.precondition_"></a><h6> |
| <a name="id863533"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.precondition_">Precondition:</a> |
| </h6> |
| <p> |
| <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. |
| </p> |
| <a name="range.reference.algorithms.numeric.inner_product.complexity"></a><h6> |
| <a name="id863606"></a> |
| <a class="link" href="inner_product.html#range.reference.algorithms.numeric.inner_product.complexity">Complexity</a> |
| </h6> |
| <p> |
| Linear. Exactly <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>. |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2003 -2010 Thorsten Ottosen, Neil Groves<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <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> |
| </div> |
| </body> |
| </html> |
