Matrix Object

The Matrix object provides numerous properties and methods for calculating various matrix statistics and decompositions. FreeFlyer also supports a variety of matrix operations. These features enable users to perform many analyses in FreeFlyer, without needing to interface with external programs to execute complex calculations. You can assign Matrix objects using the = operator. See the Matrix, Array, and Variable Math Script Reference for more information.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Signatures	Description
Matrix()	Create a 0x0 matrix.
Matrix(Variable rows, Variable columns)	Create a m x n matrix.

Name	Description	Attributes
ColumnCount	The number of columns in the matrix.	Type: Variable Access: Read/Write
ColumnWise	An interface for column-wise operations.	Type: VirtualMatrixColumnWise Access: Read-Only
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Diagonal	The diagonal elements of the matrix.	Type: Array Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
RowCount	The number of rows in the matrix.	Type: Variable Access: Read/Write
RowWise	An interface for row-wise operations.	Type: VirtualMatrixRowWise Access: Read-Only

Name	Description
CholeskyDecomposition	Decomposes the matrix A into a triangular form L such that LL.Transpose() = A, or a triangular form L, a permutation matrix P, and a diagonal matrix D such that P^TLDL^T*P = A. The version used depends on the overload chosen. By default, L will be a lower triangle form, unless an upper triangle form is specified.
ClearSavedStates	Clears previous saved states for this object.
ConditionNumber	Computes the condition number of the matrix.
CrossProduct	Computes the cross product with the specified vector.
Determinant	Calculates the determinant of the matrix. If the matrix is not square, an error is thrown.
DotProduct	Computes the dot product with the specified vector.
EigenDecomposition	Decomposes the matrix as M = V D V^-1 where the columns of V are the eigen vectors of M and the D is a diagonal matrix where the diagonal elements are the eigen values of M. If the matrix is not diagonizable an error is thrown.
Fill	Loads the specified value into each element of the matrix.
FillDiagonal	Loads the specifed value into the diagonal elements of the matrix and zero into all other elements. If the matrix is not square, an error will be thrown.
FillRandom	Loads the matrix with uniform random values.
Format	Converts the numeric values contained within the calling Matrix into a string based on the format specifiers given by formatString. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The Format method converts a double precision floating point value to a string; the IFormat method should be used to convert an integer value to a string. By default, columns are delimited with spaces, and rows will be delimited with a newline.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
IFormat	Converts the numeric values contained within the calling Matrix into a string based on the format specifiers given by formatString. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The IFormat method converts an integer value to a string; the Format method should be used to convert a double precision floating point value to a string. By default, columns are delimited with spaces, and rows are delimited with a newline.
Inverse	Calculates the inverse of the matrix.
IsEqualTo	Determines if two matrices are equal.
IsIndefinite	Determines if the matrix is indefinite.
IsInvertible	Determines if the matrix inverse can be calculated.
IsNegativeDefinite	Determines if the matrix is negative definite.
IsNegativeSemiDefinite	Determines if the matrix is negative semi-definite.
IsNull	Determines if the matrix contains only zeros.
IsPositiveDefinite	Determines if the matrix is positive definite.
IsPositiveSemiDefinite	Determines if the matrix is positive semi-definite.
IsSymmetric	Determines if the matrix is symmetric.
Kurtosis	Calculates the kurtosis of the matrix elements.
LUDecomposition	Decomposes the matrix into lower and upper triangular matrices. If the decomposition cannot be performed an error is thrown.
Max	Calculates the maximum of the matrix elements.
Mean	Calculates the mean of the matrix elements.
Median	Calculates the median of the matrix elements.
Min	Calculates the minimum value of the matrix elements.
Norm	Computes the norm of the matrix.
Normalized	Computes the matrix divided by its Frobenius norm.
PolynomialFit	Uses Singular Value Decomposition to compute the coefficients of a polynomial to best fit the data set defined by the nx2 calling matrix.
PolynomialRoots	Treats the matrix of numbers as the coefficients of a polynomial wherein the coefficients are arranged from highest to lowest degree. The degree of the polynomial must be between 1 and 100. Returns the real roots of the polynomial.
PseudoInverse	Calculates the Moore-Penrose pseudoinverse of the matrix.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
QRDecomposition	Decomposes matrix A into matrices Q and R such that A = QR by using Householder transformations. Here, Q is a unitary matrix and R is an upper triangular matrix.
Rank	Calculates the rank of the matrix.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Repeat	Returns a matrix consisting of the specified value repeated the specified number of times.
Resize	Resizes the matrix dimensions.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SingularValueDecomposition	Decomposes any n x m matrix A such that A = USV.Transpose() where U is an n x n unitary matrix, V is an m x m unitary matrix, and S is an n x m matrix with the singular values of A on the main diagonal.
Skewness	Calculates the skewness of the matrix elements.
Solve	Solve the system of linear equations written 'A * x = b' where A and b are matrices for the vector x.
Sort	Sorts the matrix in the order of the columns specified. Example: matrix.Sort({0, 1, 2}, {1, -1, 1}) sorts by the first column ascending, then the second descending, then the third ascending. When FreeFlyer sorts by the column the rows will remain grouped during the sorting. If there are two numbers in the column with the same value, then FreeFlyer will keep the rows grouped and sort by the value of the next column.
StandardDeviation	Calculates the standard deviation of the matrix elements.
Sum	Calculates the sum of the matrix elements.
ToArrayColumnMajor	Returns an array containing each of the matrix columns concatenated together.
ToArrayRowMajor	Returns an array containing each of the matrix rows concatenated together.
Trace	Calculates the trace of the matrix. If the matrix isn't square an error is thrown.
Transpose	Returns a matrix containing the transpose of the calling matrix.
VertexAngle	Returns the angle in degrees between two 3-element vectors.

Matrix Object

Description

Available In Editions:

Timing Precision Mode