f16 Chapter Contents
f16 Chapter Introduction
NAG C Library Manual

# NAG Library Function Documentnag_zge_load (f16thc)

## 1  Purpose

nag_zge_load (f16thc) initializes a complex general matrix.

## 2  Specification

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

## 3  Description

nag_zge_load (f16thc) forms the complex $m$ by $n$ general 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:     mIntegerInput
On entry: $m$, the number of rows of the matrix $A$.
Constraint: ${\mathbf{m}}\ge 0$.
3:     nIntegerInput
On entry: $n$, the number of columns 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)$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}×{\mathbf{pda}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
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]$.
On exit: the $m$ by $n$ general matrix $A$ with diagonal elements set to diag and off-diagonal elements set to alpha.
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{m}}\right)$.
8:     failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

## 6  Error Indicators and Warnings

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

Not applicable.

None.

## 9  Example

This example initializes a $4$ by $3$ complex matrix $A$, setting diagonal elements $9.0+0.0i$ and off-diagonal elements to $0.5-0.3i$.

### 9.1  Program Text

Program Text (f16thce.c)

### 9.2  Program Data

Program Data (f16thce.d)

### 9.3  Program Results

Program Results (f16thce.r)