NAG C Library Function Document

nag_dtr_load (f16qgc)

1
Purpose

nag_dtr_load (f16qgc) initializes a real triangular matrix.

2
Specification

#include <nag.h>
#include <nagf16.h>
void  nag_dtr_load (Nag_OrderType order, Nag_UploType uplo, Integer n, double alpha, double diag, double a[], Integer pda, NagError *fail)

3
Description

nag_dtr_load (f16qgc) forms the real n by n triangular matrix A given by
aij= d if i=j α if ij .  

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.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:     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.
3:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n0.
4:     alpha doubleInput
On entry: the value, α, to be assigned to the off-diagonal elements of A.
5:     diag doubleInput
On entry: the value, d, to be assigned to the diagonal elements of A.
6:     a[dim] doubleOutput
Note: the dimension, dim, of the array a must be at least max1,pda×n.
On exit: the n by n 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 corresponding to the lower triangular part of A are not referenced.
  • If uplo=Nag_Lower, A is lower triangular and the elements of the array corresponding to the upper triangular part of A are not referenced.
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, n=value.
Constraint: pdamax1,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.

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

nag_dtr_load (f16qgc) is not threaded in any implementation.

9
Further Comments

None.

10
Example

This example initializes the lower triangular matrix A with diagonal elements given by d=3.45 and off-diagonal elements given by α=1.23.

10.1
Program Text

Program Text (f16qgce.c)

10.2
Program Data

Program Data (f16qgce.d)

10.3
Program Results

Program Results (f16qgce.r)