Click or drag to resize

MatrixNormal Class

Generalization of the normal (Gaussian) distribution to matrix-valued random variables. http://en.wikipedia.org/wiki/Matrix_normal_distribution
Inheritance Hierarchy
SystemObject
  FinMath.Statistics.DistributionsCMDistribution
    FinMath.Statistics.DistributionsMatrixNormal

Namespace:  FinMath.Statistics.Distributions
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
[SerializableAttribute]
public class MatrixNormal : CMDistribution

The MatrixNormal type exposes the following members.

Constructors
  NameDescription
Public methodMatrixNormal(Int32, Int32)
Creates new instance of MatrixNormal with default settings (0, En, Em).
Public methodMatrixNormal(Matrix, Matrix, Matrix)
Creates new instance of MatrixNormal with user specified parameters.
Public methodMatrixNormal(RandomGenerator, Matrix, Matrix, Matrix)
Creates new instance of with user specified generator and parameters.
Top
Properties
  NameDescription
Public propertyColCovarianceIsPositiveDefinite
Indicates whether user specified column covariance matrix is positive definite.
Public propertyColumnCovariance
Column covariance matrix.
Public propertyColumns
Number of columns in distribution.
(Inherited from CMDistribution.)
Public propertyEntropy
Entropy of the distribution. http://en.wikipedia.org/wiki/Information_entropy
(Inherited from CMDistribution.)
Public propertyMean
Means matrix.
(Overrides CMDistributionMean.)
Public propertyMethod
Method of normal distribution generation.
Public propertyMode
Mode of the distribution. http://en.wikipedia.org/wiki/Mode_(statistics)
(Inherited from CMDistribution.)
Public propertyRowCovariance
Row covariance matrix.
Public propertyRowCovarianceIsPositiveDefinite
Indicates whether user specified row covariance matrix is positive definite.
Public propertyRows
Number of rows in distribution.
(Inherited from CMDistribution.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPdf(Matrix)
Probability distribution function. http://en.wikipedia.org/wiki/Probability_density_function
(Overrides CMDistributionPdf(Matrix).)
Public methodStatic memberPdf(Matrix, Matrix, Matrix, Matrix)
Probability distribution function. http://en.wikipedia.org/wiki/Probability_density_function
Public methodSample
Creates random variable sample.
(Inherited from CMDistribution.)
Public methodSample(Matrix)
Generates random variable sample.
(Overrides CMDistributionSample(Matrix).)
Public methodStatic memberSample(Matrix, Matrix, Matrix)
Static method which generates sample of matrix normal distribution with user specified generator and parameters.
Public methodStatic memberSample(RandomGenerator, Matrix, Matrix, Matrix)
Static method which generates sample of matrix normal distribution with user specified generator and parameters.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also