repeat_matrixT_repeat_matrixRepeatMatrixRepeatMatrixrepeat_matrix (Operator)

Name

repeat_matrixT_repeat_matrixRepeatMatrixRepeatMatrixrepeat_matrix — Repeat a matrix.

Signature

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

Description

The operator repeat_matrixrepeat_matrixRepeatMatrixRepeatMatrixrepeat_matrix creates the new matrix MatrixRepeated and copies all elements of the input Matrix n times to this new matrix, where n = RowsRowsRowsrowsrows ColumnsColumnsColumnscolumnscolumns. The new matrix has dimensions RowsRowsRowsrowsrows rows of the input Matrix and ColumnsColumnsColumnscolumnscolumns columns of the input Matrix. The input Matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The operator returns the matrix handle MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedIDmatrix_repeated_id of the matrix MatrixRepeated. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix.

Example:

RowsRowsRowsrowsrows = 2, ColumnsColumnsColumnscolumnscolumns = 3

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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control) matrix → (handle)

Matrix handle of the input matrix.

RowsRowsRowsrowsrows (input_control) integer → (integer)

Number of copies of input matrix in row direction.

Default: 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: 2

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

Restriction: Columns >= 1

MatrixRepeatedIDMatrixRepeatedIDMatrixRepeatedIDmatrixRepeatedIDmatrix_repeated_id (output_control) matrix → (handle)

Matrix handle of the repeated copied matrix.

Result

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