MX_DSAGET – Set subarray of A into B

Block SymbolLicensing group: STANDARD

Function Description
Generally, the function block MX_DSAGET copies the subarray (submatrix) of matrix referenced by uA into the matrix referenced by uB.

The output references yA and yB are always set to the corresponding input references uA and uB. If HLD = on then nothing is copied otherwise the submatrix of matrix referenced by uA starting the row with zero based index I and the column with zero based index J containing M rows and N columns is copied (with respect to the value of the input uplo) to the matrix referenced by uB. The mentioned variables have the following meanings:

If the input $i \leq 0$ then I is set to $0$ else if $i \geq MA$ then I is set to $MA - 1$ else I is set to i, where MA is the number of rows of the matrix referenced by uA.
If the input $j \leq 0$ then J is set to $0$ else if $j \geq NA$ then J is set to $NA - 1$ else J is set to j, where NA is the number of columns of the matrix referenced by uA.
Number of copied rows M is set in two stages. First, M is set to minimum of $MA - I$ and number of rows of the matrix referenced by uB. Second, if $m > 0$ then M is set to the minimum of m and M.
Number of copied columns N is set in two stages. First, N is set to minimum of $NA - J$ and number of columns of the matrix referenced by uB. Second, if $n > 0$ then N is set to the minimum of n and N.

The error flag E is set to on if:

the reference uA or uB is not defined (i.e. input uA or uB is not connected),
uplo is less than 0 or greater than 3,
the number of elements of the matrix referenced by uB is less than $M * N$ .

Inputs

uA	Input reference to matrix A	Reference
uB	Input reference to matrix B	Reference
uplo	Part of the matrix to be copied	Long (I32)
	0 .... All 1 .... All 2 .... Upper 3 .... Lower
i	Index of the subarray first row	Long (I32)
j	Index of the subarray first column	Long (I32)
m	Number of matrix rows	Long (I32)
n	Number of matrix columns	Long (I32)
HLD	Hold	Bool

Outputs

yA	Output reference to matrix A	Reference
yB	Output reference to matrix B	Reference
E	Error indicator	Bool

[Previous] [Back to top] [Up] [Next]