csharpfftfsharpintegrationinterpolationlinear-algebramathdifferentiationmatrixnumericsrandomregressionstatisticsmathnet
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.
369 lines
14 KiB
369 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>Bucket - 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" class="current">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">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> Bucket</p>
|
|
<p><strong>Namespace</strong> MathNet.Numerics.Statistics</p>
|
|
<p><strong>Interfaces</strong> <span title="System.IComparable<Bucket>">IComparable<Bucket></span>, <span title="System.ICloneable">ICloneable</span></p>
|
|
</div>
|
|
<div class="sub-header">
|
|
<div id="summary">A <a href="../MathNet.Numerics.Statistics/Histogram.htm">Histogram</a> consists of a series of <a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a> s,
|
|
each representing a region limited by a lower bound (exclusive) and an upper bound (inclusive). <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/Bucket.htm#.ctor">Bucket</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#.ctor">Bucket</a></li>
|
|
</ul>
|
|
|
|
<h3 class="section">Methods</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#Clone">Clone</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#CompareTo">CompareTo</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#Contains">Contains</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#Equals">Equals</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#GetHashCode">GetHashCode</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#GetType">GetType</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#ToString">ToString</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3 class="section">Properties</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#Count">Count</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#DefaultPointComparer">DefaultPointComparer</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#LowerBound">LowerBound</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#UpperBound">UpperBound</a></li>
|
|
<li><a href="../MathNet.Numerics.Statistics/Bucket.htm#Width">Width</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Constructors</h3>
|
|
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>Bucket</strong>(<span title="System.double">double</span> lowerBound, <span title="System.double">double</span> upperBound, <span title="System.double">double</span> count)</h4>
|
|
<div class="content">Initializes a new instance of the Bucket class.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>Bucket</strong>(<span title="System.double">double</span> targetValue)</h4>
|
|
<div class="content">Constructs a Bucket that can be used as an argument for a <span title="System.Collections.Generic.IComparer`1">IComparer`1</span> like <a href="../MathNet.Numerics.Statistics/Bucket.htm#DefaultPointComparer">DefaultPointComparer</a> when performing a Binary search.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.double">double</span></code> targetValue</h6>
|
|
<p class="comments">Value to look for </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Methods</h3>
|
|
|
|
<div id="Clone" class="method">
|
|
<h4><span title="System.object">object</span> <strong>Clone</strong>()</h4>
|
|
<div class="content">Creates a copy of the Bucket with the lowerbound, upperbound and counts exactly equal.
|
|
|
|
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.object">object</span></code></h6>
|
|
<p>A cloned Bucket object. </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="CompareTo" class="method">
|
|
<h4><span title="System.int">int</span> <strong>CompareTo</strong>(<a href="../MathNet.Numerics.Statistics/Bucket.htm">Bucket</a> bucket)</h4>
|
|
<div class="content">Comparison of two disjoint buckets. The buckets cannot be overlapping.
|
|
|
|
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.int">int</span></code></h6>
|
|
<p>0 if <code>UpperBound</code> and <code>LowerBound</code> are bit-for-bit equal
|
|
1 if This bucket is lower that the compared bucket
|
|
-1 otherwise </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Contains" class="method">
|
|
<h4><span title="System.int">int</span> <strong>Contains</strong>(<span title="System.double">double</span> x)</h4>
|
|
<div class="content">This method check whether a point is contained within this bucket.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.double">double</span></code> x</h6>
|
|
<p class="comments">The point to check. </p>
|
|
</div>
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.int">int</span></code></h6>
|
|
<p>0 if the point falls within the bucket boundaries;
|
|
-1 if the point is smaller than the bucket,
|
|
+1 if the point is larger than the bucket. </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">Checks whether two Buckets are equal. <blockquote class="remarks">
|
|
<code>UpperBound</code> and <code>LowerBound</code> are compared bit-for-bit, but This method tolerates a
|
|
difference in <code>Count</code> given by .
|
|
</blockquote>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="GetHashCode" class="method">
|
|
<h4><span title="System.int">int</span> <strong>GetHashCode</strong>()</h4>
|
|
<div class="content">Provides a hash code for this bucket.
|
|
|
|
|
|
|
|
|
|
</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">Formats a human-readable string for this bucket.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<h3 class="section">Public Properties</h3>
|
|
|
|
<div id="Count" class="method">
|
|
<h4><span title="System.double">double</span> <strong>Count</strong> get; set;</h4>
|
|
<div class="content">The number of datapoints in the bucket. <blockquote class="remarks">
|
|
Value may be NaN if this was constructed as a <span title="System.Collections.Generic.IComparer`1">IComparer`1</span> argument.
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="DefaultPointComparer" class="method">
|
|
<h4><span title="System.Collections.Generic.IComparer<Bucket>">IComparer<Bucket></span> <strong>DefaultPointComparer</strong> get; </h4>
|
|
<div class="content">Default comparer.
|
|
|
|
</div>
|
|
</div>
|
|
<div id="LowerBound" class="method">
|
|
<h4><span title="System.double">double</span> <strong>LowerBound</strong> get; set;</h4>
|
|
<div class="content">Lower Bound of the Bucket.
|
|
|
|
</div>
|
|
</div>
|
|
<div id="UpperBound" class="method">
|
|
<h4><span title="System.double">double</span> <strong>UpperBound</strong> get; set;</h4>
|
|
<div class="content">Upper Bound of the Bucket.
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Width" class="method">
|
|
<h4><span title="System.double">double</span> <strong>Width</strong> get; </h4>
|
|
<div class="content">Width of the Bucket.
|
|
|
|
</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>
|