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.
 
 
 

413 lines
16 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>Histogram - 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">DescriptiveStatistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/Histogram.htm" class="current">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> Histogram</p>
<p><strong>Namespace</strong> MathNet.Numerics.Statistics</p>
</div>
<div class="sub-header">
<div id="summary">A class which computes histograms of data.
</div>
<h3 class="section">Constructors</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#.ctor">Histogram</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#.ctor">Histogram</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#.ctor">Histogram</a></li>
</ul>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#AddBucket">AddBucket</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#AddData">AddData</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#AddData">AddData</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#GetBucketIndexOf">GetBucketIndexOf</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#GetBucketOf">GetBucketOf</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#BucketCount">BucketCount</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#DataCount">DataCount</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#Item">Item</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#LowerBound">LowerBound</a></li>
<li><a href="../MathNet.Numerics.Statistics/Histogram.htm#UpperBound">UpperBound</a></li>
</ul>
</div>
<h3 class="section">Public Constructors</h3>
<div id=".ctor" class="method">
<h4> <strong>Histogram</strong>()</h4>
<div class="content">Initializes a new instance of the Histogram class.
</div>
</div>
<div id=".ctor" class="method">
<h4> <strong>Histogram</strong>(<span title="System.Collections.Generic.IEnumerable<double>">IEnumerable&lt;double&gt;</span> data, <span title="System.int">int</span> nbuckets)</h4>
<div class="content">Constructs a Histogram with a specific number of equally sized buckets. The upper and lower bound of the histogram
will be set to the smallest and largest datapoint.
<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 data sequence to build a histogram on. </p>
<h6><code><span title="System.int">int</span></code> nbuckets</h6>
<p class="comments">The number of buckets to use. </p>
</div>
</div>
</div>
<div id=".ctor" class="method">
<h4> <strong>Histogram</strong>(<span title="System.Collections.Generic.IEnumerable<double>">IEnumerable&lt;double&gt;</span> data, <span title="System.int">int</span> nbuckets, <span title="System.double">double</span> lower, <span title="System.double">double</span> upper)</h4>
<div class="content">Constructs a Histogram with a specific number of equally sized buckets.
<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 data sequence to build a histogram on. </p>
<h6><code><span title="System.int">int</span></code> nbuckets</h6>
<p class="comments">The number of buckets to use. </p>
<h6><code><span title="System.double">double</span></code> lower</h6>
<p class="comments">The histogram lower bound. </p>
<h6><code><span title="System.double">double</span></code> upper</h6>
<p class="comments">The histogram upper bound. </p>
</div>
</div>
</div>
<h3 class="section">Public Methods</h3>
<div id="AddBucket" class="method">
<h4><span title="System.void">void</span> <strong>AddBucket</strong>(<a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a> bucket)</h4>
<div class="content">Adds a <code>Bucket</code> to the <code>Histogram</code>.
</div>
</div>
<div id="AddData" class="method">
<h4><span title="System.void">void</span> <strong>AddData</strong>(<span title="System.double">double</span> d)</h4>
<div class="content">Add one data point to the histogram. If the datapoint falls outside the range of the histogram,
the lowerbound or upperbound will automatically adapt.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> d</h6>
<p class="comments">The datapoint which we want to add. </p>
</div>
</div>
</div>
<div id="AddData" class="method">
<h4><span title="System.void">void</span> <strong>AddData</strong>(<span title="System.Collections.Generic.IEnumerable<double>">IEnumerable&lt;double&gt;</span> data)</h4>
<div class="content">Add a sequence of data point to the histogram. If the datapoint falls outside the range of the histogram,
the lowerbound or upperbound will automatically adapt.
<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 sequence of datapoints which we want to add. </p>
</div>
</div>
</div>
<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="GetBucketIndexOf" class="method">
<h4><span title="System.int">int</span> <strong>GetBucketIndexOf</strong>(<span title="System.double">double</span> v)</h4>
<div class="content">Returns the index in the <code>Histogram</code> of the <code>Bucket</code> that contains the value <code>v</code>.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> v</h6>
<p class="comments">The point to search the bucket index for. </p>
</div>
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.int">int</span></code></h6>
<p>The index of the bucket containing the point. </p>
</div>
</div>
</div>
<div id="GetBucketOf" class="method">
<h4><a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a> <strong>GetBucketOf</strong>(<span title="System.double">double</span> v)</h4>
<div class="content">Returns the <code>Bucket</code> that contains the value <code>v</code>.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> v</h6>
<p class="comments">The point to search the bucket for. </p>
</div>
<div class="return">
<h5>Return</h5>
<h6><code><a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a></code></h6>
<p>A copy of the bucket containing point <var>v</var>. </p>
</div>
</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">Prints the buckets contained in the <a href="../MathNet.Numerics.Statistics/Histogram.htm">Histogram</a>.
</div>
</div>
<h3 class="section">Public Properties</h3>
<div id="BucketCount" class="method">
<h4><span title="System.int">int</span> <strong>BucketCount</strong> get; </h4>
<div class="content">Gets the number of buckets.
</div>
</div>
<div id="DataCount" class="method">
<h4><span title="System.double">double</span> <strong>DataCount</strong> get; </h4>
<div class="content">Gets the total number of datapoints in the histogram.
</div>
</div>
<div id="Item" class="method">
<h4><a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a> <strong>Item</strong> get; </h4>
<div class="content">Gets the <code>n</code> 'th bucket.
</div>
</div>
<div id="LowerBound" class="method">
<h4><span title="System.double">double</span> <strong>LowerBound</strong> get; </h4>
<div class="content">Returns the lower bound of the histogram.
</div>
</div>
<div id="UpperBound" class="method">
<h4><span title="System.double">double</span> <strong>UpperBound</strong> get; </h4>
<div class="content">Returns the upper bound of the histogram.
</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>