NAG C Library, Mark 6

CLW3206DE

Windows 95/98/NT/2000 Static Library (32-bit)

(Borland C++Builder)

Users' Note



Contents


1. Introduction

This document is essential reading for every user of the NAG C Library Implementation specified in the title. It provides implementation-specific detail that augments the information provided in the NAG C Library Manual. Wherever that manual 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 function:

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

Items (a), (b) and (c) are included in the NAG C Library Manual; item (d) is this document which is provided in HTML form.

2. Availability of Functions

All functions listed in the chapter contents documents of the NAG C Library Manual, Mark 6 are available in this implementation. At Mark 6, 58 new primary ("user-callable") functions have been introduced. Please consult the Mark 6 News document in the C Library Manual for lists of these functions and for a list of functions scheduled for withdrawal at future Marks. Your suggestions for new algorithms for future releases of the Library are welcomed (see Section 7).

3. General Information

This implementation of the NAG C Library is a 32-bit static library intended for use with Windows 95/98 and NT/2000 applications. The Library may be called from C and C++ code in Windows applications that have been built using Borland C++Builder versions 4 and 5 (incorporating Borland command-line compilers versions 5.4 and 5.5 respectively).

This implementation can also be used with Borland C++ Development Suite 5.02 (incorporating Borland Command-line compiler version 5.2), but only if UUID.LIB (a 2 kb import library) is present in the BC5\LIB directory. UUID.LIB is supplied as part of the C++Builder versions 4 and 5, but not as part of the Borland C++ version 5.02 Development Suite.

3.1. Accessing the Library

The libraries, which have the names nagcsml.lib (single-threaded) and nagcsmt.lib (multi-threaded), are installed in the directory %NAGCLWDE%\lib, where NAGCLWDE is an environment variable, set during the installation process to the root directory of the NAG materials.

3.1.1. Compiling and Linking without using the Configuration Files

Assuming that the NAG C Library material has been installed in directory c:\clw3206de, then you may compile and link a driver program named driver.c with the NAG C Library in the following manner:

For the multi-threaded library: 

bcc32 -tWM -P-c -ps -f -Od -Ic:\clw3206de\include -Lc:\clw3206de\lib driver.c nagcsmt.lib
For the single-threaded library: 
bcc32 -tWM- -P-c -ps -f -Od -Ic:\clw3206de\include -Lc:\clw3206de\lib driver.c nagcsml.lib

3.1.2. Compiling and Linking using the Configuration Files

If you are compiling and linking from the command line, the location of the NAG include files and the NAG static library should be added to the configuration files bcc32.cfg and tlink32.cfg. These should be located in the directory where the compilation and linking are being done. The sample copies of these configuration files in the batch directory should be modified appropriately.

Using the configuration files, you can compile and link a driver program named driver.c with the NAG C Library in the following manner:

For the multi-threaded library: 

bcc32 -tWM -P-c -ps -f -Od driver.c nagcsmt.lib
For the single-threaded library: 
bcc32 -tWM- -P-c -ps -f -Od driver.c nagcsml.lib

3.2. Example Programs

The example programs are most easily accessed by using the batch file runex.bat. The batch file creates a small driving program, nagdrv.c, and it supplies the necessary options to the command-line compiler to compile the driving program and the example program and link them with the library (showing you the compilation command so that you can recompile your own version of the program). It creates the executable program, with the same name as the example program, that will be run (with an input data file, if necessary) and the results are saved in the appropriate directory, as explained below.

The example program concerned is specified by the argument to runex.bat, which should be the (short) name (in lower case) of a NAG C Library function, e.g. 

runex c06eac
Note that the batch file uses the multi-threaded library by default; it must be edited if the single-threaded library is to be used.

Further usage details may be obtained by running the batch file runex without arguments.

The results file will, by default, be written to the directory %NAGCLWDE%\examples\results and the difference file will be written to %NAGCLWDE%\examples\diffs. To write the results and differences to files in a different location, the environment variable NAGCLWDE_RES should be set to that directory, e.g. 

set NAGCLWDE_RES=c:\temp

The results and difference files will then be located in c:\temp\results and c:\temp\diffs.

3.3. User Documentation

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

A full on-line version of the NAG C Library Manual is supplied in the form of Portable Document Format (PDF) files. You will need to check how this version has been made available at your site.

4. Function-specific Information

e04mfc, e04nfc (for all implementations)

A new optional parameter 'optim_tol' has been introduced to allow users a further means of controlling the optimization process.

e04unc (for all implementations)

A member 'needf' has been added to the comm structure to allow users to provide only one component of fi(x) of the objective function in objfun (instead of having to provide all components systematically). This can significantly reduce the computation time when checking and approximating derivatives.

Note that users are not required to modify their existing programs if these changes are not relevant to them.

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

(a) s10 - s21

Functions in this chapter will give error messages if called with illegal or unsafe arguments. General details are given in the NAG C Library Manual, but parameter limits which are implementation-specific are given below: 
s10aac  E(1)      = 18.500
s10abc  fail.code = NE_REAL_ARG_GT if X > 708.0
s10acc  fail.code = NE_REAL_ARG_GT if X > 708.0

s13aac  X(hi)     = 708.3
s13acc  X(hi)     = 4.5e+15
s13adc  X(hi)     = 4.5e+15

s14aac  fail.code = NE_REAL_ARG_GT if X > 170.
        fail.code = NE_REAL_ARG_LT if X < -170.
        fail.code = NE_REAL_ARG_TOO_SMALL if ABS(X) < 2.23e-308
s14abc  fail.code = NE_REAL_ARG_GT if X > 2.55e+305

s17acc  fail.code = NE_REAL_ARG_GT if X > 4.5e+15
s17adc  fail.code = NE_REAL_ARG_GT if X > 4.5e+15
        fail.code = NE_REAL_ARG_TOO_SMALL if X <= 2.23e-308
s17aec  fail.code = NE_REAL_ARG_GT if ABS(X) > 4.5e+15
s17afc  fail.code = NE_REAL_ARG_GT if ABS(X) > 4.5e+15
s17agc  fail.code = NE_REAL_ARG_GT if X > 103.8
        fail.code = NE_REAL_ARG_LT if X < -3.5e+10
s17ahc  fail.code = NE_REAL_ARG_GT if X > 104.1
        fail.code = NE_REAL_ARG_LT if X < -3.5e+10
s17ajc  fail.code = NE_REAL_ARG_GT if X > 104.1
        fail.code = NE_REAL_ARG_LT if X < -1.8e+9
s17akc  fail.code = NE_REAL_ARG_GT if X > 104.1
        fail.code = NE_REAL_ARG_LT if X < -1.8e+9

s18adc  fail.code = NE_REAL_ARG_TOO_SMALL if 0.0 < X <= 2.23e-308
s18aec  fail.code = NE_REAL_ARG_GT if ABS(X) > 711.6
s18afc  fail.code = NE_REAL_ARG_GT if ABS(X) > 711.6
s18cdc  fail.code = NE_REAL_ARG_TOO_SMALL if 0.0 < X <= 2.23e-308

s19aac  fail.code = NE_REAL_ARG_GT if ABS(X) >= 49.5000
s19abc  fail.code = NE_REAL_ARG_GT if ABS(X) >= 49.5000
s19acc  fail.code = NE_REAL_ARG_GT if X > 997.26
s19adc  fail.code = NE_REAL_ARG_GT if X > 997.26

s21bcc  fail.code = NE_REAL_ARG_LT if an argument < 1.579e-205
        fail.code = NE_REAL_ARG_GE if an argument >= 3.773e+202
s21bdc  fail.code = NE_REAL_ARG_LT if an argument < 2.820e-103
        fail.code = NE_REAL_ARG_GT if an argument > 1.404e+102

(b) x01

The values of the mathematical constants are provided in the header file nagx01.h: 
X01AAC (pi)    = 3.1415926535897932
X01ABC (gamma) = 0.5772156649015329

(c) x02

The values of the machine constants are provided in the header file nagx02.h:

The basic parameters of the model 

X02BHC = 2
X02BJC = 53
X02BKC = -1021
X02BLC = 1024
X02DJC = TRUE
Derived parameters of the floating-point arithmetic 
X02AJC = 0x3ca0040000000000 ( 1.11130722679765e-16 )
X02AKC = 0x0010000000000000 ( 2.22507385850721e-308 )
X02ALC = 0x7fefffffffffffff ( 1.79769313486231e+308 )
X02AMC = 0x001001bb0d6e2727 ( 2.22601401396686e-308 )
X02ANC = 0x001001bb0d6e2727 ( 2.22601401396686e-308 )
Parameters of other aspects of the computing environment 
X02AHC = 0x4330000000000000 ( 4.50359962737049e+15 )
X02BBC = 2147483647
X02BEC = 15
X02DAC = FALSE

5. Documentation

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

Printed copies of the NAG C 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 CLW3206DE).

(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 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 pleased to receive your comments by email at feedback@nag.co.uk. Alternatively contact the appropriate NAG Response Centre who will be happy to record your comments.

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

[NP3589/UN]