<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Struct template covariance_impl</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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.covariance_hpp" title="Header <boost/accumulators/statistics/covariance.hpp>">
<link rel="prev" href="../extract/covariance.html" title="Global covariance">
<link rel="next" href="../tag/covariance.html" title="Struct template covariance">
</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="../extract/covariance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.covariance_hpp"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tag/covariance.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Struct template covariance_impl">
<a name="boost.accumulators.impl.covariance_impl"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Struct template covariance_impl</span></h2>
<p>boost::accumulators::impl::covariance_impl — Covariance Estimator. </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="emphasis"><em>// In header: <<a class="link" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.covariance_hpp" title="Header <boost/accumulators/statistics/covariance.hpp>">boost/accumulators/statistics/covariance.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Sample, <span class="bold"><strong>typename</strong></span> VariateType, <span class="bold"><strong>typename</strong></span> VariateTag>
<span class="bold"><strong>struct</strong></span> <a class="link" href="covariance_impl.html" title="Struct template covariance_impl">covariance_impl</a> {
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> numeric::functional::average< Sample, std::size_t >::result_type <a name="boost.accumulators.impl.covariance_impl.sample_type"></a>sample_type;
<span class="bold"><strong>typedef</strong></span> numeric::functional::average< VariateType, std::size_t >::result_type <a name="boost.accumulators.impl.covariance_impl.variate_type"></a>variate_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="../../numeric/functional/outer_product.html" title="Struct template outer_product">numeric::functional::outer_product</a>< sample_type, variate_type >::result_type <a name="boost.accumulators.impl.covariance_impl.result_type"></a>result_type;
<span class="emphasis"><em>// <a class="link" href="covariance_impl.html#boost.accumulators.impl.covariance_implconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Args> <a class="link" href="covariance_impl.html#id551525-bb">covariance_impl</a>(Args <span class="bold"><strong>const</strong></span> &);
<span class="emphasis"><em>// <a class="link" href="covariance_impl.html#id551488-bb">public member functions</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Args> <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="covariance_impl.html#id551491-bb"><span class="bold"><strong>operator</strong></span>()</a>(Args <span class="bold"><strong>const</strong></span> &) ;
<span class="type">result_type</span> <a class="link" href="covariance_impl.html#id551512-bb">result</a>(dont_care) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id647503"></a><h2>Description</h2>
<p>An iterative Monte Carlo estimator for the covariance <span class="inlinemediaobject"><img src="../../../images/accumulators/form_0.png"></span>, where <span class="inlinemediaobject"><img src="../../../images/accumulators/form_1.png"></span> is a sample and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_2.png"></span> is a variate, is given by:</p>
<div class="equation">
<a name="id647572"></a><p class="title"><b>Equation 1.1. </b></p>
<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_3.png" align="middle"></div></div>
</div>
<p><br class="equation-break"></p>
<p><span class="inlinemediaobject"><img src="../../../images/accumulators/form_4.png"></span> and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_5.png"></span> being the means of the samples and variates. </p>
<div class="refsect2" title="covariance_impl public construct/copy/destruct">
<a name="id647638"></a><h3>
<a name="boost.accumulators.impl.covariance_implconstruct-copy-destruct"></a><code class="computeroutput">covariance_impl</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Args> <a name="id551525-bb"></a>covariance_impl(Args <span class="bold"><strong>const</strong></span> & args);</pre></li></ol></div>
</div>
<div class="refsect2" title="covariance_impl public member functions">
<a name="id647690"></a><h3>
<a name="id551488-bb"></a><code class="computeroutput">covariance_impl</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Args> <span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id551491-bb"></a><span class="bold"><strong>operator</strong></span>()(Args <span class="bold"><strong>const</strong></span> & args) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">result_type</span> <a name="id551512-bb"></a>result(dont_care) <span class="bold"><strong>const</strong></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>
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="../extract/covariance.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../accumulators/reference.html#header.boost.accumulators.statistics.covariance_hpp"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tag/covariance.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
