summaryrefslogtreecommitdiff
path: root/doc/html/boost/accumulators/impl/sum_kahan_impl.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/accumulators/impl/sum_kahan_impl.html')
-rw-r--r--doc/html/boost/accumulators/impl/sum_kahan_impl.html51
1 files changed, 26 insertions, 25 deletions
diff --git a/doc/html/boost/accumulators/impl/sum_kahan_impl.html b/doc/html/boost/accumulators/impl/sum_kahan_impl.html
index 1e137e292d..67a03b4bc4 100644
--- a/doc/html/boost/accumulators/impl/sum_kahan_impl.html
+++ b/doc/html/boost/accumulators/impl/sum_kahan_impl.html
@@ -6,9 +6,10 @@
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
-<link rel="up" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_fwd_hpp" title="Header &lt;boost/accumulators/statistics_fwd.hpp&gt;">
-<link rel="prev" href="sum_impl.html" title="Struct template sum_impl">
-<link rel="next" href="tail_impl.html" title="Struct template tail_impl">
+<link rel="up" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.sum_kahan_hpp" title="Header &lt;boost/accumulators/statistics/sum_kahan.hpp&gt;">
+<link rel="prev" href="../extract/sum_of_variates_kahan.html" title="Global sum_of_variates_kahan">
+<link rel="next" href="../tag/sum_kahan.html" title="Struct sum_kahan">
+<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +22,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="sum_impl.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_fwd_hpp"><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="tail_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../extract/sum_of_variates_kahan.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.sum_kahan_hpp"><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="../tag/sum_kahan.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.accumulators.impl.sum_kahan_impl"></a><div class="titlepage"></div>
@@ -29,53 +30,53 @@
<h2><span class="refentrytitle">Struct template sum_kahan_impl</span></h2>
<p>boost::accumulators::impl::sum_kahan_impl</p>
</div>
-<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
-<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_fwd_hpp" title="Header &lt;boost/accumulators/statistics_fwd.hpp&gt;">boost/accumulators/statistics_fwd.hpp</a>&gt;
+<h2 class="refsynopsisdiv-title">Synopsis</h2>
+<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.sum_kahan_hpp" title="Header &lt;boost/accumulators/statistics/sum_kahan.hpp&gt;">boost/accumulators/statistics/sum_kahan.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Sample<span class="special">,</span> <span class="keyword">typename</span> Tag<span class="special">&gt;</span>
<span class="keyword">struct</span> <a class="link" href="sum_kahan_impl.html" title="Struct template sum_kahan_impl">sum_kahan_impl</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">accumulator_base</span> <span class="special">{</span>
+ <span class="comment">// types</span>
+ <span class="keyword">typedef</span> <span class="identifier">Sample</span> <a name="boost.accumulators.impl.sum_kahan_impl.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
+
<span class="comment">// <a class="link" href="sum_kahan_impl.html#boost.accumulators.impl.sum_kahan_implconstruct-copy-destruct">construct/copy/destruct</a></span>
- <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_59_1_1_22_31_4-bb"><span class="identifier">sum_kahan_impl</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_31_1_1_9_1_5-bb"><span class="identifier">sum_kahan_impl</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_59_1_1_22_31_3-bb">public member functions</a></span>
- <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_59_1_1_22_31_3_1-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
- <span class="identifier">result_type</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_59_1_1_22_31_3_2-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_59_1_1_22_31_3_3-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_31_1_1_9_1_4-bb">public member functions</a></span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_31_1_1_9_1_4_1-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="identifier">result_type</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_31_1_1_9_1_4_2-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="sum_kahan_impl.html#id-1_3_2_6_3_31_1_1_9_1_4_3-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="id-1.3.2.6.3.57.35.4"></a><h2>Description</h2>
+<a name="id-1.3.2.6.3.30.6.4"></a><h2>Description</h2>
<div class="refsect2">
-<a name="id-1.3.2.6.3.57.35.4.2"></a><h3>
+<a name="id-1.3.2.6.3.30.6.4.2"></a><h3>
<a name="boost.accumulators.impl.sum_kahan_implconstruct-copy-destruct"></a><code class="computeroutput">sum_kahan_impl</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <a name="id-1_3_2_6_3_59_1_1_22_31_4-bb"></a><span class="identifier">sum_kahan_impl</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>Kahan summation algorithm. <p>The Kahan summation algorithm reduces the numerical error obtained with standard sequential sum. </p>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <a name="id-1_3_2_6_3_31_1_1_9_1_5-bb"></a><span class="identifier">sum_kahan_impl</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre>Kahan summation algorithm. <p>The Kahan summation algorithm reduces the numerical error obtained with standard sequential sum. </p>
</li></ol></div>
</div>
<div class="refsect2">
-<a name="id-1.3.2.6.3.57.35.4.3"></a><h3>
-<a name="id-1_3_2_6_3_59_1_1_22_31_3-bb"></a><code class="computeroutput">sum_kahan_impl</code> public member functions</h3>
+<a name="id-1.3.2.6.3.30.6.4.3"></a><h3>
+<a name="id-1_3_2_6_3_31_1_1_9_1_4-bb"></a><code class="computeroutput">sum_kahan_impl</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_2_6_3_59_1_1_22_31_3_1-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_2_6_3_59_1_1_22_31_3_2-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_2_6_3_31_1_1_9_1_4_1-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&amp;</span> args<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_2_6_3_31_1_1_9_1_4_2-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span>
- <span class="keyword">void</span> <a name="id-1_3_2_6_3_59_1_1_22_31_3_3-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></li>
+ <span class="keyword">void</span> <a name="id-1_3_2_6_3_31_1_1_9_1_4_3-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</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 © 2005, 2006 Eric Niebler<p>
+<div class="copyright-footer">Copyright © 2005, 2006 Eric Niebler<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>
+</div>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="sum_impl.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics_fwd_hpp"><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="tail_impl.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../extract/sum_of_variates_kahan.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.sum_kahan_hpp"><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="../tag/sum_kahan.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>