NAG C Library, Mark 6

CLW3206DE

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

(Borland C++Builder)

Installer's Note



Contents


1. Introduction

This document is essential reading for whoever is responsible for the installation of the NAG C Library implementation specified in the title. The installer will be supplied with a printed copy of this document. Both this (doc/in.html) and the Users' Note (doc/un.html) are supplied on the distribution medium.

Whenever the NAG C Library has been supplied in compiled form, that form is considered to be the standard library file. The use of all supplied software must be in accordance with the terms and conditions of the Software Licence signed by NAG and each site. Any request to use NAG software on a computer other than the one licensed must be referred to NAG (see Section 6).

2. Implementation Provided

2.1. Applicability

This implementation is a compiled, tested, ready-to-use version of the NAG C Library that is considered suitable for operation on the computer systems detailed below:

hardware:         Intel Pentium based PCs or compatible 
operating system: Windows 95/98 or Windows NT/2000
C compiler:       Borland C++Builder Versions 4.0 and 5.0, and
                  Borland C++ Version 5.02

For information about implementations of the NAG C Library for use on other computer systems please contact NAG.

2.2. Derivation

This implementation was produced at NAG Ltd., Oxford on the computing system detailed below:

hardware:         Dan Technology 400 MHz Intel Pentium II
operating system: Windows NT 4.0 (with Service Pack 6a)
C compiler:       Borland C++Builder Version 5.0 (with Support Pack 1)
                  (incorporating Borland command-line compiler Version 5.5.1)
compiler options: -tWM (-tWM- for nagcsml.lib) -ps -a4 -3 

The compiler options have the following meanings:

-tWM   generate a 32-bit multi-threaded library
-tWM-  generate a 32-bit single-threaded library
-ps    use stdcall calling convention
-a4    align data on double word (4 bytes) boundaries
-3     generate 80386 protected-mode compatible instructions

The entire NAG C Library, Mark 6, was produced (as a Static Library project) with optimization level -02 (generate fastest possible code).

The libraries have been fully tested under Windows NT and Windows 2000 with:

in all possible combinations.

The libraries 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. Distribution Medium

3.1. Recording Details

The implementation is distributed on CD-ROM, unless otherwise indicated on the medium and accompanying despatch note.

For further details, refer to other documentation supplied or contact NAG (see Section 6).

3.2. Contents

The following shows the directory/file organization of the library materials as they will be installed.
                      |-- in.html
            |-- doc --|-- un.html
            |         |-- calls.txt
            |
            |         |-- nagcsml.lib
            |-- lib --|
            |         |-- nagcsmt.lib
            |
            |-- nagcvars.bat
            |
            |-- DeIsL?.isu
            |
            |-- include --|-- *.h
clw3206de --|
            |              |-- source -------|-- ??????e.c
            |              |-- data ---------|-- ??????e.d
            |-- examples --|-- baseresults --|-- ??????e.r
            |              |-- results
            |              |-- diffs
            |
            |           |-- runex.bat
            |           |-- bcc32.cfg
            |-- batch --|-- tlink32.cfg
                        |-- nagppd.c
                        |-- nagapd.c

The following shows the directory/file organization of the PDF documentation materials as they will be installed.

         |-- Images --|-- *.gif
         |
         |                   |-- mark6.html  (main index)
         |                   |
NAGdoc --|                   |-- genint --|-- *.html  (introductory material)
         |        |-- html --|
         |        |          |-- [A00-X02]_cl??.html  (chapter indexes)
         |-- cl --|
                  |         |-- genint --|-- *.pdf  (introductory material)
                  |-- pdf --|
                            |-- indexes --|-- *.pdf  (KWIC and GAMS)
                            |
                            |-- [A00-X02] --|-- *.pdf  (chapter and function
                                                        files)

3.3. File Sizes

The file sizes are given below. The actual disk space used is dependent on the hard disk allocation unit (cluster) size (this information is supplied by the DOS command CHKDSK).
compiled libraries, nagcsml.lib:  6.1 Mb
                    nagcsmt.lib:  6.1 Mb
include files:                    0.9 Mb
example program material:         1.8 Mb
library documentation files:      0.2 Mb
PDF documentation files:         29.7 Mb

4. Installation

4.1. Library Installation

The CD should autorun and will lead you to a dialogue for installation.

If the autorun facility does not operate, then double click on the setup.exe file on the CD using Windows Explorer. Any continuing difficulties indicate a problem which should be reported to the NAG Response Centre (see Section 6).

The installation program will ask you for the drive and directory where you would like to install the library materials. You will also be asked which parts of the materials you want to install. The installation program may be used to install all the materials from CD-ROM or just some part of it, for example one of the libraries.

An uninstall facility is provided. This will remove the product from your disk. It will also undo the registry entries made during installation, but will not undo any changes to the autoexec.bat file. If a re-installation is performed, for example to add a component that wasn't originally installed, the uninstall facility will remove only the most recently added files. (However, it will still remove all the registry entries associated with this software.) The uninstaller will not remove files created since the installation was completed (although it will remove original files that have been modified), so it may be necessary to delete these files to complete the removal.

After installation you should ensure that the software described in Section 3.2 is present and accessible.

The batch file runex.bat requires the setting of the environment variable NAGCLWDE. It should be set to the root directory of the NAG materials.

Under Windows 95/98, the autoexec.bat file can be edited to add the environment variable. If the default location is used, add the line

set NAGCLWDE=c:\clw3206de

Under Windows NT/2000, the environment variable value can be set in the Control Panel | System Properties dialog. If the default location is used, set the variable to

NAGCLWDE
and the value to
c:\clw3206de

Alternatively, runex.bat can be edited to set the variable NAGCLWDE to reflect the local installation. Note that runex.bat also assumes that the location of the Borland C++Builder compiler is in your PATH environment variable.

The above change to the autoexec.bat file (for Windows 95/98) can be made by the installation procedure if desired.

A second environment variable, NAGCLWDE_RES, can also be set to specify the pathname of the parent directory of the results directory. If this variable is not set, the pathname of the parent directory is set to %NAGCLWDE%\examples.

A batch file nagcvars.bat is provided in the NAG materials root directory to set the environment variable NAGCLWDE from the MS-DOS prompt. This will affect the environment only for that particular DOS box, but could be useful if compiling from the command line.

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.

Alternatively, these paths may be specified as part of the arguments to the command-line compiler, bcc32, using the options -I"include_path" and -L"library_path", where "include_path" and "library_path" are the include and library directory paths, respectively.

The paths can also be set within the Borland C++Builder integrated development environment under Windows, as would be the case for any static library that is to be linked to a program.

4.2. PDF Documentation Installation

To install the PDF documentation material, follow the on-screen instructions.

You may wish to move the PDF documentation files to the same location as that for other NAG products. You are encouraged to make them readily available to users, but in such a way that they are not generally accessible from outside your site.

4.3. Checking Accessibility

The installer should ensure that the advice given to users in Section 3.1 of the Users' Note (doc\un.html) is suitable for the installation. This can be done by running a few example programs following that advice; a suitable sample would be a02bac, g05ffc and s17akc. The installation can also be tested using the batch file runex.bat. By default, this uses the multi-threaded library (nagcsmt.lib); if the single-threaded library (nagcsml.lib) is to be used, the batch file must be modified appropriately.

4.4. Release to Users

The Users' Note (doc\un.html) should be checked and amended as necessary (particularly Section 3.1). It can then be made available to users directly, or be absorbed into local access information.

All the material listed in Section 3.2 except this document, the Installer's Note (doc\in.html), should be made accessible to users.

Note that the example material has been adapted, if necessary, from that supplied in the PDF documentation, so that programs are suitable for execution with this implementation with no further changes. Making the example material directly available to users provides them with easily adaptable templates for their own problems.

4.5. Maintenance Level

The maintenance level of the library can be determined by writing a simple program to call function a00aac, which prints out details of the implementation, including title and product code, compiler and precision used, mark and maintenance level.

5. Documentation

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

A full on-line version of the NAG C Library Manual is provided in the form of Portable Document Format (PDF) files with this implementation. Further information is contained in the Readme file on the distribution medium.

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/IN]