set_value_matrix
— Set one or more elements of a matrix.
The operator set_value_matrix
sets the
values of the elements of the input Matrix
at the
positions (Row
,Column
) to the values specified by
Value
. 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 Value
must
match the number of elements of Row
and Column
. 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 MatrixID
.
Example:
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.
MatrixID
(input_control, state is modified) matrix →
(handle)
Matrix handle of the input matrix.
Row
(input_control) integer(-array) →
(integer)
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
Column
(input_control) integer(-array) →
(integer)
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
Value
(input_control) number(-array) →
(real / integer)
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_matrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Foundation