get_size_matrixT_get_size_matrixGetSizeMatrixGetSizeMatrixget_size_matrix (Operator)
Name
get_size_matrixT_get_size_matrixGetSizeMatrixGetSizeMatrixget_size_matrix — Get the size of a matrix.
Signature
def get_size_matrix(matrix_id: HHandle) -> Tuple[int, int]
Description
The operator get_size_matrixget_size_matrixGetSizeMatrixGetSizeMatrixget_size_matrix returns the number of rows
RowsRowsRowsrowsrows and columns ColumnsColumnsColumnscolumnscolumns of the input
Matrix. The input Matrix is defined by the
matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id.
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 → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Matrix handle of the input matrix.
RowsRowsRowsrowsrows (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of rows of the matrix.
ColumnsColumnsColumnscolumnscolumns (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of columns of the matrix.
Result
If the parameters are valid, the operator get_size_matrixget_size_matrixGetSizeMatrixGetSizeMatrixget_size_matrix
returns the value 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix
Possible Successors
clear_matrixclear_matrixClearMatrixClearMatrixclear_matrix
Module
Foundation