Represents a matrix of statistical collectors for functions of multiple means. More...

Inheritance diagram for umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >:

Public Member Functions
	MatrixOfFunctionOfMultipleMeansTallies (int numRows, int numColumns)
	Constructs a new unnamed matrix of function of multiple means tallies with numRows rows, and numColumns columns, and filled with null references.
	MatrixOfFunctionOfMultipleMeansTallies (String name, int numRows, int numColumns)
	Constructs a new empty matrix of function of multiple means tallies with name name, numRows rows, and numColumns columns, and filled with null references.
void	add (double[][][] x)
	For each function of multiple means tally with row index r and column index c, adds the vector of observations x[r][c] if collecting is turned ON.
void	add (DoubleMatrix3D x)
	Equivalent to `add(x.toArray())`, without copying the elements of x into a temporary 3D array.
void	addSameDimension (DoubleMatrix2D... x)
	For each element (r, c) of this matrix of tallies, adds the vector of observations x[0].get (r, c), …, x[d-1].get (r, c).
int	getDimension ()
	Assuming that each tally in this matrix has the same dimension, returns the dimension of tally (0, 0), or 0 if the matrix has no row or column.
int	numberObs ()
	Assuming that each tally in this matrix contains the same number of observations, returns the number of observations in tally (0, 0), or 0 if the matrix has no row or column.
boolean	areAllNumberObsEqual ()
	Tests that every tally in this matrix contains the same number of observations.
void	average (DoubleMatrix2D m)
	Computes the average for each function of multiple means tally in the matrix.
void	variance (DoubleMatrix2D m)
	For each tally in the matrix, computes the sample variance, and stores it into the given matrix.
void	standardDeviation (DoubleMatrix2D m)
	For each tally in the matrix, computes the standard deviation, and stores it into the matrix m.
MatrixOfFunctionOfMultipleMeansTallies< E >	clone ()
	Clones this object.
Public Member Functions inherited from umontreal.ssj.stat.matrix.MatrixOfStatProbes< E >
	MatrixOfStatProbes (int numRows, int numColumns)
	Constructs a new unnamed matrix of statistical probes with numRows rows, and numColumns columns, and filled with null references.
String	getName ()
	Returns the global name of this matrix of statistical probes.
void	setName (String name)
	Sets the global name of this matrix to name.
int	rows ()
	Returns the number of rows in this matrix.
int	columns ()
	Returns the number of columns in this matrix.
void	setRows (int newRows)
	Sets the number of rows of this matrix of statistical probes to newRows, adding or removing cells as necessary.
void	setColumns (int newColumns)
	Similar to setRows(int), for setting the number of columns.
E	get (int r, int c)
	Returns the statistical probe corresponding to the row r and column c.
void	set (int r, int c, E probe)
	Sets the statistical probe corresponding to the row r and column c to probe.
void	init ()
	Initializes this matrix of statistical probes by calling StatProbe.init on each element.
void	sum (DoubleMatrix2D m)
	For each probe in the matrix, computes the sum by calling umontreal.ssj.stat.StatProbe.sum, and stores it into the given matrix m.
void	average (DoubleMatrix2D m)
	For each statistical probe in the matrix, computes the average by calling umontreal.ssj.stat.StatProbe.average, and stores it into the given matrix m.
boolean	isCollecting ()
	Determines if this matrix of statistical probes is collecting values.
void	setCollecting (boolean c)
	Sets the status of the statistical collecting mechanism to c.
boolean	isBroadcasting ()
	Determines if this matrix of statistical probes is broadcasting values to registered observers.
void	setBroadcasting (boolean b)
	Sets the status of the observation broadcasting mechanism to b.
void	addMatrixOfObservationListener (MatrixOfObservationListener l)
	Adds the observation listener l to the list of observers of this matrix of statistical probes.
void	removeMatrixOfObservationListener (MatrixOfObservationListener l)
	Removes the observation listener l from the list of observers of this matrix of statistical probes.
void	clearMatrixOfObservationListeners ()
	Removes all observation listeners from the list of observers of this matrix of statistical probes.
void	notifyListeners (DoubleMatrix2D x)
	Notifies the observation x to all registered observers if broadcasting is ON.
List< E >	viewRow (int r)
	Returns a list representing a view on row r of this matrix of statistical probe.
List< E >	viewColumn (int c)
	Returns a list representing a view on column c of this matrix of statistical probe.
String	rowReport (int r)
	Formats a report for the row r of the statistical probe matrix.
String	columnReport (int c)
	Formats a report for the column c of the statistical probe matrix.
MatrixOfStatProbes< E >	clone ()
	Clones this object.

Static Public Member Functions
static MatrixOfFunctionOfMultipleMeansTallies< FunctionOfMultipleMeansTally >	create (MultivariateFunction func, int d, int numRows, int numColumns)
	This factory method constructs and returns a matrix of function of multiple means tallies with numRows rows, numColumns columns, and filled with instances of .

Detailed Description

Represents a matrix of statistical collectors for functions of multiple means.

Each element of such a matrix is an instance of

umontreal.ssj.stat.FunctionOfMultipleMeansTally, and observations can be added with the add(double[][][]) method. This class defines a factory method to construct a matrix of tallies computing the same function and sharing the same dimension.

Definition at line 46 of file MatrixOfFunctionOfMultipleMeansTallies.java.

Constructor & Destructor Documentation

◆ MatrixOfFunctionOfMultipleMeansTallies() [1/2]

umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.MatrixOfFunctionOfMultipleMeansTallies	(	int	numRows,
		int	numColumns )

Constructs a new unnamed matrix of function of multiple means tallies with numRows rows, and numColumns columns, and filled with null references.

Parameters

numRows	the number of rows in the matrix.
numColumns	the number of columns in the matrix.

Exceptions

NegativeArraySizeException if `numRows` or `numColumns` are negative.

Definition at line 59 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ MatrixOfFunctionOfMultipleMeansTallies() [2/2]

umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.MatrixOfFunctionOfMultipleMeansTallies	(	String	name,
		int	numRows,
		int	numColumns )

Constructs a new empty matrix of function of multiple means tallies with name name, numRows rows, and numColumns columns, and filled with null references.

Parameters

name	the global name of the matrix.
numRows	the number of rows in the matrix.
numColumns	the number of columns in the matrix.

Exceptions

NegativeArraySizeException if `numRows` or `numColumns` are negative.

Definition at line 74 of file MatrixOfFunctionOfMultipleMeansTallies.java.

Member Function Documentation

◆ add() [1/2]

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.add ( double x[][][] )

For each function of multiple means tally with row index r and column index c, adds the vector of observations x[r][c] if collecting is turned ON.

Parameters

x	the vectors of observations to be added.

Exceptions

IllegalArgumentException if the dimensions of `x`, `x[r]`, or x[r][c] are incorrect.

Definition at line 110 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ add() [2/2]

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.add ( DoubleMatrix3D x )

Equivalent to add(x.toArray()), without copying the elements of x into a temporary 3D array.

Each slice of the 3D matrix x corresponds to a row of the matrix of probes. Each row of the 3D matrix corresponds to a column of the matrix of probes. Each column of the 3D matrix corresponds to a component of a vector of observations added to a function of multiple means tally. This can be used only when all the function of multiple means tallies in the array share the same dimension.

Parameters

x	the matrix of observations.

Exceptions

IllegalArgumentException if the dimensions of the matrix are incorrect.

Definition at line 137 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ addSameDimension()

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.addSameDimension ( DoubleMatrix2D... x )

For each element (r, c) of this matrix of tallies, adds the vector of observations x[0].get (r, c), …, x[d-1].get (r, c).

This method can be used only when all tallies in this matrix share the same dimension. It creates a transposed 3D array compatible with add(double[][][]), and calls the latter method with this array. For example, let mt be a matrix of tallies with dimensions

\(r\times c\) whose l \(=rc\) elements correspond to ratios. If a program can generate two matrices num and den of dimensions \(r\times c\) representing observations for the numerator and denominator of the ratios, respectively, the observations can be added using mt.add (num, den) instead of creating an intermediate 3D array of observations.

Parameters

x	the array of matrices of observations.

Exceptions

IllegalArgumentException if the length of `x` does not correspond to the dimension of the tally, or the dimensions of the matrices x[j] are not equal for all j=0,…,d-1.

Definition at line 170 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ areAllNumberObsEqual()

boolean umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.areAllNumberObsEqual ( )

Tests that every tally in this matrix contains the same number of observations.

This returns true if and only if the matrix has no row and no column, or if all tallies have the same number of observations.

Returns: the success indicator of the test.

Definition at line 233 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ average()

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.average ( DoubleMatrix2D m )

Computes the average for each function of multiple means tally in the matrix.

If the tally \((r, c)\) has no observation, the Double.NaN value is stored in the given matrix, at row r, column c.

Definition at line 251 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ clone()

MatrixOfFunctionOfMultipleMeansTallies< E > umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.clone ( )

Clones this object.

Makes a shallow copy of this matrix, i.e., does not clone all the probes in the matrix.

Definition at line 316 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ create()

MatrixOfFunctionOfMultipleMeansTallies< FunctionOfMultipleMeansTally > umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.create	(	MultivariateFunction	func,
		int	d,
		int	numRows,
		int	numColumns )

static

This factory method constructs and returns a matrix of function of multiple means tallies with numRows rows, numColumns columns, and filled with instances of
.

umontreal.ssj.stat.FunctionOfMultipleMeansTally. Each tally computes the multivariate function func, in d dimensions.

Parameters

func	the multivariate function computed by the tallies.
d	the dimension of the tallies.
numRows	the number of rows in the matrix.
numColumns	the number of columns in the matrix.

Returns: the created matrix.

Definition at line 91 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ getDimension()

int umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.getDimension ( )

Assuming that each tally in this matrix has the same dimension, returns the dimension of tally (0, 0), or 0 if the matrix has no row or column.

Returns: the dimension.

Definition at line 205 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ numberObs()

int umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.numberObs ( )

Assuming that each tally in this matrix contains the same number of observations, returns the number of observations in tally (0, 0), or 0 if the matrix has no row or column.

Returns: the number of observations.

Definition at line 219 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ standardDeviation()

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.standardDeviation ( DoubleMatrix2D m )

For each tally in the matrix, computes the standard deviation, and stores it into the matrix m.

This is equivalent to calling variance(DoubleMatrix2D) and performing a square root on every element of the filled matrix.

Parameters

m	the matrix to be filled with standard deviations.

Exceptions

NullPointerException	if `m` is `null`.
IllegalArgumentException	if `m.rows()` does not correspond to umontreal.ssj.stat.matrix.MatrixOfStatProbes.rows, or m.columns() does not correspond to umontreal.ssj.stat.matrix.MatrixOfStatProbes.columns.

Definition at line 298 of file MatrixOfFunctionOfMultipleMeansTallies.java.

◆ variance()

void umontreal.ssj.stat.matrix.MatrixOfFunctionOfMultipleMeansTallies< E extends FunctionOfMultipleMeansTally >.variance ( DoubleMatrix2D m )

For each tally in the matrix, computes the sample variance, and stores it into the given matrix.

If, for some tally \((r, c)\), there are not enough observations for estimating the variance, Double.NaN is stored in the corresponding element of the given matrix m.

Parameters

m	the matrix to be filled with sample variances.

Exceptions

NullPointerException	if `m` is `null`.
IllegalArgumentException	if `m.rows()` does not correspond to umontreal.ssj.stat.matrix.MatrixOfStatProbes.rows, or m.columns() does not correspond to umontreal.ssj.stat.matrix.MatrixOfStatProbes.columns.

Definition at line 272 of file MatrixOfFunctionOfMultipleMeansTallies.java.

The documentation for this class was generated from the following file:

src/main/java/umontreal/ssj/stat/matrix/MatrixOfFunctionOfMultipleMeansTallies.java

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MatrixOfFunctionOfMultipleMeansTallies() [1/2]

◆ MatrixOfFunctionOfMultipleMeansTallies() [2/2]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addSameDimension()

◆ areAllNumberObsEqual()

◆ average()

◆ clone()

◆ create()

◆ getDimension()

◆ numberObs()

◆ standardDeviation()

◆ variance()