# NAG CL Interfacef16rac (dge_​norm)

Settings help

CL Name Style:

## 1Purpose

f16rac calculates the value of the $1$-norm, the $\infty$-norm, the Frobenius norm, or the maximum absolute value of the elements of a real $m×n$ matrix.

## 2Specification

 #include
 void f16rac (Nag_OrderType order, Nag_NormType norm, Integer m, Integer n, const double a[], Integer pda, double *r, NagError *fail)
The function may be called by the names: f16rac, nag_blast_dge_norm or nag_dge_norm.

## 3Description

Given a real $m×n$ matrix, $A$, f16rac calculates one of the values given by
 $‖A‖1= maxj⁡ ∑ i=1 m |aij| ,$
 $‖A‖∞ = maxi⁡ ∑ j=1 n |aij| ,$
 $‖A‖F= ( ∑ i=1 m ∑ j=1 n |aij| 2 ) 1/2$
or
 $maxi,j|aij| .$

## 4References

Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001) Basic Linear Algebra Subprograms Technical (BLAST) Forum Standard University of Tennessee, Knoxville, Tennessee https://www.netlib.org/blas/blast-forum/blas-report.pdf

## 5Arguments

1: $\mathbf{order}$Nag_OrderType Input
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.1.3 in the Introduction to the NAG Library CL Interface 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_NormType Input
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 $\underset{i,j}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}|{a}_{ij}|$ (not a norm).
Constraint: ${\mathbf{norm}}=\mathrm{Nag_OneNorm}$, $\mathrm{Nag_InfNorm}$, $\mathrm{Nag_FrobeniusNorm}$ or $\mathrm{Nag_MaxNorm}$.
3: $\mathbf{m}$Integer Input
On entry: $m$, the number of rows of the matrix $A$.
If $m=0$, r is set to zero.
Constraint: ${\mathbf{m}}\ge 0$.
4: $\mathbf{n}$Integer Input
On entry: $n$, the number of columns of the matrix $A$.
If $n=0$, r is set to zero.
Constraint: ${\mathbf{n}}\ge 0$.
5: $\mathbf{a}\left[\mathit{dim}\right]$const double Input
Note: the dimension, dim, of the array a must be at least
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{pda}}×{\mathbf{n}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}×{\mathbf{pda}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
If ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(j-1\right)×{\mathbf{pda}}+i-1\right]$.
If ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(i-1\right)×{\mathbf{pda}}+j-1\right]$.
On entry: the $m×n$ matrix $A$.
6: $\mathbf{pda}$Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
• if ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$;
• if ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${\mathbf{pda}}\ge {\mathbf{n}}$.
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 7 in the Introduction to the NAG Library CL Interface).

## 6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.
NE_INT
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge 0$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 0$.
NE_INT_2
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$.
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}\ge {\mathbf{n}}$.
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.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

## 7Accuracy

The BLAS standard requires accurate implementations which avoid unnecessary over/underflow (see Section 2.7 of Basic Linear Algebra Subprograms Technical (BLAST) Forum (2001)).

## 8Parallelism and Performance

f16rac is not threaded in any implementation.

None.

## 10Example

See Section 10 in f07agc and f08qlc.