CovarianceUtilities.GetRandomStates(Matrix, Array, Variable, RandomNumberGenerator) Method

Top

Description

Returns multiple random states from a Gaussian distribution described by the provided covariance matrix. The resulting random states are returned in a column matrix.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Method Signature

CovarianceUtilities.GetRandomStates(	Matrix covariance,
	Array meanState,
	Variable numberOfStates,
	RandomNumberGenerator random)

Arguments

covariance
Description:	The covariance matrix that describes the Gaussian distribution from which to draw a state.

meanState
Description:	The mean state associated with the covariance matrix. The returned states are referenced from the provided mean.

numberOfStates
Description:	The number of states to generate.
Valid Range:	numberOfStates > 0

random
Description:	RandomNumberGenerator object to use when computing random states.

Return Value

Type:

Matrix of number

Returns a set of random states in a column matrix.

Syntax

myMatrix1 = CovarianceUtilities.GetRandomStates(myMatrix2, myArray1, myVariable1, myRandomNumberGenerator1);