get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrix (Operator)

Name

get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrix — Return all values of a matrix.

Signature

get_full_matrix( : : MatrixID : Values)

Description

The operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix returns the values of all elements of the MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The output parameter ValuesValuesValuesValuesvalues 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

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (handle)

Matrix handle of the input matrix.

ValuesValuesValuesValuesvalues (output_control) real(-array) → (real)

Values of the matrix elements.

Result

If the parameters are valid, the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.