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)

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)

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

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

RowsRowsRowsRowsrows (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of rows of the matrix.

ColumnsColumnsColumnsColumnscolumns (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

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