create_matrixcreate_matrixCreateMatrixCreateMatrix (Operator)

Name

create_matrixcreate_matrixCreateMatrixCreateMatrix — Create a matrix.

Signature

Description

The operator create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrix creates a new MatrixMatrixMatrixMatrixmatrix with RowsRowsRowsRowsrows rows and ColumnsColumnsColumnsColumnscolumns columns and returns the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix. The parameter ValueValueValueValuevalue is a string or a tuple of floating point or integer numbers. Integer numbers are converted to floating point numbers automatically.

If ValueValueValueValuevalue = 'identity'"identity""identity""identity""identity", RowsRowsRowsRowsrows and ColumnsColumnsColumnsColumnscolumns must have the identical values and an identity matrix is created.

Example:

  Rows = 3      Columns = 3      Value = 'identity'

If the parameter ValueValueValueValuevalue contains a single value, all elements of the matrix are filled with this value.

Example:

  Rows = 3      Columns = 3      Value = 7

If ValueValueValueValuevalue contains as many values as the main diagonal, all elements of the main diagonal are set to the values of the parameter ValueValueValueValuevalue (i.e., the number of elements in ValueValueValueValuevalue is identical).

Example:

  Rows = 3      Columns = 4      Value = [3, 7, 1]

It is also possible to set all elements of the matrix with different values. In this case the parameter ValueValueValueValuevalue must contain all values in a row-major order, i.e., stored line by line. In addition, the number of elements of ValueValueValueValuevalue must be identical to the number of all elements of the matrix, i.e., RowsRowsRowsRowsrows * ColumnsColumnsColumnsColumnscolumns.

Example:

  Rows = 3      Columns = 3      Value = [3,1,-2,-5,7,2,-9,-4,1]

It should be noted that in the examples there are differences in the meaning of the values of the output matrices: If a value is shown as an integer number, e.g., 0 or 1, the value of this element is per definition this certain value. If the number is shown as a floating point number, e.g., 0.0 or 1.0, the value is computed by the operator.

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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

Result

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

Possible Successors

set_full_matrixset_full_matrixSetFullMatrixSetFullMatrixSetFullMatrix, clear_matrixclear_matrixClearMatrixClearMatrixClearMatrix

Module

Foundation