FLW3219D9 Users' Note

NAG Fortran Library, Mark 19

FLW3219D9

Windows 95/98/NT NAGWare FTN90, Double Precision

Users' Note

1. Introduction
2. Availability of Routines
3. General Information
4. Routine-specific Information
5. Documentation
6. Support from NAG
7. User Feedback
Appendix - Contact Addresses

1. Introduction

This document is essential reading for every user of the NAG Fortran Library Implementation specified in the title. It provides implementation-specific detail that augments the information provided in the NAG Fortran Library on-line documentation (PDF files) and in the NAG Fortran Library Introductory Guide. Wherever these refer to the "Users' Note for your implementation", you should consult this note.

NAG recommends that you read the following minimum reference material before calling any library routine:

(a) Essential Introduction
(b) Chapter Introduction
(c) Routine Document
(d) Implementation-specific Users' Note

Items (a), (b) and (c) are included in the NAG Fortran Library on-line documentation; items (a) and (b) are also included in the NAG Fortran Library Introductory Guide; item (d) is this document which is provided in HTML form. Item (a) is also supplied in plain text form.

2. Availability of Routines

All routines listed in the chapter contents of the NAG Fortran Library on-line documentation, Mark 19, are available in this implementation. At Mark 19, 68 new primary ("user-callable") routines have been introduced, and 15 deleted. Please consult the file doc\news (see Section 3.5) for lists of these routines and for a list of routines scheduled for withdrawal at Mark 20 or later. Your suggestions for new algorithms for future releases of the Library are welcomed (see Section 7).

3. General Information

3.1. Accessing the Library

To compile a user program driver.for, say, give the command

ftn90 driver.for

to create the object file driver.obj.

If the static version of the NAG Fortran Library (naglib.lib) has been installed in the directory c:\flw3219d9, create the file naglink.bat containing the following:

echo load %1 > slink.lst
echo load c:\flw3219d9\naglib.lib >> slink.lst
echo file >> slink.lst
slink slink.lst

Then give the command

naglink driver

to create the executable file driver.exe.

If the DLL version of the NAG Fortran Library (naglib.dll) has been installed, then the file naglink.bat should contain the following:

echo load %1 > slink.lst
echo load c:\flw3219d9\naglib.dll >> slink.lst
echo file >> slink.lst
slink slink.lst

Note that naglib.dll must be loaded. Note also that naglib.dll must be in a directory on your path before running the executable.

3.2. Example Programs

The example programs are most easily accessed by using the batch file nagex.bat (or nagexdll.bat), which will provide you with a copy of an example program (and its data, if any), compile the program and link it with the library. Finally, the executable program will be run. The example program concerned is specified by the argument to nagex.bat (or nagexdll.bat). For example, create the directory c:\test, make c:\test the current directory, copy the file nagex.bat (or nagexdll.bat) to it and then give, for example, the command:

nagex c06eaf

This will copy the example program and its data into the directory c:\test and process them to produce the example program results in the file c06eafe.res.

If the NAG Fortran Library has been installed as a dynamic link library, see also Section 4(b), below.

In the on-line documentation, routine documents present the example programs in a generalised form, using bold italicised terms as described in Section 3.3.

The example programs supplied to a site in machine-readable form have been modified as necessary so that they are suitable for immediate execution.

3.3. Interpretation of Bold Italicised Terms

For this double precision implementation, the bold italicised terms used in the on-line documentation should be interpreted as:

real                 - DOUBLE PRECISION
basic precision      - double precision
complex              - COMPLEX (KIND=KIND(1.0D0))
additional precision - quadruple precision
machine precision    - the machine precision, see the value
                       returned by X02AJF in Section 4

Thus a parameter described as real should be declared as DOUBLE PRECISION in your program. If a routine accumulates an inner product in additional precision, it is using software to simulate quadruple precision.

Additional bold italicised terms are used in the example programs in the on-line documentation and they must be interpreted as follows:

real as an intrinsic function name - DBLE
imag                               - AIMAG
cmplx                              - CMPLX with the addition of a
                                     final parameter KIND=KIND(1.0D0)
conjg                              - CONJG
e in constants, e.g. 1.0e-4        - D, e.g. 1.0D-4
e in formats, e.g. e12.4           - D, e.g. D12.4

All references to routines in Chapter F07 - Linear Equations (LAPACK) and Chapter F08 - Least-squares and Eigenvalue Problems (LAPACK) use the LAPACK name, not the NAG F07/F08 name. The LAPACK name is precision dependent, and hence the name appears in a bold italicised typeface.

The examples in the on-line documentation use the single precision form of the LAPACK name. To convert this name to its double precision form, change the first character either from S to D or C to Z as appropriate.
For example:

sgetrf refers to the LAPACK routine name - DGETRF
cpotrs                                   - ZPOTRS

3.4. Explicit Output from NAG Routines

Certain routines produce explicit error messages and advisory messages via output units which either have default values or can be reset by using X04AAF for error messages and X04ABF for advisory messages. (The default values are given in Section 4). The maximum record lengths of error messages and advisory messages (including carriage control characters) are 80 characters, except where otherwise specified.

3.5. User Documentation

The following machine-readable information files are provided in the doc directory:

un.html - Users' Note (this document)
essint - the Essential Introduction to the NAG Fortran Library
summary - a brief summary of the routines
news - an outline of the new and enhanced routines available at Mark 19
replaced - a list of routines available at earlier Marks of the Library but since withdrawn, together with recommended replacements
calls - a list of routines called directly or indirectly by each routine in the library, and by each example program
called - for each routine in the library (including auxiliaries), a list of routines and example programs which call it directly or indirectly
blas_lapack_to_nag - BLAS/F06, LAPACK/F07 and LAPACK/F08 listing
nag_to_blas_lapack - F06/BLAS, F07/LAPACK and F08/LAPACK listing
mk19.hlp - Windows help file, containing abbreviated documentation of the NAG routines

See Section 5 for additional documentation available from NAG.

3.6. Double Precision Complex

The double precision complex data type is not standard in Fortran 77, but many compilers (including NAGWare FTN90) support it. Fortran 90 has standardised this data type, and all Fortran 77 COMPLEX*16 (or DOUBLE COMPLEX) declarations should be replaced by Fortran 90 syntax.

For the NAGWare FTN90 Compiler the declaration for a variable Z becomes

COMPLEX (KIND=2) Z

or the more portable alternative (because KIND numbers are not standardised)

COMPLEX (KIND=KIND(1.0D0)) Z

If you have many such declarations it may be more convenient to define a constant with the KIND number

INTEGER, PARAMETER :: DP = KIND(1.0D0)
COMPLEX (KIND=DP) Z

3.7. Interface Blocks

The NAG Fortran Library Interface Blocks define the type and arguments of each user callable NAG Fortran Library routine. These are not essential to calling the NAG Fortran Library from Fortran 90 programs. Their purpose is to allow the Fortran 90 compiler to check that NAG Fortran Library routines are called correctly. The interface blocks enable the compiler to check that:

(a) Subroutines are called as such
(b) Functions are declared with the right type
(c) The correct number of arguments are passed
(d) All arguments match in type and structure

These interface blocks have been generated automatically by analysing the source code for the NAG Fortran Library. As a consequence, and because these files have been thoroughly tested, they are more reliable than writing your own declarations.

The NAG Fortran Library Interface Block files are organised by Library chapter. The module names are:

NAGIFB_A
NAGIFB_C
NAGIFB_D
NAGIFB_E
NAGIFB_F
NAGIFB_G
NAGIFB_H
NAGIFB_M
NAGIFB_P
NAGIFB_S
NAGIFB_X

These are supplied in pre-compiled form (.mod files). If, for example, NAGIFB_S is required, it must be copied to the current directory.

In order to make use of these modules from existing Fortran 77 code the following changes need to be made:

Add a USE statement for each of the module files for the chapters of the NAG Fortran Library that your program calls directly. Often only one USE statement will be required.
Delete all EXTERNAL statements for NAG Fortran Library routines. These are now declared in the module(s).
Delete the type declarations for any NAG Fortran Library functions. These are now declared in the module(s).

These changes are illustrated by showing the conversion of the Fortran 77 version of the example program for NAG Fortran Library routine S18DEF. Please note that this is not exactly the same as the example program that is distributed with this implementation. Each change is surrounded by comments boxed with asterisks. The previous Fortran 77 statement is shown commented out followed, where appropriate, with the new Fortran 90 line.

*     S18DEF Example Program Text
*     Mark 14 Revised.  NAG Copyright 1989.
*******************************************************************
* Add USE statement for relevant chapters                         *
      USE NAGIFB_S
*                                                                 *
*******************************************************************
*     .. Parameters ..
      INTEGER          NIN, NOUT
      PARAMETER        (NIN=5,NOUT=6)
      INTEGER          N
      PARAMETER        (N=2)
*     .. Local Scalars ..
*******************************************************************
*                                                                 *
* COMPLEX*16 may be changed to COMPLEX(KIND=...).                 *
C      COMPLEX*16       Z
*                                                                 *
      COMPLEX(KIND=KIND(1.0D0))  Z
*                                                                 *
*******************************************************************
      DOUBLE PRECISION FNU
      INTEGER          IFAIL, NZ
      CHARACTER*1      SCALE
*     .. Local Arrays ..
*******************************************************************
* COMPLEX*16 may be changed to COMPLEX(KIND=...).                 *
C      COMPLEX*16       CY(N)
      COMPLEX(KIND=KIND(1.0D0))  CY(N)
*                                                                 *
*******************************************************************
*     .. External Subroutines ..
*******************************************************************
* EXTERNAL declarations need to be removed (and type declarations *
*  for functions).                                                *
C      EXTERNAL         S18DEF
*                                                                 *
*******************************************************************
*     .. Executable Statements ..
      WRITE (NOUT,*) 'S18DEF Example Program Results'
*     Skip heading in data file
      READ (NIN,*)
      WRITE (NOUT,*)
      WRITE (NOUT,99999) 'Calling with N =', N
      WRITE (NOUT,*)
      WRITE (NOUT,*)
     +'   FNU            Z        SCALE       CY(1)              CY(2)
     +   NZ IFAIL'
      WRITE (NOUT,*)
   20 READ (NIN,*,END=40) FNU, Z, SCALE
      IFAIL = 0
*
      CALL S18DEF(FNU,Z,N,SCALE,CY,NZ,IFAIL)
*
      WRITE (NOUT,99998) FNU, Z, SCALE, CY(1), CY(2), NZ, IFAIL
      GO TO 20
   40 STOP
*
99999 FORMAT (1X,A,I2)
99998 FORMAT (1X,F7.4,'  (',F7.3,',',F7.3,')   ',A,
     +       2('  (',F7.3,',',F7.3,')'),I4,I4)
      END

4. Routine-specific Information

Any further information which applies to one or more routines in this implementation is listed below, chapter by chapter.

(a) D03

The example programs for D03RAF and D03RBF take much longer to run than other examples.

(b) F06

The example programs for the undocumented routines F06PBF, F06SBF, F06YCF and F06ZCF cannot be linked using the dynamic link library. This is because a different version of the error handler is used in these tests. This does not affect the efficacy of these routines in normal usage.

(c) G02

The value of ACC, the machine-dependent constant mentioned in several documents in the chapter, is 1.0D-13.

(d) P01

On hard failure, P01ABF writes the error message to the error message unit specified by X04AAF and then stops.

(e) S07 - S21

The constants referred to in the NAG Fortran Library Manual have the following values in this implementation:

S07AAF  F(1)   = 1.0D+13
        F(2)   = 1.0D-14

S10AAF  E(1)   = 18.50
S10ABF  E(1)   = 708.0
S10ACF  E(1)   = 708.0

S13AAF  x(hi)  = 708.2
S13ACF  x(hi)  = 1.0D+16
S13ADF  x(hi)  = 1.0D+17

S14AAF  IFAIL  = 1 if X > 170.0
        IFAIL  = 2 if X < -170.0
        IFAIL  = 3 if abs(X) < 2.58D-308
S14ABF  IFAIL  = 2 if X > 2.55D+305

S15ADF  x(hi)  = 26.6
        x(low) = -6.25
S15AEF  x(hi)  = 6.25

S17ACF  IFAIL  = 1 if X > 1.0D+9
S17ADF  IFAIL  = 1 if X > 1.0D+9
        IFAIL  = 3 if 0.0 < X <= 2.58D-308
S17AEF  IFAIL  = 1 if abs(X) > 1.0D+9
S17AFF  IFAIL  = 1 if abs(X) > 1.0D+9
S17AGF  IFAIL  = 1 if X > 103.8
        IFAIL  = 2 if X < -5.6D+10
S17AHF  IFAIL  = 1 if X > 104.1
        IFAIL  = 2 if X < -5.6D+10
S17AJF  IFAIL  = 1 if X > 104.1
        IFAIL  = 2 if X < -1.8D+9
S17AKF  IFAIL  = 1 if X > 104.1
        IFAIL  = 2 if X < -1.8D+9
S17DCF  IFAIL  = 2 if abs (Z) < 3.93D-305
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 3.27D+4
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 1.07D+9
S17DEF  IFAIL  = 2 if imag (Z) > 700.0
        IFAIL  = 3 if abs (Z) or FNU+N-1 > 3.27D+4
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 1.07D+9
S17DGF  IFAIL  = 3 if abs (Z) > 1.02D+3
        IFAIL  = 4 if abs (Z) > 1.04D+6
S17DHF  IFAIL  = 3 if abs (Z) > 1.02D+3
        IFAIL  = 4 if abs (Z) > 1.04D+6
S17DLF  IFAIL  = 2 if abs (Z) < 3.93D-305
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 3.27D+4
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 1.07D+9

S18ADF  IFAIL  = 2 if 0.0 < X <= 2.58D-308
S18AEF  IFAIL  = 1 if abs(X) > 711.5
S18AFF  IFAIL  = 1 if abs(X) > 711.5
S18CDF  IFAIL  = 2 if 0.0 < X <= 2.58D-308
S18DCF  IFAIL  = 2 if abs (Z) < 3.93D-305
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 3.27D+4
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 1.07D+9
S18DEF  IFAIL  = 2 if real (Z) > 700.0
        IFAIL  = 3 if abs (Z) or FNU+N-1 > 3.27D+4
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 1.07D+9

S19AAF  IFAIL  = 1 if abs(x) >= 49.50
S19ABF  IFAIL  = 1 if abs(x) >= 49.50
S19ACF  IFAIL  = 1 if X > 997.06
S19ADF  IFAIL  = 1 if X > 997.06

S21BCF  IFAIL  = 3 if an argument < 1.740D-205
        IFAIL  = 4 if an argument >= 3.424D+202
S21BDF  IFAIL  = 3 if an argument < 2.960D-103
        IFAIL  = 4 if an argument >= 1.337D+102

(f) X01

The values of the mathematical constants are:

X01AAF (PI)    = 3.1415926535897932
X01ABF (GAMMA) = 0.5772156649015329

(g) X02

The values of the machine constants are:

The basic parameters of the model

X02BHF = 2
X02BJF = 53
X02BKF = -1021
X02BLF = 1024
X02DJF = .TRUE.

Derived parameters of the floating-point arithmetic

X02AJF = 1.11130722679765D-16
X02AKF = 2.22507385850721D-308
X02ALF = 1.79769313486231D+308
X02AMF = 2.57466740049304D-308
X02ANF = 4.45014771701467D-308

Parameters of other aspects of the computing environment

X02AHF = 4.61168601842738D+18
X02BBF = 2147483647
X02BEF = 15
X02DAF = .FALSE.

(h) X04

The default output units for error and advisory messages for those routines which can produce explicit output are both Fortran Unit 6.

(i) X05

In order to avoid a compiler bug, the seventh element of the integer array passed as a parameter to X05AAF will always be returned as zero, i.e. millisecond will always be zero.

5. Documentation

A printed copy of the NAG Fortran Library Introductory Guide is normally provided with this implementation.

A full on-line version of the NAG Fortran Library Manual is provided in the form of Portable Document Format (PDF) files, and is included with this implementation on the distribution medium.

Abbreviated on-line documentation of the routines is also provided in Windows help file form as part of this implementation.

Printed copies of the NAG Fortran Library Manual are available for purchase; please refer to the NAG documentation order form (available on the NAG websites, see Section 6 (c)) for details of current prices.

6. Support from NAG

(a) Contact with NAG

Queries concerning this document or the implementation generally should be directed initially to your local Advisory Service. If you have difficulty in making contact locally, you can contact NAG directly at one of the addresses given in the Appendix. Users subscribing to the support service are encouraged to contact one of the NAG Response Centres (see below).

(b) NAG Response Centres

The NAG Response Centres are available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.

The Response Centres are open during office hours, but contact is possible by fax, email and phone (answering machine) at all times.

When contacting a Response Centre please quote your NAG site reference and NAG product code (in this case FLW3219D9).

(c) NAG Websites

The NAG websites are an information service providing items of interest to users and prospective users of NAG products and services. The information is reviewed and updated regularly and includes implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at

http://www.nag.co.uk/

http://www.nag.com/ (in North America)

http://www.nag-j.co.jp/ (in Japan)

(d) NAG Electronic Newsletter

If you would like to be kept up to date with news from NAG you may want to register to receive our electronic newsletter, which will alert you to special offers, announcements about new products or product/service enhancements, case studies and NAG's event diary. To register simply visit one of our websites or contact us at nagnews@nag.co.uk.

7. User Feedback

Many factors influence the way NAG's products and services evolve and your ideas are invaluable in helping us to ensure that we meet your needs. If you would like to contribute to this process we would be delighted to receive your comments. We have provided a short survey on our website at www.nag.co.uk/local/feedback to enable you to provide this feedback. Alternatively feel free to contact the appropriate NAG Response Centre who will be happy either to record your comments or to send you a printed copy of the survey.

Appendix - Contact Addresses

NAG Ltd
Wilkinson House
Jordan Hill Road
OXFORD  OX2 8DR                         NAG Ltd Response Centre
United Kingdom                          email: support@nag.co.uk
 
Tel: +44 (0)1865 511245                 Tel: +44 (0)1865 311744
Fax: +44 (0)1865 310139                 Fax: +44 (0)1865 310139
 
Nihon NAG KK
Yaesu Nagaoka Building No. 6 
1-9-8 Minato
Chuo-ku
Tokyo
Japan
email: help@nag-j.co.jp

Tel: +81 (0)3 5542 6311
Fax: +81 (0)3 5542 6312

[NP3490/UN]