naginterfaces.library.blas.zhfrk

naginterfaces.library.blas.zhfrk(transr, uplo, trans, k, alpha, a, beta, c)

zhfrk performs one of the Hermitian rank-$k$ update operations

$$C\leftarrow \alpha A{A}^H+\beta C\text{or}C\leftarrow \alpha A^{H}A+\beta C\text{,}$$

where $A$ is a complex matrix, $C$ is an $n\times n$ complex Hermitian matrix stored in Rectangular Full Packed (RFP) format, and $\alpha$ and $\beta$ are real scalars.

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

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/f06/f06wqf.html

Parameters

transrstr, length 1

Specifies whether the normal RFP representation of $C$ or its conjugate transpose is stored.

$transr=\text{'N'}$

The matrix $C$ is stored in normal RFP format.

$transr=\text{'C'}$

The conjugate transpose of the RFP representation of the matrix $C$ is stored.

uplostr, length 1

Specifies whether the upper or lower triangular part of $C$ is stored in RFP format.

$uplo=\text{'U'}$

The upper triangular part of $C$ is stored in RFP format.

$uplo=\text{'L'}$

The lower triangular part of $C$ is stored in RFP format.

transstr, length 1

Specifies the operation to be performed.

$trans=\text{'N'}$

$C\leftarrow \alpha A{A}^H+\beta C$.

$trans=\text{'C'}$

$C\leftarrow \alpha A^{H}A+\beta C$.

kint

$k$, the number of columns of $A$ if $trans=\text{'N'}$, or the number of rows of $A$ if $trans=\text{'C'}$.

alphafloat

The scalar $\alpha$.

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

Note: the required extent for this argument in dimension 1 is determined as follows: if $trans=\text{'N'}$: $max(1,n)$; if $trans=\text{'C'}$: $max(1,k)$; otherwise: $1$.

Note: the required extent for this argument in dimension 2 is determined as follows: if $trans=\text{'N'}$: $max(1,k)$; if $trans=\text{'C'}$: $max(1,n)$; otherwise: $1$.

The matrix $A$; $A$ is $n\times k$ if $trans=\text{'N'}$, or $k\times n$ if $trans=\text{'C'}$. If $alpha=0.0$, $a$ is not referenced.

betafloat

The scalar $\beta$.

ccomplex, array-like, shape $(n\times (n+1)/2)$

The upper or lower triangular part (as specified by $uplo$) of the $n\times n$ Hermitian matrix $C$, stored in RFP format (as specified by $transr$). The storage format is described in detail in the F07 Introduction.

Returns

ccomplex, ndarray, shape $(n\times (n+1)/2)$

The updated matrix $C$, that is its upper or lower triangular part stored in RFP format.

Raises

NagValueError

(errno $1$)

On entry, error in parameter $transr$.

Constraint: $transr=\text{'N'}$ or $\text{'C'}$.

(errno $2$)

On entry, error in parameter $uplo$.

Constraint: $uplo=\text{'U'}$ or $\text{'L'}$.

(errno $3$)

On entry, error in parameter $trans$.

Constraint: $trans=\text{'N'}$ or $\text{'C'}$.

(errno $4$)

On entry, error in parameter $\text{n}$.

Constraint: $n\ge 0$.

(errno $5$)

On entry, error in parameter $k$.

Constraint: $k\ge 0$.

Notes

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

zhfrk performs one of the Hermitian rank-$k$ update operations

$$C\leftarrow \alpha A{A}^H+\beta C\text{or}C\leftarrow \alpha A^{H}A+\beta C\text{,}$$

where $A$ is a complex matrix, $C$ is an $n\times n$ complex Hermitian matrix stored in Rectangular Full Packed (RFP) format, and $\alpha$ and $\beta$ are real scalars. The RFP storage format is described in the F07 Introduction.

If $n=0$ or if $\beta =1.0$ and either $k=0$ or $\alpha =0.0$ then zhfrk returns immediately. If $\beta =0.0$ and either $k=0$ or $\alpha =0.0$ then $C$ is set to the zero matrix.

References

Gustavson, F G, Waśniewski, J, Dongarra, J J and Langou, J, 2010, Rectangular full packed format for Cholesky’s algorithm: factorization, solution, and inversion, ACM Trans. Math. Software (37, 2)