get_size_matrixT_get_size_matrixGetSizeMatrixGetSizeMatrix (Operator)

Name

get_size_matrixT_get_size_matrixGetSizeMatrixGetSizeMatrix — Get the size of a matrix.

Signature

get_size_matrix( : : MatrixID : Rows, Columns)

Description

The operator get_size_matrixget_size_matrixGetSizeMatrixGetSizeMatrixGetSizeMatrix returns the number of rows RowsRowsRowsRowsrows and columns ColumnsColumnsColumnsColumnscolumns of the input MatrixMatrixMatrixMatrixmatrix. The input MatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID.

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.

RowsRowsRowsRowsrows (output_control) integer → (integer)

Number of rows of the matrix.

ColumnsColumnsColumnsColumnscolumns (output_control) integer → (integer)

Number of columns of the matrix.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix

Module

Foundation

Operators