set_sub_matrix
— Set a sub-matrix of a matrix.
set_sub_matrix( : : MatrixID, MatrixSubID, Row, Column : )
The operator set_sub_matrix
overwrites a
part of the Matrix
with the matrix MatrixSub
.
The input matrices are defined by the matrix handles
MatrixID
and MatrixSubID
. The parameters
Row
and Column
determine the position of the upper
left corner of the sub-matrix MatrixSub
in
Matrix
.
Example:
The conditions 0 Row
< size of matrix
Matrix
in the row direction, Row
+ size of
matrix MatrixSub
in the row direction size
of matrix Matrix
in the row direction, 0
Column
< size of Matrix
in the column direction,
and Column
+ size of matrix MatrixSub
in the
columns direction size of Matrix
in the
column direction must be satisfied.
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.
MatrixID
(input_control, state is modified) matrix →
(handle)
Matrix handle of the input matrix.
MatrixSubID
(input_control) matrix →
(handle)
Matrix handle of the input sub-matrix.
Row
(input_control) integer →
(integer)
Upper row position of the sub-matrix in the matrix.
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 →
(integer)
Left column position of the sub-matrix in the matrix.
Default value: 0
Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 30, 50, 100
Restriction: Column >= 0
If the parameters are valid, the operator set_sub_matrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
get_full_matrix
,
get_value_matrix
Foundation