NAG Library Function Document

nag_zhf_norm (f16ukc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{order}$ – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.

Constraint: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

2:    $\mathbf{norm}$ – Nag_NormTypeInput

On entry: specifies the value to be returned.

$\mathbf{norm}=\mathrm{Nag\_OneNorm}$

The $1$-norm.

$\mathbf{norm}=\mathrm{Nag\_InfNorm}$

The $\infty$-norm.

$\mathbf{norm}=\mathrm{Nag\_FrobeniusNorm}$

The Frobenius (or Euclidean) norm.

$\mathbf{norm}=\mathrm{Nag\_MaxNorm}$

The value ${\displaystyle \underset{i,j}{\max }}\left|a_{ij}\right|$ (not a norm).

Constraint: $\mathbf{norm}=\mathrm{Nag\_OneNorm}$, $\mathrm{Nag\_InfNorm}$, $\mathrm{Nag\_FrobeniusNorm}$ or $\mathrm{Nag\_MaxNorm}$.

3:    $\mathbf{transr}$ – Nag_RFP_StoreInput

On entry: specifies whether the normal RFP representation of $A$ or its conjugate transpose is stored.

$\mathbf{transr}=\mathrm{Nag\_RFP\_Normal}$

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

$\mathbf{transr}=\mathrm{Nag\_RFP\_ConjTrans}$

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

Constraint: $\mathbf{transr}=\mathrm{Nag\_RFP\_Normal}$ or $\mathrm{Nag\_RFP\_ConjTrans}$.

4:    $\mathbf{uplo}$ – Nag_UploTypeInput

On entry: specifies whether the upper or lower triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Upper}$

The upper triangular part of $A$ is stored.

$\mathbf{uplo}=\mathrm{Nag\_Lower}$

The lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\mathrm{Nag\_Upper}$ or $\mathrm{Nag\_Lower}$.

5:    $\mathbf{n}$ – IntegerInput

On entry: $n$, the order of the matrix $A$.

If $n=0$, nag_zhf_norm (f16ukc) returns immediately.

Constraint: $\mathbf{n}\ge 0$.

6:    $\mathbf{ar}\left[\mathbf{n}\times \left(\mathbf{n}+1\right)/2\right]$ – const ComplexInput

On entry: the upper or lower triangular part (as specified by uplo) of the $n$ by $n$ Hermitian matrix $A$, in either normal or transposed RFP format (as specified by transr). The storage format is described in detail in Section 3.3.3 in the f07 Chapter Introduction.

7:    $\mathbf{r}$ – double *Output

On exit: the value of the norm specified by norm.

8:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_INT

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f16ukce.c)

10.2

Program Data

Program Data (f16ukce.d)

10.3

Program Results

Program Results (f16ukce.r)