ClassesClassesClassesClasses | | | | Operators

get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix (Operator)

Name

get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix — Return one ore more elements of a matrix.

Signature

get_value_matrix( : : MatrixID, Row, Column : Value)

Herror get_value_matrix(const Hlong MatrixID, const Hlong Row, const Hlong Column, double* Value)

Herror T_get_value_matrix(const Htuple MatrixID, const Htuple Row, const Htuple Column, Htuple* Value)

Herror get_value_matrix(const HTuple& MatrixID, const HTuple& Row, const HTuple& Column, double* Value)

Herror get_value_matrix(const HTuple& MatrixID, const HTuple& Row, const HTuple& Column, HTuple* Value)

HTuple HMatrix::GetValueMatrix(const HTuple& Row, const HTuple& Column) const

void GetValueMatrix(const HTuple& MatrixID, const HTuple& Row, const HTuple& Column, HTuple* Value)

HTuple HMatrix::GetValueMatrix(const HTuple& Row, const HTuple& Column) const

double HMatrix::GetValueMatrix(Hlong Row, Hlong Column) const

void HOperatorSetX.GetValueMatrix(
[in] VARIANT MatrixID, [in] VARIANT Row, [in] VARIANT Column, [out] VARIANT* Value)

VARIANT HMatrixX.GetValueMatrix(
[in] VARIANT Row, [in] VARIANT Column)

static void HOperatorSet.GetValueMatrix(HTuple matrixID, HTuple row, HTuple column, out HTuple value)

HTuple HMatrix.GetValueMatrix(HTuple row, HTuple column)

double HMatrix.GetValueMatrix(int row, int column)

Description

The operator get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix returns the values of one ore more elements of the MatrixMatrixMatrixMatrixMatrixmatrix as a tuple of floating point numbers. The MatrixMatrixMatrixMatrixMatrixmatrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The row coordinates of the elements of the MatrixMatrixMatrixMatrixMatrixmatrix are determined by the tuple RowRowRowRowRowrow, the column coordinates by the tuple ColumnColumnColumnColumnColumncolumn.

Example:

Parallelization

Parameters

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

Matrix handle of the input matrix.

RowRowRowRowRowrow (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Row numbers of matrix elements to be returned.

Default value: 0

Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100

Restriction: Row >= 0

ColumnColumnColumnColumnColumncolumn (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Column numbers of matrix elements to be returned.

Default value: 0

Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100

Restriction: Column >= 0

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

Values of indicated matrix elements.

Result

If the parameters are valid, the operator get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix 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_value_matrixset_value_matrixSetValueMatrixset_value_matrixSetValueMatrixSetValueMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators