get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrixget_full_matrix (Operator)

Name

get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrixget_full_matrix — Return all values of a matrix.

Signature

get_full_matrix( : : MatrixID : Values)

Description

The operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix returns the values of all elements of the MatrixMatrixMatrixMatrixmatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The output parameter ValuesValuesValuesValuesvaluesvalues is a tuple of floating point numbers and contains all values in a row-major order, i.e., line by line.

Example:

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

ValuesValuesValuesValuesvaluesvalues (output_control) real(-array) → (real)

Values of the matrix elements.

Result

If the parameters are valid, the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix returns the value TRUE. If necessary, an exception is raised.