set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix (Operator)

Name

set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix — Set all values of a matrix.

Signature

Description

The operator set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix sets all elements of the input MatrixMatrixMatrixMatrixMatrixmatrix defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDMatrixIDmatrixID. 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_matrixCreateMatrixcreate_matrixCreateMatrixCreateMatrix. The advantage by using the operator set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix is to recycle a matrix that is no longer needed. Thus, the runtime of the operation takes fewer time.

Example 1:

           /   0.0   0.0   0.0  \
  Matrix = |   0.0   0.0   0.0  |     Values = [3,1,-2,-5,7,2,-9,-4,1]
           \   0.0   0.0   0.0  /

                /   3.0   1.0  -2.0  \
  ->   Matrix = |  -5.0   7.0   2.0  |
                \  -9.0  -4.0   1.0  /

Example 2:

           /   0.0   0.0   0.0  \
  Matrix = |   0.0   0.0   0.0  |     Values = [  7  ]
           \   0.0   0.0   0.0  /

                /  7.0   7.0   7.0  \
  ->   Matrix = |  7.0   7.0   7.0  |
                \  7.0   7.0   7.0  /

Attention

set_full_matrixset_full_matrixSetFullMatrixset_full_matrixSetFullMatrixSetFullMatrix modifies the content of an already existing matrix.

Parallelization

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

Parameters

Result

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

See also

get_full_matrixget_full_matrixGetFullMatrixget_full_matrixGetFullMatrixGetFullMatrix

Module

Foundation