NAG C Library Function Document

nag_sparse_herm_sort (f11zpc)

1
Purpose

nag_sparse_herm_sort (f11zpc) sorts the nonzero elements of a sparse complex Hermitian matrix, represented in symmetric coordinate storage format.

2
Specification

#include <nag.h>
#include <nagf11.h>
void  nag_sparse_herm_sort (Integer n, Integer *nnz, Complex a[], Integer irow[], Integer icol[], Nag_SparseSym_Dups dup, Nag_SparseSym_Zeros zero, Integer istr[], NagError *fail)

3
Description

nag_sparse_herm_sort (f11zpc) takes a symmetric coordinate storage (SCS) representation (see Section 2.1.2 in the f11 Chapter Introduction) of a sparse n by n complex Hermitian matrix A, and reorders the nonzero elements by increasing row index and increasing column index within each row. Entries with duplicate row and column indices may be removed. Alternatively, duplicate entries may be summed, which facilitates spare matrix addition (see Section 9). Any entries with zero values may optionally be removed.
nag_sparse_herm_sort (f11zpc) also returns a pointer array istr to the starting address of each row in A.

4
References

None.

5
Arguments

1:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n1.
2:     nnz Integer *Input/Output
On entry: the number of elements supplied in the array a.
Constraint: nnz0.
On exit: the number of elements with unique row and column indices.
3:     a[dim] ComplexInput/Output
Note: the dimension, dim, of the array a must be at least max1,nnz.
On entry: the nonzero elements of the lower triangular part of the complex matrix A. These may be in any order and there may be multiple nonzero elements with the same row and column indices.
On exit: the lower triangular nonzero elements ordered by increasing row index, and by increasing column index within each row. Each nonzero element has a unique row and column index.
4:     irow[dim] IntegerInput/Output
Note: the dimension, dim, of the array irow must be at least max1,nnz.
On entry: the row indices corresponding to the elements supplied in the array a.
Constraint: 1irow[i]n, for i=0,1,,nnz-1.
On exit: the first nnz elements contain the row indices corresponding to the elements returned in the array a.
5:     icol[dim] IntegerInput/Output
Note: the dimension, dim, of the array icol must be at least max1,nnz.
On entry: the column indices corresponding to the elements supplied in the array a.
Constraint: 1icol[i]irow[i], for i=0,1,,nnz-1.
On exit: the first nnz elements contain the column indices corresponding to the elements returned in the array a.
6:     dup Nag_SparseSym_DupsInput
On entry: indicates how elements in a with duplicate row and column indices are to be treated.
dup=Nag_SparseSym_RemoveDups
Duplicate entries are removed, only the first entry is kept.
dup=Nag_SparseSym_SumDups
The relevant values in a are summed.
dup=Nag_SparseSym_FailDups
The function fails with fail.code= NE_NON_ZERO_DUP on detecting a duplicate.
Constraint: dup=Nag_SparseSym_RemoveDups, Nag_SparseSym_SumDups or Nag_SparseSym_FailDups.
7:     zero Nag_SparseSym_ZerosInput
On entry: indicates how elements in a with zero values are to be treated.
zero=Nag_SparseSym_RemoveZeros
The entries are removed.
zero=Nag_SparseSym_KeepZeros
The entries are kept.
zero=Nag_SparseSym_FailZeros
The function fails with fail.code= NE_ZERO_COEFF on detecting a zero.
Constraint: zero=Nag_SparseSym_RemoveZeros, Nag_SparseSym_KeepZeros or Nag_SparseSym_FailZeros.
8:     istr[n+1] IntegerOutput
On exit: istr[i-1]-1, for i=1,2,,n, is the starting address in the arrays a, irow and icol of row i of the matrix A. istr[n]-1 is the address of the last element in a plus one.
9:     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 value had an illegal value.
NE_INT
On entry, n=value.
Constraint: n1.
On entry, nnz=value.
Constraint: nnz0.
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_INVALID_SCS
On entry, I=value, icol[I-1]=value and irow[I-1]=value.
Constraint: icol[I-1]1 and icol[I-1]irow[I-1].
On entry, i=value, irow[i-1]=value and n=value.
Constraint: irow[i-1]1 and irow[i-1]n.
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.
NE_NON_ZERO_DUP
On entry, a duplicate entry has been found in row I and column J: I=value, J=value.
NE_ZERO_COEFF
On entry, a zero entry has been found in row I and column J: I=value, J=value.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_sparse_herm_sort (f11zpc) is not threaded in any implementation.

9
Further Comments

The time taken for a call to nag_sparse_herm_sort (f11zpc) is the sum of two contributions, where one is proportional to nnz and the other is proportional to n.
Note that the resulting matrix may have either rows or columns with no entries. If row i has no entries then istr[i]=istr[i+1].
Two sparse matrices can be added by concatenating the three pairs of SCS format arrays, representing the two matrices, and passing these new arrays to nag_sparse_herm_sort (f11zpc), specifying that duplicates should be summed. This functionality is illustrated in Section 10 in nag_sparse_nsym_sort (f11zac).

10
Example

This example reads the SCS representation of a complex sparse Hermitian matrix A, calls nag_sparse_herm_sort (f11zpc) to reorder the nonzero elements, and outputs the original and the reordered representations.

10.1
Program Text

Program Text (f11zpce.c)

10.2
Program Data

Program Data (f11zpce.d)

10.3
Program Results

Program Results (f11zpce.r)