NAG Library Function Document

nag_ztfttr (f01vhc)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

nag_ztfttr (f01vhc) unpacks a complex triangular matrix, stored in a Rectangular Full Packed (RFP) format array, to a full format array.

2
Specification

#include <nag.h>
#include <nagf01.h>
void  nag_ztfttr (Nag_OrderType order, Nag_RFP_Store transr, Nag_UploType uplo, Integer n, const Complex ar[], Complex a[], Integer pda, NagError *fail)

3
Description

nag_ztfttr (f01vhc) unpacks a complex n by n triangular matrix A, stored in RFP format to conventional storage in a full format array. This function is intended for possible use in conjunction with functions from Chapters f06, f07 and f16 where some functions that use triangular matrices store them in RFP format. The RFP storage format is described in Section 3.3.3 in the f07 Chapter Introduction.

4
References

Gustavson F G, Waśniewski J, Dongarra J J and Langou J (2010) Rectangular full packed format for Cholesky's algorithm: factorization, solution, and inversion ACM Trans. Math. Software 37, 2

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.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     transr Nag_RFP_StoreInput
On entry: specifies whether the normal RFP representation of A or its conjugate transpose is stored.
transr=Nag_RFP_Normal
The RFP representation of the matrix A is stored.
transr=Nag_RFP_ConjTrans
The conjugate transpose of the RFP representation of the matrix A is stored.
Constraint: transr=Nag_RFP_Normal or Nag_RFP_ConjTrans.
3:     uplo Nag_UploTypeInput
On entry: specifies whether A is upper or lower triangular.
uplo=Nag_Upper
A is upper triangular.
uplo=Nag_Lower
A is lower triangular.
Constraint: uplo=Nag_Upper or Nag_Lower.
4:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n0.
5:     ar[n×n+1/2] const ComplexInput
On entry: the upper or lower n by n triangular matrix A (as specified by uplo) in either normal or transposed RFP format (as specified by transr). The storage format is described in Section 3.3.3 in the f07 Chapter Introduction.
6:     a[dim] ComplexOutput
Note: the dimension, dim, of the array a must be at least pda×n.
On exit: the triangular matrix A.
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, A is upper triangular and the elements of the array below the diagonal are not set.
If uplo=Nag_Lower, A is lower triangular and the elements of the array above the diagonal are not set.
7:     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.
Constraint: pdamax1,n.
8:     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: n0.
NE_INT_2
On entry, pda=value and n=value.
Constraint: pdamax1,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.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
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.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_ztfttr (f01vhc) is not threaded in any implementation.

9
Further Comments

None.

10
Example

This example reads in a triangular matrix in RFP format and unpacks it to full format.

10.1
Program Text

Program Text (f01vhce.c)

10.2
Program Data

Program Data (f01vhce.d)

10.3
Program Results

Program Results (f01vhce.r)

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