NAG Library Routine Document

X03ABF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{A}\left(\mathbf{ISIZEA}\right)$ – COMPLEX (KIND=nag_wp) arrayInput

On entry: the elements of the first vector.

The $i$th vector element is stored in the array element $\mathbf{A}\left(\left(i-1\right)\times \mathbf{ISTEPA}+1\right)$. In your subroutine from which X03ABF is called, A can be part of a multidimensional array and the actual argument must be the array element containing the first vector element.

2:     $\mathrm{ISIZEA}$ – INTEGERInput

On entry: the dimension of the array A as declared in the (sub)program from which X03ABF is called.

The upper bound for ISIZEA is found by multiplying together the dimensions of A as declared in your subroutine from which X03ABF is called, subtracting the starting position and adding $1$.

Constraint: $\mathbf{ISIZEA}\ge \left(\mathbf{N}-1\right)\times \mathbf{ISTEPA}+1$.

3:     $\mathrm{B}\left(\mathbf{ISIZEB}\right)$ – COMPLEX (KIND=nag_wp) arrayInput

On entry: the elements of the second vector.

The $i$th vector element is stored in the array element $\mathbf{B}\left(\left(i-1\right)\times \mathbf{ISTEPB}+1\right)$. In your subroutine from which X03ABF is called, B can be part of a multidimensional array and the actual argument must be the array element containing the first vector element.

4:     $\mathrm{ISIZEB}$ – INTEGERInput

On entry: the dimension of the array B as declared in the (sub)program from which X03ABF is called.

The upper bound for ISIZEB is found by multiplying together the dimensions of B as declared in your subroutine from which X03ABF is called, subtracting the starting position and adding $1$.

Constraint: $\mathbf{ISIZEB}\ge \left(\mathbf{N}-1\right)\times \mathbf{ISTEPB}+1$.

5:     $\mathrm{N}$ – INTEGERInput

On entry: $n$, the number of elements in the scalar product.

6:     $\mathrm{ISTEPA}$ – INTEGERInput

On entry: the step length between elements of the first vector in array A.

Constraint: $\mathbf{ISTEPA}>0$.

7:     $\mathrm{ISTEPB}$ – INTEGERInput

On entry: the step length between elements of the second vector in array B.

Constraint: $\mathbf{ISTEPB}>0$.

8:     $\mathrm{CX}$ – COMPLEX (KIND=nag_wp)Input

On entry: the initial value $c$.

9:     $\mathrm{DX}$ – COMPLEX (KIND=nag_wp)Output

On exit: the result $d$.

10:   $\mathrm{SW}$ – LOGICALInput

On entry: the precision to be used in the calculation.

$\mathbf{SW}=\mathrm{.TRUE.}$

additional precision.

$\mathbf{SW}=\mathrm{.FALSE.}$

basic precision.

11:   $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.

On exit: $\mathbf{IFAIL}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

$\mathbf{IFAIL}=1$

On entry,	$\mathbf{ISTEPA}\le 0$,
or	$\mathbf{ISTEPB}\le 0$.

$\mathbf{IFAIL}=2$

On entry,	$\mathbf{ISIZEA}<\left(\mathbf{N}-1\right)\times \mathbf{ISTEPA}+1$,
or	$\mathbf{ISIZEB}<\left(\mathbf{N}-1\right)\times \mathbf{ISTEPB}+1$.

$\mathbf{IFAIL}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (x03abfe.f90)

10.2  Program Data

Program Data (x03abfe.d)

10.3  Program Results

Program Results (x03abfe.r)