naginterfaces.library.blas.zlantr

naginterfaces.library.blas.zlantr(norm, uplo, diag, m, a)

zlantr returns the value of the $1$-norm, the $\infty$-norm, the Frobenius norm, or the maximum absolute value of the elements of a complex $m\times n$ trapezoidal matrix (triangular if $m=n$).

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

https://support.nag.com/numeric/nl/nagdoc_30.1/flhtml/f06/f06ujf.html

Parameters

normstr, length 1

Specifies the value to be returned.

$norm=\text{'1'}$ or $\text{'O'}$

The $1$-norm.

$norm=\text{'I'}$

The $\infty$-norm.

$norm=\text{'F'}$ or $\text{'E'}$

The Frobenius (or Euclidean) norm.

$norm=\text{'M'}$

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

uplostr, length 1

Specifies whether $A$ is upper or lower trapezoidal.

$uplo=\text{'U'}$

$A$ is upper trapezoidal.

$uplo=\text{'L'}$

$A$ is lower trapezoidal.

diagstr, length 1

Specifies whether $A$ has nonunit or unit diagonal elements.

$diag=\text{'N'}$

The diagonal elements are stored explicitly.

$diag=\text{'U'}$

The diagonal elements are assumed to be $1$, and are not referenced.

mint

$m$, the number of rows of the matrix $A$.

When $m=0$, zlantr is set to zero.

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

The $m\times n$ trapezoidal matrix $A$.

Returns

nrmfloat

The value of the $1$-norm, the $\infty$-norm, the Frobenius norm, or the maximum absolute value of the elements of the complex $m\times n$ trapezoidal matrix (triangular if $m=n$).

Raises

NagValueError

(errno $1$)

On entry, error in parameter $norm$.

Constraint: $norm=\text{'1'}$, $\text{'O'}$, $\text{'I'}$, $\text{'F'}$, $\text{'E'}$ or $\text{'M'}$.

(errno $2$)

On entry, error in parameter $uplo$.

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

(errno $3$)

On entry, error in parameter $diag$.

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

(errno $4$)

On entry, error in parameter $m$.

Constraint: $m\ge 0$.

(errno $5$)

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

Constraint: $n\ge 0$.

Notes

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