naginterfaces.library.matop.complex_​tri_​pack

naginterfaces.library.matop.complex_tri_pack(job, uplo, diag, a, b)

complex_tri_pack copies a complex triangular matrix stored in a packed one-dimensional array into an unpacked two-dimensional array, or vice versa.

For full information please refer to the NAG Library document for f01zb

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/f01/f01zbf.html

Parameters

jobstr, length 1

Specifies whether the triangular matrix is to be packed or unpacked.

$job=\text{'P'}$ (Pack)

The matrix is to be packed into array $b$.

$job=\text{'U'}$ (Unpack)

The matrix is to be unpacked into array $a$.

uplostr, length 1

Specifies the type of the matrix to be copied

$uplo=\text{'L'}$ (Lower)

The matrix is lower triangular. In this case the packed vector holds, or will hold on exit, the matrix elements in the following order: $(1,1),(2,1),\dots ,(n,1),(2,2),(3,2),\dots ,(n,2)$, etc..

$uplo=\text{'U'}$ (Upper)

The matrix is upper triangular. In this case the packed vector holds, or will hold on exit, the matrix elements in the following order: $(1,1)$, $(1,2)$, $(2,2)$, $(1,3)$, $(2,3)$, $(3,3)$, $(1,4)$, etc..

diagstr, length 1

Must specify whether the diagonal elements of the matrix are to be copied.

$diag=\text{'B'}$ (Blank)

The diagonal elements of the matrix are not referenced and not copied.

$diag=\text{'U'}$ (Unit diagonal)

The diagonal elements of the matrix are not referenced, but are assumed all to be unity, and are copied as such.

$diag=\text{'N'}$ (Non-unit diagonal)

The diagonal elements of the matrix are referenced and copied.

acomplex, array-like, shape $(n,n)$

If $job=\text{'P'}$, the leading $\text{n}$ by $\text{n}$ part of $a$ must contain the matrix to be copied, stored in unpacked form, in the upper or lower triangle depending on argument $uplo$. The opposite triangle of $a$ is not referenced and need not be assigned.

bcomplex, array-like, shape $\left((n\times (n+1))/2\right)$

If $job=\text{'U'}$, $b$ must contain the triangular matrix packed by column.

Returns

acomplex, ndarray, shape $(n,n)$

If $job=\text{'U'}$, the leading $\text{n}$ by $\text{n}$ part of array $a$ contains the copied matrix, stored in unpacked form, in the upper or lower triangle depending on argument $uplo$. The opposite triangle of $a$ is not referenced.

bcomplex, ndarray, shape $\left((n\times (n+1))/2\right)$

If $job=\text{'P'}$, $b$ contains the triangular matrix packed by column.

Note that $b$ must have space for the diagonal elements of the matrix, even if these are not stored.

Raises

NagValueError

(errno $1$)

On entry, $job\ne \text{'P'}$ or $\text{'U'}$: $job=⟨value⟩$.

(errno $2$)

On entry, $uplo\ne \text{'U'}$ or $\text{'L'}$: $uplo=⟨value⟩$.

(errno $3$)

On entry, $diag=⟨value⟩$.

Constraint: $diag=\text{'N'}$, $\text{'U'}$ or $\text{'B'}$.

(errno $4$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 1$.

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

complex_tri_pack unpacks a triangular matrix stored in a vector into a two-dimensional array, or packs a triangular matrix stored in a two-dimensional array into a vector. The matrix is packed by column. This function is intended for possible use in conjunction with functions from submodule blas, submodule lapacklin and submodule lapackeig, where some functions that use triangular matrices store them in the packed form described below.