NAG Library Manual, Mark 28.5
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
C02 (Zeros) Chapter Contents
C02 (Zeros) Chapter Introduction
c02am:  FL   CL   CPP   AD   PY   MB 

NAG FL Interface
c02amf (cubic_​complex)

NAG Library Manual, Mark 28.5
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
C02 (Zeros) Chapter Contents
C02 (Zeros) Chapter Introduction
c02am:  FL   CL   CPP   AD   PY   MB 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2022
Settings help

FL Name Style:


FL Specification Language:


1 Purpose

c02amf determines the roots of a cubic equation with complex coefficients.

2 Specification

Fortran Interface
Subroutine c02amf ( u, r, s, t, zeror, zeroi, errest, ifail)
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (Out) :: zeror(3), zeroi(3), errest(3)
Complex (Kind=nag_wp), Intent (In) :: u, r, s, t
C Header Interface
#include <nag.h>
void  c02amf_ (const Complex *u, const Complex *r, const Complex *s, const Complex *t, double zeror[], double zeroi[], double errest[], Integer *ifail)
The routine may be called by the names c02amf or nagf_zeros_cubic_complex.

3 Description

c02amf attempts to find the roots of the cubic equation
uz3+rz2+sz+t=0,  
where u, r, s and t are complex coefficients with u≠0. The roots are located by finding the eigenvalues of the associated 3×3 (upper Hessenberg) companion matrix H given by
H= ( 0 0 -t/u 1 0 -s/u 0 1 -r/u ) .  
The eigenvalues are obtained by a call to f08psf. Further details can be found in Section 9.
To obtain the roots of a quadratic equation, c02ahf can be used.

4 References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

1: u – Complex (Kind=nag_wp) Input
On entry: u, the coefficient of z3.
Constraint: u≠(0.0,0.0).
2: r – Complex (Kind=nag_wp) Input
On entry: r, the coefficient of z2.
3: s – Complex (Kind=nag_wp) Input
On entry: s, the coefficient of z.
4: t – Complex (Kind=nag_wp) Input
On entry: t, the constant coefficient.
5: zeror(3) – Real (Kind=nag_wp) array Output
6: zeroi(3) – Real (Kind=nag_wp) array Output
On exit: zeror(i) and zeroi(i) contain the real and imaginary parts, respectively, of the ith root.
7: errest(3) – Real (Kind=nag_wp) array Output
On exit: errest(i) contains an approximate error estimate for the ith root.
8: ifail – Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or −1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
On entry, u=(0.0,0.0).
Constraint: u≠(0.0,0.0)
ifail=2
The companion matrix H cannot be formed without overflow.
ifail=3
Failure to converge in f08psf.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

If ifail=0 on exit, then the ith computed root should have approximately |log10(errest(i))| correct significant digits.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
c02amf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
c02amf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The method used by the routine consists of the following steps, which are performed by routines from LAPACK in Chapter F08.
  1. (a)Form matrix H.
  2. (b)Apply a diagonal similarity transformation to H (to give H′).
  3. (c)Calculate the eigenvalues and Schur factorization of H′.
  4. (d)Calculate the left and right eigenvectors of H′.
  5. (e)Estimate reciprocal condition numbers for all the eigenvalues of H′.
  6. (f)Calculate approximate error estimates for all the eigenvalues of H′ (using the 1-norm).

9.1 Internal Changes

Internal changes have been made to this routine as follows:
For details of all known issues which have been reported for the NAG Library please refer to the Known Issues.

10 Example

This example finds the roots of the cubic equation
z3-(2-3i)z2+(5+14i)z-(40+5i)=0.  

10.1 Program Text

Program Text (c02amfe.f90)

10.2 Program Data

Program Data (c02amfe.d)

10.3 Program Results

Program Results (c02amfe.r)
NAG Library Manual, Mark 28.5
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG FL Interface Introduction
C02 (Zeros) Chapter Contents
C02 (Zeros) Chapter Introduction
c02am:  FL   CL   CPP   AD   PY   MB 
© The Numerical Algorithms Group Ltd. 2022