NAG CL Interface
f16uac (zge_​norm)

Settings help

CL Name Style:


1 Purpose

f16uac calculates the value of the 1-norm, the -norm, the Frobenius norm or the maximum absolute value of the elements of a complex m×n matrix.

2 Specification

#include <nag.h>
void  f16uac (Nag_OrderType order, Nag_NormType norm, Integer m, Integer n, const Complex a[], Integer pda, double *r, NagError *fail)
The function may be called by the names: f16uac, nag_blast_zge_norm or nag_zge_norm.

3 Description

Given a complex m×n matrix, A, f16uac calculates one of the values given by
A1=maxji=1m|aij|,  
A=maxij= 1n|aij|,  
AF=(i=1mj=1n |aij|2)1/2  
or
maxi,j|aij|.  

4 References

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

5 Arguments

1: 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 order=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: order=Nag_RowMajor or Nag_ColMajor.
2: norm Nag_NormType Input
On entry: specifies the value to be returned.
norm=Nag_OneNorm
The 1-norm.
norm=Nag_InfNorm
The -norm.
norm=Nag_FrobeniusNorm
The Frobenius (or Euclidean) norm.
norm=Nag_MaxNorm
The value maxi,j|aij| (not a norm).
Constraint: norm=Nag_OneNorm, Nag_InfNorm, Nag_FrobeniusNorm or Nag_MaxNorm.
3: m Integer Input
On entry: m, the number of rows of the matrix A.
If m=0, r is set to zero.
Constraint: m0.
4: n Integer Input
On entry: n, the number of columns of the matrix A.
If n=0, r is set to zero.
Constraint: n0.
5: a[dim] const Complex Input
Note: the dimension, dim, of the array a must be at least
  • max(1,pda×n) when order=Nag_ColMajor;
  • max(1,m×pda) when order=Nag_RowMajor.
If order=Nag_ColMajor, Aij is stored in a[(j-1)×pda+i-1].
If order=Nag_RowMajor, Aij is stored in a[(i-1)×pda+j-1].
On entry: the m×n matrix A.
6: pda Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
  • if order=Nag_ColMajor, pdamax(1,m);
  • if order=Nag_RowMajor, pdan.
7: r double * Output
On exit: the value of the norm specified by norm.
8: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error 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 value had an illegal value.
NE_INT
On entry, m=value.
Constraint: m0.
On entry, n=value.
Constraint: n0.
NE_INT_2
On entry, pda=value, m=value.
Constraint: pdamax(1,m).
On entry, pda=value and n=value.
Constraint: pdan.
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.

7 Accuracy

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

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f16uac is not threaded in any implementation.

9 Further Comments

None.

10 Example

See Section 10 in f07auc and f08qyc.