Math.NET Numerics
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

348 lines
14 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>DescriptiveStatistics - Math.NET Numerics Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link type="text/css" rel="stylesheet" href="../main.css"/>
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
<script type="text/javascript" src="../js/navigation.js"></script>
<script type="text/javascript" src="../js/example.js"></script>
</head>
<body><div id="namespaces">
<h2 class="fixed">Namespaces</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics/index.htm">MathNet.Numerics</a>
</li>
<li>
<a href="../MathNet.Numerics.Differentiation/index.htm">MathNet.Numerics.Differentiation</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/index.htm">MathNet.Numerics.Distributions</a>
</li>
<li>
<a href="../MathNet.Numerics.Financial/index.htm">MathNet.Numerics.Financial</a>
</li>
<li>
<a href="../MathNet.Numerics.IntegralTransforms/index.htm">MathNet.Numerics.IntegralTransforms</a>
</li>
<li>
<a href="../MathNet.Numerics.Integration/index.htm">MathNet.Numerics.Integration</a>
</li>
<li>
<a href="../MathNet.Numerics.Interpolation/index.htm">MathNet.Numerics.Interpolation</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra/index.htm">MathNet.Numerics.LinearAlgebra</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex/index.htm">MathNet.Numerics.LinearAlgebra.Complex</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex32/index.htm">MathNet.Numerics.LinearAlgebra.Complex32</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex32.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Double/index.htm">MathNet.Numerics.LinearAlgebra.Double</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Double.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Factorization/index.htm">MathNet.Numerics.LinearAlgebra.Factorization</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Single/index.htm">MathNet.Numerics.LinearAlgebra.Single</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Single.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Storage/index.htm">MathNet.Numerics.LinearAlgebra.Storage</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearRegression/index.htm">MathNet.Numerics.LinearRegression</a>
</li>
<li>
<a href="../MathNet.Numerics.OdeSolvers/index.htm">MathNet.Numerics.OdeSolvers</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization/index.htm">MathNet.Numerics.Optimization</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.LineSearch/index.htm">MathNet.Numerics.Optimization.LineSearch</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm">MathNet.Numerics.Optimization.ObjectiveFunctions</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.TrustRegion/index.htm">MathNet.Numerics.Optimization.TrustRegion</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers/index.htm">MathNet.Numerics.Providers</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.FourierTransform/index.htm">MathNet.Numerics.Providers.FourierTransform</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.LinearAlgebra/index.htm">MathNet.Numerics.Providers.LinearAlgebra</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.SparseSolver/index.htm">MathNet.Numerics.Providers.SparseSolver</a>
</li>
<li>
<a href="../MathNet.Numerics.Random/index.htm">MathNet.Numerics.Random</a>
</li>
<li>
<a href="../MathNet.Numerics.RootFinding/index.htm">MathNet.Numerics.RootFinding</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/index.htm" class="current">MathNet.Numerics.Statistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics.Mcmc/index.htm">MathNet.Numerics.Statistics.Mcmc</a>
</li>
</ul>
</div>
</div><div id="types">
<h2 class="fixed">Types in MathNet.Numerics.Statistics</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics.Statistics/ArrayStatistics.htm">ArrayStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/Correlation.htm">Correlation</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm" class="current">DescriptiveStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/Histogram.htm">Histogram</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/KernelDensity.htm">KernelDensity</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/MovingStatistics.htm">MovingStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/QuantileDefinition.htm">QuantileDefinition</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/RankDefinition.htm">RankDefinition</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/RunningStatistics.htm">RunningStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/SortedArrayStatistics.htm">SortedArrayStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/Statistics.htm">Statistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/StreamingStatistics.htm">StreamingStatistics</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> DescriptiveStatistics</p>
<p><strong>Namespace</strong> MathNet.Numerics.Statistics</p>
</div>
<div class="sub-header">
<div id="summary">Computes the basic statistics of data set. The class meets the
NIST standard of accuracy for mean, variance, and standard deviation
(the only statistics they provide exact values for) and exceeds them
in increased accuracy mode.
Recommendation: consider to use RunningStatistics instead. <blockquote class="remarks">
This type declares a DataContract for out of the box ephemeral serialization
with engines like DataContractSerializer, Protocol Buffers and FsPickler,
but does not guarantee any compatibility between versions.
It is not recommended to rely on this mechanism for durable persistence.
</blockquote>
</div>
<h3 class="section">Constructors</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#.ctor">DescriptiveStatistics</a></li>
</ul>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Count">Count</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Kurtosis">Kurtosis</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Maximum">Maximum</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Mean">Mean</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Minimum">Minimum</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Skewness">Skewness</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#StandardDeviation">StandardDeviation</a></li>
<li><a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Variance">Variance</a></li>
</ul>
</div>
<h3 class="section">Public Constructors</h3>
<div id=".ctor" class="method">
<h4> <strong>DescriptiveStatistics</strong>(<span title="System.Collections.Generic.IEnumerable<double>">IEnumerable&lt;double&gt;</span> data, <span title="System.bool">bool</span> increasedAccuracy)</h4>
<div class="content">Initializes a new instance of the <a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm">DescriptiveStatistics</a> class. <blockquote class="remarks">
Don't use increased accuracy for data sets containing large values (in absolute value).
This may cause the calculations to overflow.
</blockquote>
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.Collections.Generic.IEnumerable<double>">IEnumerable&lt;double&gt;</span></code> data</h6>
<p class="comments">The sample data. </p>
<h6><code><span title="System.bool">bool</span></code> increasedAccuracy</h6>
<p class="comments">If set to <code>true</code> , increased accuracy mode used.
Increased accuracy mode uses <a href="../System/Decimal.htm">Decimal</a> types for internal calculations. </p>
</div>
</div>
</div>
<h3 class="section">Public Methods</h3>
<div id="Equals" class="method">
<h4><span title="System.bool">bool</span> <strong>Equals</strong>(<span title="System.object">object</span> obj)</h4>
<div class="content">
</div>
</div>
<div id="GetHashCode" class="method">
<h4><span title="System.int">int</span> <strong>GetHashCode</strong>()</h4>
<div class="content">
</div>
</div>
<div id="GetType" class="method">
<h4><span title="System.Type">Type</span> <strong>GetType</strong>()</h4>
<div class="content">
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public Properties</h3>
<div id="Count" class="method">
<h4><span title="System.long">long</span> <strong>Count</strong> get; set;</h4>
<div class="content">Gets the size of the sample.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Kurtosis" class="method">
<h4><span title="System.double">double</span> <strong>Kurtosis</strong> get; set;</h4>
<div class="content">Gets the sample kurtosis. <blockquote class="remarks">
Returns zero if <a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Count">Count</a> is less than four.
</blockquote>
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Maximum" class="method">
<h4><span title="System.double">double</span> <strong>Maximum</strong> get; set;</h4>
<div class="content">Gets the maximum sample value.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Mean" class="method">
<h4><span title="System.double">double</span> <strong>Mean</strong> get; set;</h4>
<div class="content">Gets the sample mean.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Minimum" class="method">
<h4><span title="System.double">double</span> <strong>Minimum</strong> get; set;</h4>
<div class="content">Gets the minimum sample value.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Skewness" class="method">
<h4><span title="System.double">double</span> <strong>Skewness</strong> get; set;</h4>
<div class="content">Gets the sample skewness. <blockquote class="remarks">
Returns zero if <a href="../MathNet.Numerics.Statistics/DescriptiveStatistics.htm#Count">Count</a> is less than three.
</blockquote>
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="StandardDeviation" class="method">
<h4><span title="System.double">double</span> <strong>StandardDeviation</strong> get; set;</h4>
<div class="content">Gets the unbiased population standard deviation (on a dataset of size N will use an N-1 normalizer).
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Variance" class="method">
<h4><span title="System.double">double</span> <strong>Variance</strong> get; set;</h4>
<div class="content">Gets the unbiased population variance estimator (on a dataset of size N will use an N-1 normalizer).
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="footer">
<p>Based on v5.0.0.0 of MathNet.Numerics (Math.NET Numerics)</p>
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
</div>
</body>
</html>