NAG Fortran Library, Mark 19

FLCRC19SB

Cray C90 Single Precision

Users' Note



Contents


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 Manual and Introductory Guide. Wherever those manuals 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 Manual; 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 documents of the NAG Fortran Library Manual, 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

Assuming that libnag.a has been installed in a directory in the search path of the linker, such as /usr/lib, then you may link to the NAG Fortran Library in the following manner: 

f90 driver.f -lnag
where driver.f is your application program.

3.2. Example Programs

The example programs are most easily accessed by the command nagexample, 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 (showing you the compile command so that you can recompile your own version of the program). Finally, the executable program will be run, presenting its output to stdout. The example program concerned is specified by the argument to nagexample, e.g. 
nagexample c06eae
will copy the example program and its data into the files c06eaee.f and c06eaee.d in the current directory and process them to produce the example program results.

In the NAG Fortran Library Manual, routine documents that have been typeset since Mark 12 present the example programs in a generalised form, using bold italicised terms as described in Section 3.3.

In other routine documents, the example programs are in single precision. All printed example programs show routine names ending in F not E (see Section 3.6).

The example programs supplied to a site in machine-readable form have been modified as necessary so that they are suitable for immediate execution. Note that all the distributed example programs have been revised and do not correspond exactly with the programs published in the manual, unless the documents have been recently typeset. The distributed example programs should be used in preference wherever possible.

3.3. Interpretation of Bold Italicised Terms

For this single precision implementation, the bold italicised terms used in the NAG Fortran Library Manual should be interpreted as: 
real                 - REAL (REAL*8)
basic precision      - single precision
complex              - COMPLEX (COMPLEX*16)
additional precision - double precision (REAL*16)
machine precision    - the machine precision, see the value
                       returned by X02AJE in Section 4

Thus a parameter described as real should be declared as REAL in your program. If a routine accumulates an inner product in additional precision, it is using double precision.

In routine documents that have been newly typeset since Mark 12 additional bold italicised terms are used in the published example programs and they must be interpreted as follows: 

real as an intrinsic function name - REAL
imag                               - AIMAG
cmplx                              - CMPLX
conjg                              - CONJG
e in constants, e.g. 1.0e-4        - E, e.g. 1.0E-4
e in formats, e.g. e12.4           - E, e.g. E12.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.
For example: 

sgetrf refers to the LAPACK routine name - SGETRF
cpotrs                                   - CPOTRS

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 X04AAE for error messages and X04ABE 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:

See Section 5 for additional documentation available from NAG.

3.6. Naming of Routines

To ensure a single precision implementation is completely distinct from any double precision version also available, all single precision routine names have been modified by changing the sixth character from F to E. Thus, for example: 
A02AAF  denotes the double precision version
A02AAE  denotes the single precision version

The names of auxiliary routines have also been modified by interchanging the first three and the last three characters, e.g. C02AFZ has been changed to AFZC02.

In the NAG Fortran Library Manual all library routine names end in F. Therefore, when using the manual in conjunction with this single precision implementation, all such names must be understood to refer to the single precision versions with names ending in E. Some routines in the Library require users to specify particular auxiliary routines. Again, when using this implementation it is necessary to specify the amended names.

The names of COMMON blocks have also been modified, e.g. AC02AF is renamed AFC02A. This is unlikely to affect the user.

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: 

nag_f77_a_chapter
nag_f77_c_chapter
nag_f77_d_chapter
nag_f77_e_chapter
nag_f77_f_chapter
nag_f77_g_chapter
nag_f77_h_chapter
nag_f77_m_chapter
nag_f77_p_chapter
nag_f77_s_chapter
nag_f77_x_chapter
These are supplied in pre-compiled form (.o files) and they can be accessed by specifying the -p"pathname" option on each f90 invocation, where "pathname" is the path of the directory containing the .o files.

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

These changes are illustrated by showing the conversion of the Fortran 77 version of the example program for NAG Fortran Library routine S18DEE. 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. 

*     S18DEE Example Program Text
*     Mark 14 Revised.  NAG Copyright 1989.
*******************************************************************
* Add USE statement for relevant chapters                         *
      USE NAG_F77_S_CHAPTER
*                                                                 *
*******************************************************************
*     .. Parameters ..
      INTEGER          NIN, NOUT
      PARAMETER        (NIN=5,NOUT=6)
      INTEGER          N
      PARAMETER        (N=2)
*     .. Local Scalars ..
      COMPLEX          Z
      REAL             FNU
      INTEGER          IFAIL, NZ
      CHARACTER*1      SCALE
*     .. Local Arrays ..
      COMPLEX          CY(N)
*     .. External Subroutines ..
*******************************************************************
* EXTERNAL declarations need to be removed (and type declarations *
*  for functions).                                                *
C      EXTERNAL         S18DEE
*                                                                 *
*******************************************************************
*     .. Executable Statements ..
      WRITE (NOUT,*) 'S18DEE 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 S18DEE(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 D03RAE and D03RBE take much longer to run than other examples.

(b) F06, F07 and F08

In this implementation calls to the Basic Linear Algebra Subprograms (BLAS) and linear algebra routines (LAPACK) are implemented by calls to the Cray Research libsci.a Subroutine Library. All calls to BLAS and LAPACK routines (except the sparse BLAS) use the code in libsci.a except the following, which use NAG versions: 
CTPTRS    CTRTRS    STPTRS    STRTRS

(c) G02

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

(d) P01

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

(e) S07 - S21

The constants referred to in the NAG Fortran Library Manual have the following values in this implementation: 
S07AAE  F(1)   = 1.0E+13
        F(2)   = 1.0E-14

S10AAE  E(1)   = 18.50
S10ABE  E(1)   = 5675.0
S10ACE  E(1)   = 5675.0

S13AAE  x(hi)  = 5676.0
S13ACE  x(hi)  = 3.3E+7
S13ADE  x(hi)  = 3.3E+7

S14AAE  IFAIL  = 1 if X > 965.0
        IFAIL  = 2 if X < -965.0
        IFAIL  = 3 if abs(X) < 7.34E-2466
S14ABE  IFAIL  = 2 if X > 2.40E+2461

S15ADE  x(hi)  = 75.3
        x(low) = -6.25
S15AEE  x(hi)  = 6.25

S17ACE  IFAIL  = 1 if X > 3.3E+7
S17ADE  IFAIL  = 1 if X > 3.3E+7
        IFAIL  = 3 if 0.0 < X <= 7.34E-2466
S17AEE  IFAIL  = 1 if abs(X) > 3.3E+7
S17AFE  IFAIL  = 1 if abs(X) > 3.3E+7
S17AGE  IFAIL  = 1 if X > 416.8
        IFAIL  = 2 if X < -1.3E+5
S17AHE  IFAIL  = 1 if X > 416.9
        IFAIL  = 2 if X < -1.3E+5
S17AJE  IFAIL  = 1 if X > 416.9
        IFAIL  = 2 if X < -1.3E+5
S17AKE  IFAIL  = 1 if X > 416.9
        IFAIL  = 2 if X < -1.3E+5
S17DCE  IFAIL  = 2 if abs (Z) < 5.42E-1233
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 5.93E+6
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 3.51E+13
S17DEE  IFAIL  = 2 if imag (Z) > 5660.0
        IFAIL  = 3 if abs (Z) or FNU+N-1 > 5.93E+6
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 3.51E+13
S17DGE  IFAIL  = 3 if abs (Z) > 3.27E+4
        IFAIL  = 4 if abs (Z) > 1.07E+9
S17DHE  IFAIL  = 3 if abs (Z) > 3.27E+4
        IFAIL  = 4 if abs (Z) > 1.07E+9
S17DLE  IFAIL  = 2 if abs (Z) < 5.42E-1233
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 5.93E+6
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 3.51E+13

S18ADE  IFAIL  = 2 if 0.0 < X <= 7.34E-2466
S18AEE  IFAIL  = 1 if abs(X) > 5680.0
S18AFE  IFAIL  = 1 if abs(X) > 5680.0
S18CDE  IFAIL  = 2 if 0.0 < X <= 7.34E-2466
S18DCE  IFAIL  = 2 if abs (Z) < 5.42E-1233
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 5.93E+6
        IFAIL  = 5 if abs (Z) or FNU+N-1 > 3.51E+13
S18DEE  IFAIL  = 2 if real (Z) > 5660.0
        IFAIL  = 3 if abs (Z) or FNU+N-1 > 5.93E+6
        IFAIL  = 4 if abs (Z) or FNU+N-1 > 3.51E+13

S19AAE  IFAIL  = 1 if abs(x) >= 44.625
S19ABE  IFAIL  = 1 if abs(x) >= 44.625
S19ACE  IFAIL  = 1 if X > 8021.3
S19ADE  IFAIL  = 1 if X > 8021.3

S21BCE  IFAIL  = 3 if an argument < 7.409E-1644
        IFAIL  = 4 if an argument >= 1.378E+1641
S21BDE  IFAIL  = 3 if an argument < 1.981E-822
        IFAIL  = 4 if an argument >= 1.999E+821

(f) X01

The values of the mathematical constants are: 
X01AAE (PI)    = 3.1415926535897932
X01ABE (GAMMA) = 0.5772156649015329

(g) X02

The values of the machine constants are:

The basic parameters of the model 

X02BHE = 2
X02BJE = 47
X02BKE = -8188
X02BLE = 8189
X02DJE = .FALSE.
Derived parameters of the floating-point arithmetic 
X02AJE = 1.421085471520E-14
X02AKE = 7.334415470240E-2466
X02ALE = 1.363435169511E+2465
X02AME = 7.334415470240E-2466
X02ANE = 2.708212596942E-1233
Parameters of other aspects of the computing environment 
X02AHE = 3.355443200000E+7
X02BBE = 9223372036854775807
X02BEE = 13
X02DAE = .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.

5. Documentation

Each supported NAG Fortran Library site is currently provided with a printed copy of the NAG Fortran Library Manual (or Update) and Introductory Guide. Additional copies 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.

On-line documentation is bundled with this implementation. Please see the Readme file on the distribution medium for further information.

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 FLCRC19SB).

(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/

or

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

or

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

NAG Inc
1431 Opus Place, Suite 220
Downers Grove
IL 60515-1362                           NAG Inc Response Center
USA                                     email: infodesk@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2345
Fax: +1 630 971 2706                    Fax: +1 630 971 2706

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

[NP3487/UN]