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.
 
 
 

531 lines
21 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>Wishart - 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" class="current">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">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.Distributions</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics.Distributions/Bernoulli.htm">Bernoulli</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Beta.htm">Beta</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/BetaBinomial.htm">BetaBinomial</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/BetaScaled.htm">BetaScaled</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Binomial.htm">Binomial</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Burr.htm">Burr</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Categorical.htm">Categorical</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Cauchy.htm">Cauchy</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Chi.htm">Chi</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/ChiSquared.htm">ChiSquared</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/ContinuousUniform.htm">ContinuousUniform</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/ConwayMaxwellPoisson.htm">ConwayMaxwellPoisson</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Dirichlet.htm">Dirichlet</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/DiscreteUniform.htm">DiscreteUniform</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Erlang.htm">Erlang</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Exponential.htm">Exponential</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/FisherSnedecor.htm">FisherSnedecor</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Gamma.htm">Gamma</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Geometric.htm">Geometric</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Hypergeometric.htm">Hypergeometric</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/IContinuousDistribution.htm">IContinuousDistribution</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/IDiscreteDistribution.htm">IDiscreteDistribution</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/IDistribution.htm">IDistribution</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/InverseGamma.htm">InverseGamma</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/InverseGaussian.htm">InverseGaussian</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/InverseWishart.htm">InverseWishart</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/IUnivariateDistribution.htm">IUnivariateDistribution</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Laplace.htm">Laplace</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Logistic.htm">Logistic</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/LogNormal.htm">LogNormal</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/MatrixNormal.htm">MatrixNormal</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/MeanPrecisionPair.htm">MeanPrecisionPair</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Multinomial.htm">Multinomial</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/NegativeBinomial.htm">NegativeBinomial</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Normal.htm">Normal</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/NormalGamma.htm">NormalGamma</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Pareto.htm">Pareto</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Poisson.htm">Poisson</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Rayleigh.htm">Rayleigh</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/SkewedGeneralizedError.htm">SkewedGeneralizedError</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/SkewedGeneralizedT.htm">SkewedGeneralizedT</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Stable.htm">Stable</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/StudentT.htm">StudentT</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Triangular.htm">Triangular</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/TruncatedPareto.htm">TruncatedPareto</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Weibull.htm">Weibull</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Wishart.htm" class="current">Wishart</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/Zipf.htm">Zipf</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> Wishart</p>
<p><strong>Namespace</strong> MathNet.Numerics.Distributions</p>
<p><strong>Interfaces</strong> <a href="../MathNet.Numerics.Distributions/IDistribution.htm">IDistribution</a></p>
</div>
<div class="sub-header">
<div id="summary">Multivariate Wishart distribution. This distribution is
parameterized by the degrees of freedom nu and the scale matrix S. The Wishart distribution
is the conjugate prior for the precision (inverse covariance) matrix of the multivariate
normal distribution..
</div>
<h3 class="section">Constructors</h3>
<ul>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#.ctor">Wishart</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#.ctor">Wishart</a></li>
</ul>
<h3 class="section">Static Functions</h3>
<ul>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#IsValidParameterSet">IsValidParameterSet</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Sample">Sample</a></li>
</ul>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Density">Density</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Sample">Sample</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#DegreesOfFreedom">DegreesOfFreedom</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Mean">Mean</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Mode">Mode</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#RandomSource">RandomSource</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Scale">Scale</a></li>
<li><a href="../MathNet.Numerics.Distributions/Wishart.htm#Variance">Variance</a></li>
</ul>
</div>
<h3 class="section">Public Constructors</h3>
<div id=".ctor" class="method">
<h4> <strong>Wishart</strong>(<span title="System.double">double</span> degreesOfFreedom, <a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> scale)</h4>
<div class="content">Initializes a new instance of the <a href="../MathNet.Numerics.Distributions/Wishart.htm">Wishart</a> class.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> degreesOfFreedom</h6>
<p class="comments">The degrees of freedom (n) for the Wishart distribution. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> scale</h6>
<p class="comments">The scale matrix (V) for the Wishart distribution. </p>
</div>
</div>
</div>
<div id=".ctor" class="method">
<h4> <strong>Wishart</strong>(<span title="System.double">double</span> degreesOfFreedom, <a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> scale, <span title="System.Random">Random</span> randomSource)</h4>
<div class="content">Initializes a new instance of the <a href="../MathNet.Numerics.Distributions/Wishart.htm">Wishart</a> class.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> degreesOfFreedom</h6>
<p class="comments">The degrees of freedom (n) for the Wishart distribution. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> scale</h6>
<p class="comments">The scale matrix (V) for the Wishart distribution. </p>
<h6><code><span title="System.Random">Random</span></code> randomSource</h6>
<p class="comments">The random number generator which is used to draw random samples. </p>
</div>
</div>
</div>
<h3 class="section">Public Static Functions</h3>
<div id="IsValidParameterSet" class="method">
<h4><span title="System.bool">bool</span> <strong>IsValidParameterSet</strong>(<span title="System.double">double</span> degreesOfFreedom, <a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> scale)</h4>
<div class="content">Tests whether the provided values are valid parameters for this distribution.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.double">double</span></code> degreesOfFreedom</h6>
<p class="comments">The degrees of freedom (n) for the Wishart distribution. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> scale</h6>
<p class="comments">The scale matrix (V) for the Wishart distribution. </p>
</div>
</div>
</div>
<div id="Sample" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Sample</strong>(<span title="System.Random">Random</span> rnd, <span title="System.double">double</span> degreesOfFreedom, <a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> scale)</h4>
<div class="content">Samples a Wishart distributed random variable using the method
Algorithm AS 53: Wishart Variate Generator
W. B. Smith and R. R. Hocking
Applied Statistics, Vol. 21, No. 3 (1972), pp. 341-345
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.Random">Random</span></code> rnd</h6>
<p class="comments">The random number generator to use. </p>
<h6><code><span title="System.double">double</span></code> degreesOfFreedom</h6>
<p class="comments">The degrees of freedom (n) for the Wishart distribution. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> scale</h6>
<p class="comments">The scale matrix (V) for the Wishart distribution. </p>
</div>
<div class="return">
<h5>Return</h5>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code></h6>
<p>a sequence of samples from the distribution. </p>
</div>
</div>
</div>
<h3 class="section">Public Methods</h3>
<div id="Density" class="method">
<h4><span title="System.double">double</span> <strong>Density</strong>(<a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> x)</h4>
<div class="content">Evaluates the probability density function for the Wishart distribution.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> x</h6>
<p class="comments">The matrix at which to evaluate the density at. </p>
</div>
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.double">double</span></code></h6>
<p>the density at <var>x</var>. </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="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="Sample" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Sample</strong>()</h4>
<div class="content">Samples a Wishart distributed random variable using the method
Algorithm AS 53: Wishart Variate Generator
W. B. Smith and R. R. Hocking
Applied Statistics, Vol. 21, No. 3 (1972), pp. 341-345
<div class="return">
<h5>Return</h5>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code></h6>
<p>A random number from this distribution. </p>
</div>
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
<div class="content">A string representation of the distribution.
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.string">string</span></code></h6>
<p>a string representation of the distribution. </p>
</div>
</div>
</div>
<h3 class="section">Public Properties</h3>
<div id="DegreesOfFreedom" class="method">
<h4><span title="System.double">double</span> <strong>DegreesOfFreedom</strong> get; </h4>
<div class="content">Gets or sets the degrees of freedom (n) for the Wishart distribution.
</div>
</div>
<div id="Mean" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Mean</strong> get; </h4>
<div class="content">Gets the mean of the distribution.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="Mode" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Mode</strong> get; </h4>
<div class="content">Gets the mode of the distribution.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="RandomSource" class="method">
<h4><span title="System.Random">Random</span> <strong>RandomSource</strong> get; set;</h4>
<div class="content">Gets or sets the random number generator which is used to draw random samples.
</div>
</div>
<div id="Scale" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Scale</strong> get; </h4>
<div class="content">Gets or sets the scale matrix (V) for the Wishart distribution.
</div>
</div>
<div id="Variance" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Variance</strong> get; </h4>
<div class="content">Gets the variance of the distribution.
<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>