ClassesClassesClassesClasses | | | | Operators

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix (Operator)

Name

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix — Return all values of a matrix.

Signature

get_full_matrix( : : MatrixID : Values)

Herror get_full_matrix(const Hlong MatrixID, double* Values)

Herror T_get_full_matrix(const Htuple MatrixID, Htuple* Values)

Herror get_full_matrix(const HTuple& MatrixID, double* Values)

Herror get_full_matrix(const HTuple& MatrixID, HTuple* Values)

HTuple HMatrix::GetFullMatrix() const

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

HTuple HMatrix::GetFullMatrix() const

void HOperatorSetX.GetFullMatrix(
[in] VARIANT MatrixID, [out] VARIANT* Values)

VARIANT HMatrixX.GetFullMatrix()

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

HTuple HMatrix.GetFullMatrix()

Description

The operator get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix returns the values of all elements of the MatrixMatrixMatrixMatrixMatrixmatrix given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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:

Parallelization

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control)  matrix HMatrix, HTupleHTupleHMatrix, HTupleHMatrixX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Matrix handle of the input matrix.

ValuesValuesValuesValuesValuesvalues (output_control)  real(-array) HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Values of the matrix elements.

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix

Possible Successors

clear_matrixclear_matrixClearMatrixclear_matrixClearMatrixClearMatrix

See also

set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators