f16 Chapter Contents
f16 Chapter Introduction
NAG C Library Manual

# NAG Library Function Documentnag_ztr_load (f16tgc)

## 1  Purpose

nag_ztr_load (f16tgc) initializes a complex triangular matrix.

## 2  Specification

 #include #include
 void nag_ztr_load (Nag_OrderType order, Nag_UploType uplo, Integer n, Complex alpha, Complex diag, Complex a[], Integer pda, NagError *fail)

## 3  Description

nag_ztr_load (f16tgc) forms the complex $n$ by $n$ triangular matrix $A$ given by

## 4  References

The BLAS Technical Forum Standard (2001) http://www.netlib.org/blas/blast-forum

## 5  Arguments

1:     orderNag_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 ${\mathbf{order}}=\mathrm{Nag_RowMajor}$. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.
Constraint: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or Nag_ColMajor.
2:     uploNag_UploTypeInput
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:     nIntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
4:     alphaComplexInput
On entry: the value, $\alpha$, to be assigned to the off-diagonal elements of $A$.
5:     diagComplexInput
On entry: the value, $d$, to be assigned to the diagonal elements of $A$.
6:     a[$\mathit{dim}$]ComplexOutput
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$ by $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:     pdaIntegerInput
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:     failNagError *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.
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)$.

Not applicable.

None.

## 9  Example

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

### 9.1  Program Text

Program Text (f16tgce.c)

### 9.2  Program Data

Program Data (f16tgce.d)

### 9.3  Program Results

Program Results (f16tgce.r)