ClassesClassesClassesClasses | | | | Operators

set_value_matrixset_value_matrixSetValueMatrixset_value_matrixSetValueMatrixSetValueMatrix (Operator)

Name

set_value_matrixset_value_matrixSetValueMatrixset_value_matrixSetValueMatrixSetValueMatrix — Set one or more elements of a matrix.

Signature

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)

Herror set_value_matrix(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 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

void HOperatorSetX.SetValueMatrix(
[in] VARIANT MatrixID, [in] VARIANT Row, [in] VARIANT Column, [in] VARIANT Value)

void HMatrixX.SetValueMatrix(
[in] VARIANT Row, [in] VARIANT Column, [in] VARIANT Value)

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)

Description

The operator set_value_matrixset_value_matrixSetValueMatrixset_value_matrixSetValueMatrixSetValueMatrix sets the values of the elements of the input MatrixMatrixMatrixMatrixMatrixmatrix 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 MatrixMatrixMatrixMatrixMatrixmatrix in the row direction and 0 <= Column < size of MatrixMatrixMatrixMatrixMatrixmatrix in the column direction must be satisfied. The MatrixMatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID.

Example:

Parallelization

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.

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control, state is modified)  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 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) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (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) HTupleHTupleHTupleVARIANTHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong) (double / Hlong) (double / Hlong)

Values to be set in the indicated matrix elements.

Default value: 0

Suggested values: 0, 1, -1

Result

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

get_value_matrixget_value_matrixGetValueMatrixget_value_matrixGetValueMatrixGetValueMatrix

Module

Foundation


ClassesClassesClassesClasses | | | | Operators