get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrixget_full_matrix (Operator)

Name

get_full_matrixT_get_full_matrixGetFullMatrixGetFullMatrixget_full_matrix — 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()

def get_full_matrix(matrix_id: HHandle) -> Sequence[float]

def get_full_matrix_s(matrix_id: HHandle) -> float

Description

The operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix returns the values of all elements of the MatrixMatrixMatrixMatrixmatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The output parameter ValuesValuesValuesValuesvaluesvalues 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

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

Matrix handle of the input matrix.

ValuesValuesValuesValuesvaluesvalues (output_control)  real(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Values of the matrix elements.

Result

If the parameters are valid, the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix returns the value TRUE. If necessary, an exception is raised.

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

clear_matrixclear_matrixClearMatrixClearMatrixClearMatrixclear_matrix

See also

set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrixset_full_matrix

Module

Foundation