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

get_size_matrix( : : MatrixID : Rows, Columns)

Herror T_get_size_matrix(const Htuple MatrixID, Htuple* Rows, Htuple* Columns)

void GetSizeMatrix(const HTuple& MatrixID, HTuple* Rows, HTuple* Columns)

void HMatrix::GetSizeMatrix(Hlong* Rows, Hlong* Columns) const

static void HOperatorSet.GetSizeMatrix(HTuple matrixID, out HTuple rows, out HTuple columns)

void HMatrix.GetSizeMatrix(out int rows, out int columns)

def get_size_matrix(matrix_id: HHandle) -> Tuple[int, int]

Description

The operator get_size_matrixget_size_matrixGetSizeMatrixGetSizeMatrixGetSizeMatrixget_size_matrix returns the number of rows RowsRowsRowsRowsrowsrows and columns ColumnsColumnsColumnsColumnscolumnscolumns of the input Matrix. The input Matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id.

Execution Information

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

RowsRowsRowsRowsrowsrows (output_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of rows of the matrix.

ColumnsColumnsColumnsColumnscolumnscolumns (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_matrixGetSizeMatrixGetSizeMatrixGetSizeMatrixget_size_matrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

clear_matrixclear_matrixClearMatrixClearMatrixClearMatrixclear_matrix

Module

Foundation