set_value_matrixT_set_value_matrixSetValueMatrixSetValueMatrixset_value_matrix (Operator)


set_value_matrixT_set_value_matrixSetValueMatrixSetValueMatrixset_value_matrix — Set one or more elements of a matrix.


set_value_matrix( : : MatrixID, Row, Column, 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)

def set_value_matrix(matrix_id: HHandle, row: MaybeSequence[int], column: MaybeSequence[int], value: MaybeSequence[Union[int, float]]) -> None


The operator set_value_matrixset_value_matrixSetValueMatrixSetValueMatrixSetValueMatrixset_value_matrix sets the values of the elements of the input Matrix at the positions (RowRowRowRowrowrow,ColumnColumnColumnColumncolumncolumn) to the values specified by ValueValueValueValuevaluevalue. 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 ValueValueValueValuevaluevalue must match the number of elements of RowRowRowRowrowrow and ColumnColumnColumnColumncolumncolumn. In addition, the conditions 0 <= Row < size of Matrix in the row direction and 0 <= Column < size of Matrix in the column direction must be satisfied. The Matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id.


Execution Information

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.


MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified)  matrix HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

RowRowRowRowrowrow (input_control)  integer(-array) HTupleMaybeSequence[int]HTupleHtuple (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

ColumnColumnColumnColumncolumncolumn (input_control)  integer(-array) HTupleMaybeSequence[int]HTupleHtuple (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

ValueValueValueValuevaluevalue (input_control)  number(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (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_matrixSetValueMatrixSetValueMatrixSetValueMatrixset_value_matrix returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors


Possible Successors


See also