NAG CL Interfacef16tgc (ztr_​load)

Settings help

CL Name Style:

1Purpose

f16tgc initializes a complex triangular matrix.

2Specification

 #include
 void f16tgc (Nag_OrderType order, Nag_UploType uplo, Integer n, Complex alpha, Complex diag, Complex a[], Integer pda, NagError *fail)
The function may be called by the names: f16tgc, nag_blast_ztr_load or nag_ztr_load.

3Description

f16tgc forms the complex $n×n$ triangular matrix $A$ given by

4References

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

5Arguments

1: $\mathbf{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 ${\mathbf{order}}=\mathrm{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: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or $\mathrm{Nag_ColMajor}$.
2: $\mathbf{uplo}$Nag_UploType Input
On entry: specifies whether the upper or lower triangular part of $A$ is stored.
${\mathbf{uplo}}=\mathrm{Nag_Upper}$
The upper triangular part of $A$ is stored.
${\mathbf{uplo}}=\mathrm{Nag_Lower}$
The lower triangular part of $A$ is stored.
Constraint: ${\mathbf{uplo}}=\mathrm{Nag_Upper}$ or $\mathrm{Nag_Lower}$.
3: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
4: $\mathbf{alpha}$Complex Input
On entry: the value, $\alpha$, to be assigned to the off-diagonal elements of $A$.
5: $\mathbf{diag}$Complex Input
On entry: the value, $d$, to be assigned to the diagonal elements of $A$.
6: $\mathbf{a}\left[\mathit{dim}\right]$Complex Output
Note: the dimension, dim, of the array a must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{pda}}×{\mathbf{n}}\right)$.
On exit: the $n×n$ triangular matrix $A$ with diagonal elements set to diag and strictly upper or lower elements set to alpha.
If ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(j-1\right)×{\mathbf{pda}}+i-1\right]$.
If ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${A}_{ij}$ is stored in ${\mathbf{a}}\left[\left(i-1\right)×{\mathbf{pda}}+j-1\right]$.
• If ${\mathbf{uplo}}=\mathrm{Nag_Upper}$, $A$ is upper triangular and the elements of the array corresponding to the lower triangular part of $A$ are not referenced.
• If ${\mathbf{uplo}}=\mathrm{Nag_Lower}$, $A$ is lower triangular and the elements of the array corresponding to the upper triangular part of $A$ are not referenced.
7: $\mathbf{pda}$Integer Input
On entry: the stride separating row or column elements (depending on the value of order) of the matrix $A$ in the array a.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
8: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6Error 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 $⟨\mathit{\text{value}}⟩$ had an illegal value.
NE_INT
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 0$.
NE_INT_2
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
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.

7Accuracy

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

8Parallelism and Performance

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

None.

10Example

This example initializes a $4×4$ lower triangular matrix $A$, setting diagonal elements to $9.0+0.0i$ and strictly lower elements to $0.5-0.3i$.

10.1Program Text

Program Text (f16tgce.c)

10.2Program Data

Program Data (f16tgce.d)

10.3Program Results

Program Results (f16tgce.r)