ClassesClasses | | Operators

set_value_matrixset_value_matrixSetValueMatrixSetValueMatrix (Operator)


set_value_matrixset_value_matrixSetValueMatrixSetValueMatrix — Set one or more elements of a matrix.


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

Herror set_value_matrix(const Hlong MatrixID, const Hlong Row, const Hlong Column, double Value)

Herror T_set_value_matrix(const Htuple MatrixID, const Htuple Row, const Htuple Column, const Htuple Value)

void SetValueMatrix(const HTuple& MatrixID, const HTuple& Row, const HTuple& Column, const HTuple& Value)

void HMatrix::SetValueMatrix(const HTuple& Row, const HTuple& Column, const HTuple& Value) const

void HMatrix::SetValueMatrix(Hlong Row, Hlong Column, double Value) const

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

void HMatrix.SetValueMatrix(HTuple row, HTuple column, HTuple value)

void HMatrix.SetValueMatrix(int row, int column, double value)


The operator set_value_matrixset_value_matrixSetValueMatrixSetValueMatrixSetValueMatrix sets the values of the elements of the input MatrixMatrixMatrixMatrixmatrix at the positions (RowRowRowRowrow,ColumnColumnColumnColumncolumn) to the values specified by ValueValueValueValuevalue. The values can be a tuple of floating point or integer numbers. Integer numbers are converted to floating point numbers automatically. The number of values of ValueValueValueValuevalue must match the number of elements of RowRowRowRowrow and ColumnColumnColumnColumncolumn. In addition, the conditions 0 <= Row < size of MatrixMatrixMatrixMatrixmatrix in the row direction and 0 <= Column < size of MatrixMatrixMatrixMatrixmatrix in the column direction must be satisfied. The MatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID.


Execution Information

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.


MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified)  matrix HMatrix, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Matrix handle of the input matrix.

RowRowRowRowrow (input_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row numbers of the matrix elements to be modified.

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 the matrix elements to be modified.

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 (input_control)  number(-array) HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Values to be set in the indicated matrix elements.

Default value: 0

Suggested values: 0, 1, -1


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

Possible Predecessors


Possible Successors


See also




ClassesClasses | | Operators