ClassesClasses | | Operators

get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrix (Operator)

Name

get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrix — Return all values of a matrix.

Signature

get_full_matrix( : : MatrixID : Values)

Herror T_get_full_matrix(const Htuple MatrixID, Htuple* Values)

void GetFullMatrix(const HTuple& MatrixID, HTuple* Values)

HTuple HMatrix::GetFullMatrix() const

static void HOperatorSet.GetFullMatrix(HTuple matrixID, out HTuple values)

HTuple HMatrix.GetFullMatrix()

Description

The operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix returns the values of all elements of the MatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The output parameter ValuesValuesValuesValuesvalues is a tuple of floating point numbers and contains all values in a row-major order, i.e., line by line.

Example:

Execution Information

Parameters

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

Matrix handle of the input matrix.

ValuesValuesValuesValuesvalues (output_control)  real(-array) HTupleHTupleHtuple (real) (double) (double) (double)

Values of the matrix elements.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix

Possible Successors

clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix

See also

set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrix

Module

Foundation


ClassesClasses | | Operators