nag_zhemm (f16zcc) (PDF version)
f16 Chapter Contents
f16 Chapter Introduction
NAG Library Manual

NAG Library Function Document

nag_zhemm (f16zcc)

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_zhemm (f16zcc) performs matrix-matrix multiplication for a complex Hermitian matrix.

2  Specification

#include <nag.h>
#include <nagf16.h>
void  nag_zhemm (Nag_OrderType order, Nag_SideType side, Nag_UploType uplo, Integer m, Integer n, Complex alpha, const Complex a[], Integer pda, const Complex b[], Integer pdb, Complex beta, Complex c[], Integer pdc, NagError *fail)

3  Description

nag_zhemm (f16zcc) performs one of the matrix-matrix operations
CαAB + βC   or   CαBA + βC ,  
where A is a complex Hermitian matrix, B and C are m by n complex matrices, and α and β are complex scalars.

4  References

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

5  Arguments

1:     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 order=Nag_RowMajor. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     side Nag_SideTypeInput
On entry: specifies whether B is operated on from the left or the right.
side=Nag_LeftSide
B is pre-multiplied from the left.
side=Nag_RightSide
B is post-multiplied from the right.
Constraint: side=Nag_LeftSide or Nag_RightSide.
3:     uplo Nag_UploTypeInput
On entry: specifies whether the upper or lower triangular part of A is stored.
uplo=Nag_Upper
The upper triangular part of A is stored.
uplo=Nag_Lower
The lower triangular part of A is stored.
Constraint: uplo=Nag_Upper or Nag_Lower.
4:     m IntegerInput
On entry: m, the number of rows of the matrices B and C; the order of A if side=Nag_LeftSide.
Constraint: m0.
5:     n IntegerInput
On entry: n, the number of columns of the matrices B and C; the order of A if side=Nag_RightSide.
Constraint: n0.
6:     alpha ComplexInput
On entry: the scalar α.
7:     a[dim] const ComplexInput
Note: the dimension, dim, of the array a must be at least
  • max1,pda×m when side=Nag_LeftSide;
  • max1,pda×n when side=Nag_RightSide.
On entry: the Hermitian matrix A; A is m by m if side=Nag_LeftSide, or n by n if side=Nag_RightSide.
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].
If uplo=Nag_Upper, the upper triangular part of A must be stored and the elements of the array below the diagonal are not referenced.
If uplo=Nag_Lower, the lower triangular part of A must be stored and the elements of the array above the diagonal are not referenced.
8:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) of the matrix A in the array a.
Constraints:
  • if side=Nag_LeftSide, pda max1,m ;
  • if side=Nag_RightSide, pda max1,n .
9:     b[dim] const ComplexInput
Note: the dimension, dim, of the array b must be at least
  • max1,pdb×n when order=Nag_ColMajor;
  • max1,m×pdb when order=Nag_RowMajor.
If order=Nag_ColMajor, Bij is stored in b[j-1×pdb+i-1].
If order=Nag_RowMajor, Bij is stored in b[i-1×pdb+j-1].
On entry: the m by n matrix B.
10:   pdb IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array b.
Constraints:
  • if order=Nag_ColMajor, pdbmax1,m;
  • if order=Nag_RowMajor, pdbmax1,n.
11:   beta ComplexInput
On entry: the scalar β.
12:   c[dim] ComplexInput/Output
Note: the dimension, dim, of the array c must be at least
  • max1,pdc×n when order=Nag_ColMajor;
  • max1,m×pdc when order=Nag_RowMajor.
If order=Nag_ColMajor, Cij is stored in c[j-1×pdc+i-1].
If order=Nag_RowMajor, Cij is stored in c[i-1×pdc+j-1].
On entry: the m by n matrix C.
If beta=0, c need not be set.
On exit: the updated matrix C.
13:   pdc IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array c.
Constraints:
  • if order=Nag_ColMajor, pdcmax1,m;
  • if order=Nag_RowMajor, pdcmax1,n.
14:   fail NagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_ENUM_INT_2
On entry, side=value, m=value, pda=value.
Constraint: if side=Nag_LeftSide, pda max1,m .
On entry, side=value, n=value, pda=value.
Constraint: if side=Nag_RightSide, pda max1,n .
NE_INT
On entry, m=value.
Constraint: m0.
On entry, n=value.
Constraint: n0.
NE_INT_2
On entry, pdb=value, m=value.
Constraint: pdbmax1,m.
On entry, pdb=value and n=value.
Constraint: pdbmax1,n.
On entry, pdc=value, m=value.
Constraint: pdcmax1,m.
On entry, pdc=value and n=value.
Constraint: pdcmax1,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.
An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction 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

Not applicable.

9  Further Comments

None.

10  Example

This example computes the matrix-matrix product
C=αAB+βC  
where
A = 1.0+0.0i 1.0+2.0i -2.0+3.0i 1.0-2.0i 2.0+0.0i 1.0+2.0i -2.0-3.0i 1.0-2.0i 3.0+0.0i ,  
B = 1.0-1.0i 1.0+2.0i -2.0+1.0i 2.0-2.0i 3.0-1.0i -3.0+1.0i ,  
C = -3.5-0.5i 1.5+2.0i -4.5+1.5i -2.0+3.5i -5.5+3.5i 3.0-1.5i ,  
α=1.0+0.0i   and   β=2.0+0.0i .  

10.1  Program Text

Program Text (f16zcce.c)

10.2  Program Data

Program Data (f16zcce.d)

10.3  Program Results

Program Results (f16zcce.r)


nag_zhemm (f16zcc) (PDF version)
f16 Chapter Contents
f16 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2015