C02 Chapter Contents
C02 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentC02AFF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

C02AFF finds all the roots of a complex polynomial equation, using a variant of Laguerre's method.

## 2  Specification

 SUBROUTINE C02AFF ( A, N, SCAL, Z, W, IFAIL)
 INTEGER N, IFAIL REAL (KIND=nag_wp) A(2,N+1), Z(2,N), W(4*(N+1)) LOGICAL SCAL

## 3  Description

C02AFF attempts to find all the roots of the $n$th degree complex polynomial equation
 $Pz = a0 zn + a1 zn-1 + a2 zn-2 + ⋯ + an-1 z + an = 0 .$
The roots are located using a modified form of Laguerre's method, originally proposed by Smith (1967).
The method of Laguerre (see Wilkinson (1965)) can be described by the iterative scheme
 $Lzk = zk+1 - zk = -n P zk P′ zk ± Hzk ,$
where $H\left({z}_{k}\right)=\left(n-1\right)\left[\left(n-1\right){\left({P}^{\prime }\left({z}_{k}\right)\right)}^{2}-nP\left({z}_{k}\right){P}^{\prime \prime }\left({z}_{k}\right)\right]$ and ${z}_{0}$ is specified.
The sign in the denominator is chosen so that the modulus of the Laguerre step at ${z}_{k}$, viz. $\left|L\left({z}_{k}\right)\right|$, is as small as possible. The method can be shown to be cubically convergent for isolated roots (real or complex) and linearly convergent for multiple roots.
The routine generates a sequence of iterates ${z}_{1},{z}_{2},{z}_{3},\dots \text{}$, such that $\left|P\left({z}_{k+1}\right)\right|<\left|P\left({z}_{k}\right)\right|$ and ensures that ${z}_{k+1}+L\left({z}_{k+1}\right)$ ‘roughly’ lies inside a circular region of radius $\left|F\right|$ about ${z}_{k}$ known to contain a zero of $P\left(z\right)$; that is, $\left|L\left({z}_{k+1}\right)\right|\le \left|F\right|$, where $F$ denotes the Fejér bound (see Marden (1966)) at the point ${z}_{k}$. Following Smith (1967), $F$ is taken to be $\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(B,1.445nR\right)$, where $B$ is an upper bound for the magnitude of the smallest zero given by
 $B = 1.0001 × min n L zk ,r1, an / a0 1/n ,$
${r}_{1}$ is the zero $X$ of smaller magnitude of the quadratic equation
 $P′′ zk 2 n n-1 X2 + P′ zk n X + 12 Pzk = 0$
and the Cauchy lower bound $R$ for the smallest zero is computed (using Newton's Method) as the positive root of the polynomial equation
 $a0 zn + a1 zn-1 + a2 zn-2 +⋯+ an-1 z - an = 0 .$
Starting from the origin, successive iterates are generated according to the rule ${z}_{k+1}={z}_{k}+L\left({z}_{k}\right)$, for $k=1,2,3,\dots \text{}$, and $L\left({z}_{k}\right)$ is ‘adjusted’ so that $\left|P\left({z}_{k+1}\right)\right|<\left|P\left({z}_{k}\right)\right|$ and $\left|L\left({z}_{k+1}\right)\right|\le \left|F\right|$. The iterative procedure terminates if $P\left({z}_{k+1}\right)$ is smaller in absolute value than the bound on the rounding error in $P\left({z}_{k+1}\right)$ and the current iterate ${z}_{p}={z}_{k+1}$ is taken to be a zero of $P\left(z\right)$. The deflated polynomial $\stackrel{~}{P}\left(z\right)=P\left(z\right)/\left(z-{z}_{p}\right)$ of degree $n-1$ is then formed, and the above procedure is repeated on the deflated polynomial until $n<3$, whereupon the remaining roots are obtained via the ‘standard’ closed formulae for a linear ($n=1$) or quadratic ($n=2$) equation.
Note that C02AHF, C02AMF and C02ANF can be used to obtain the roots of a quadratic, cubic ($n=3$) and quartic ($n=4$) polynomial, respectively.

## 4  References

Marden M (1966) Geometry of polynomials Mathematical Surveys 3 American Mathematical Society, Providence, RI
Smith B T (1967) ZERPOL: a zero finding algorithm for polynomials using Laguerre's method Technical Report Department of Computer Science, University of Toronto, Canada
Thompson K W (1991) Error analysis for polynomial solvers Fortran Journal (Volume 3) 3 10–13
Wilkinson J H (1965) The Algebraic Eigenvalue Problem Oxford University Press, Oxford

## 5  Parameters

1:     A($2$,${\mathbf{N}}+1$) – REAL (KIND=nag_wp) arrayInput
On entry: if A is declared with bounds $\left(2,0:{\mathbf{N}}\right)$, then ${\mathbf{A}}\left(1,\mathit{i}\right)$ and ${\mathbf{A}}\left(2,\mathit{i}\right)$ must contain the real and imaginary parts of ${a}_{\mathit{i}}$ (i.e., the coefficient of ${z}^{n-\mathit{i}}$), for $\mathit{i}=0,1,\dots ,n$.
Constraint: ${\mathbf{A}}\left(1,0\right)\ne 0.0$ or ${\mathbf{A}}\left(2,0\right)\ne 0.0$.
2:     N – INTEGERInput
On entry: $n$, the degree of the polynomial.
Constraint: ${\mathbf{N}}\ge 1$.
3:     SCAL – LOGICALInput
On entry: indicates whether or not the polynomial is to be scaled. See Section 8 for advice on when it may be preferable to set ${\mathbf{SCAL}}=\mathrm{.FALSE.}$ and for a description of the scaling strategy.
Suggested value: ${\mathbf{SCAL}}=\mathrm{.TRUE.}$.
4:     Z($2$,N) – REAL (KIND=nag_wp) arrayOutput
On exit: the real and imaginary parts of the roots are stored in ${\mathbf{Z}}\left(1,\mathit{i}\right)$ and ${\mathbf{Z}}\left(2,\mathit{i}\right)$ respectively, for $\mathit{i}=1,2,\dots ,n$.
5:     W($4×\left({\mathbf{N}}+1\right)$) – REAL (KIND=nag_wp) arrayWorkspace
6:     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

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{A}}\left(1,0\right)=0.0$ and ${\mathbf{A}}\left(2,0\right)=0.0$, or ${\mathbf{N}}<1$.
${\mathbf{IFAIL}}=2$
The iterative procedure has failed to converge. This error is very unlikely to occur. If it does, please contact NAG, as some basic assumption for the arithmetic has been violated. See also Section 8.
${\mathbf{IFAIL}}=3$
Either overflow or underflow prevents the evaluation of $P\left(z\right)$ near some of its zeros. This error is very unlikely to occur. If it does, please contact NAG. See also Section 8.

## 7  Accuracy

All roots are evaluated as accurately as possible, but because of the inherent nature of the problem complete accuracy cannot be guaranteed. See also Section 9.

If ${\mathbf{SCAL}}=\mathrm{.TRUE.}$, then a scaling factor for the coefficients is chosen as a power of the base $b$ of the machine so that the largest coefficient in magnitude approaches $\mathit{thresh}={b}^{{e}_{\mathrm{max}}-p}$. You should note that no scaling is performed if the largest coefficient in magnitude exceeds $\mathit{thresh}$, even if ${\mathbf{SCAL}}=\mathrm{.TRUE.}$. ($b$, ${e}_{\mathrm{max}}$ and $p$ are defined in Chapter X02.)
However, with ${\mathbf{SCAL}}=\mathrm{.TRUE.}$, overflow may be encountered when the input coefficients ${a}_{0},{a}_{1},{a}_{2},\dots ,{a}_{n}$ vary widely in magnitude, particularly on those machines for which ${b}^{\left(4p\right)}$ overflows. In such cases, SCAL should be set to .FALSE. and the coefficients scaled so that the largest coefficient in magnitude does not exceed ${b}^{\left({e}_{\mathrm{max}}-2p\right)}$.
Even so, the scaling strategy used by C02AFF is sometimes insufficient to avoid overflow and/or underflow conditions. In such cases, you are recommended to scale the independent variable $\left(z\right)$ so that the disparity between the largest and smallest coefficient in magnitude is reduced. That is, use the routine to locate the zeros of the polynomial $dP\left(cz\right)$ for some suitable values of $c$ and $d$. For example, if the original polynomial was $P\left(z\right)={2}^{-100}i+{2}^{100}{z}^{20}$, then choosing $c={2}^{-10}$ and $d={2}^{100}$, for instance, would yield the scaled polynomial $i+{z}^{20}$, which is well-behaved relative to overflow and underflow and has zeros which are ${2}^{10}$ times those of $P\left(z\right)$.
If the routine fails with ${\mathbf{IFAIL}}={\mathbf{2}}$ or ${\mathbf{3}}$, then the real and imaginary parts of any roots obtained before the failure occurred are stored in Z in the reverse order in which they were found. Let ${n}_{R}$ denote the number of roots found before the failure occurred. Then ${\mathbf{Z}}\left(1,n\right)$ and ${\mathbf{Z}}\left(2,n\right)$ contain the real and imaginary parts of the first root found, ${\mathbf{Z}}\left(1,n-1\right)$ and ${\mathbf{Z}}\left(2,n-1\right)$ contain the real and imaginary parts of the second root found, $\dots ,{\mathbf{Z}}\left(1,n-{n}_{R}+1\right)$ and ${\mathbf{Z}}\left(2,n-{n}_{R}+1\right)$ contain the real and imaginary parts of the ${n}_{R}$th root found. After the failure has occurred, the remaining $2×\left(n-{n}_{R}\right)$ elements of Z contain a large negative number (equal to $-1/\left({\mathbf{X02AMF}}\left(\right)×\sqrt{2}\right)$).

## 9  Example

For this routine two examples are presented. There is a single example program for C02AFF, with a main program and the code to solve the two example problems given in the subroutines EX1 and EX2.
Example 1 (EX1)
This example finds the roots of the polynomial
 $a0 z5 + a1 z4 + a2 z3 + a3 z2 + a4 z+a5 = 0 ,$
where ${a}_{0}=\left(5.0+6.0i\right)$, ${a}_{1}=\left(30.0+20.0i\right)$, ${a}_{2}=-\left(0.2+6.0i\right)$, ${a}_{3}=\left(50.0+100000.0i\right)$, ${a}_{4}=-\left(2.0-40.0i\right)$ and ${a}_{5}=\left(10.0+1.0i\right)$.
Example 2 (EX2)
This example solves the same problem as subroutine EX1, but in addition attempts to estimate the accuracy of the computed roots using a perturbation analysis. Further details can be found in Thompson (1991).

### 9.1  Program Text

Program Text (c02affe.f90)

### 9.2  Program Data

Program Data (c02affe.d)

### 9.3  Program Results

Program Results (c02affe.r)