repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrix (Operator)

Name

repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrix — Repeat a matrix.

Signature

repeat_matrix( : : MatrixID, Rows, Columns : MatrixRepeatedID)

The operator repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixRepeatMatrix creates the new matrix MatrixRepeatedMatrixRepeatedMatrixRepeatedMatrixRepeatedmatrixRepeated and copies all elements of the input MatrixMatrixMatrixMatrixmatrix n times to this new matrix, where n = RowsRowsRowsRowsrows * ColumnsColumnsColumnsColumnscolumns. The new matrix has dimensions RowsRowsRowsRowsrows * rows of the input MatrixMatrixMatrixMatrixmatrix and ColumnsColumnsColumnsColumnscolumns * columns of the input MatrixMatrixMatrixMatrixmatrix. The input MatrixMatrixMatrixMatrixmatrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixID. The operator returns the matrix handle MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedID of the matrix MatrixRepeatedMatrixRepeatedMatrixRepeatedMatrixRepeatedmatrixRepeated. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrix.

Example:

Execution Information

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

Parameters

MatrixIDMatrixIDMatrixIDMatrixIDmatrixID (input_control) matrix → (integer)

Matrix handle of the input matrix.

RowsRowsRowsRowsrows (input_control) integer → (integer)

Number of copies of input matrix in row direction.

Default value: 2

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20

Restriction: Rows >= 1

ColumnsColumnsColumnsColumnscolumns (input_control) integer → (integer)

Number of copies of input matrix in column direction.

Default value: 2

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20

Restriction: Columns >= 1

MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedID (output_control) matrix → (integer)

Matrix handle of the repeated copied matrix.

Result

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