set_full_matrixT_set_full_matrixSetFullMatrixSetFullMatrixset_full_matrix (Operator)

Name

set_full_matrixT_set_full_matrixSetFullMatrixSetFullMatrixset_full_matrix — Set all values of a matrix.

Signature

set_full_matrix( : : MatrixID, Values : )

Description

The operator set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrixset_full_matrix sets all elements of the input Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The values of the parameter ValuesValuesValuesValuesvaluesvalues can be a tuple of floating point or integer numbers. Integer numbers are converted to floating point numbers automatically. The parameter ValuesValuesValuesValuesvaluesvalues must contain all values in a row-major order, i.e., stored line by line. In addition, the number of elements in ValuesValuesValuesValuesvaluesvalues 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_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix. The advantage by using the operator set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrixset_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:

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id

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

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified) matrix → (handle)

Matrix handle of the input matrix.

ValuesValuesValuesValuesvaluesvalues (input_control) number(-array) → (real / integer)

Values to be set.

Result

If the parameters are valid, the operator set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrixset_full_matrix returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.