get_value_matrixT_get_value_matrixGetValueMatrixGetValueMatrix (Operator)

Name

get_value_matrixT_get_value_matrixGetValueMatrixGetValueMatrix — Return one ore more elements of a matrix.

Signature

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

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

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

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_matrixGetValueMatrixGetValueMatrixGetValueMatrix returns the values of one ore more elements of the MatrixMatrixMatrixMatrixmatrix as a tuple of floating point numbers. The MatrixMatrixMatrixMatrixmatrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The row coordinates of the elements of the MatrixMatrixMatrixMatrixmatrix are determined by the tuple RowRowRowRowrow, the column coordinates by the tuple ColumnColumnColumnColumncolumn.

Example:

Execution Information

Parameters

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

Matrix handle of the input matrix.

RowRowRowRowrow (input_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (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

ColumnColumnColumnColumncolumn (input_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (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

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

Values of indicated matrix elements.

Result

If the parameters are valid, the operator get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrix 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_value_matrixset_value_matrixSetValueMatrixSetValueMatrixSetValueMatrix

Module

Foundation