get_value_matrixT_get_value_matrixGetValueMatrixGetValueMatrixget_value_matrix (Operator)

Name

get_value_matrixT_get_value_matrixGetValueMatrixGetValueMatrixget_value_matrix — Return one ore more elements of a matrix.

Signature

get_value_matrix( : : MatrixID, Row, Column : Value)

Description

The operator get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix returns the values of one ore more elements of the Matrix as a tuple of floating point numbers. The Matrix is given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The row coordinates of the elements of the Matrix are determined by the tuple RowRowRowrowrow, the column coordinates by the tuple ColumnColumnColumncolumncolumn.

Example:

RowRowRowrowrow = [0,2,1], ColumnColumnColumncolumncolumn = [1,0,3]

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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

RowRowRowrowrow (input_control) integer(-array) → (integer)

Row numbers of matrix elements to be returned.

Default: 0

Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100

Restriction: Row >= 0

ColumnColumnColumncolumncolumn (input_control) integer(-array) → (integer)

Column numbers of matrix elements to be returned.

Default: 0

Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100

Restriction: Column >= 0

ValueValueValuevaluevalue (output_control) real(-array) → (real)

Values of indicated matrix elements.

Result

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