set_full_matrix — Set all values of a matrix.
The operator set_full_matrix sets all
elements of the input Matrix defined by the matrix handle
MatrixID. The values of the parameter Values can
be a tuple of floating point or integer numbers. Integer numbers
are converted to floating point numbers automatically. The
parameter Values must contain all values in a row-major
order, i.e., stored line by line. In addition, the number of
elements in Values must be 1 or identical to the number of
all elements of the matrix.
Note: The same result can be reached with the operator
create_matrix. The advantage by using the operator
set_full_matrix is to recycle a matrix that is no longer
needed. Thus, the runtime of the operation takes fewer time.
Example 1:
Example 2:
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.
Values (input_control) number(-array) → (real / integer)
Values to be set.
If the parameters are valid, the operator set_full_matrix
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Foundation