Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.42 KB

readme.md

File metadata and controls

60 lines (42 loc) · 2.42 KB
Raw

C++ Interfaces for the nAG Library

This is version 30.2.0.0 of a set of C++ interfaces for the NAG Library, supplied as a series of header files.

In order to make use of this product you will need a copy of Mark 30.2 of the nAG Library installed on your system.

Currently only interfaces for a small subset of routines from the nAG Library are available in this form. These interfaces are automatically generated, and their primary purpose is to elicit feedback on their design prior to rolling the process out across the whole library.

Quick Start

Please visit the nAG Library for C++ intro page for quick-start information and more details on the examples supplied in the distribution.

Basic Documentation

Assuming that you have installed the C++ interfaces into the directory called [NAGCPP_INSTALL_DIR] then you should have four subdirectories:

  • [NAGCPP_INSTALL_DIR]/include

    Contains the C++ wrappers and all required utility headers.

  • [NAGCPP_INSTALL_DIR]/examples

    Contains a sample of examples calling the interfaces.

  • [NAGCPP_INSTALL_DIR]/tests

    Contains a series of unit tests that have been used to test the supplied wrappers.

  • [NAGCPP_INSTALL_DIR]/scripts

    Contains a number of Linux scripts for compiling and running the examples and unit tests. These scripts can also be run from WSL or Cygwin. Before running any of these scripts you should ensure that your environment is set up correctly by, for example, running either envvars.bat, nagvars.sh or nagvars.csh, supplied with the nAG Library. Which is supplied / required depends on whether you are on Windows or Linux and, if on Linux, which shell you are using.

When using the C++ interfaces supplied with this readme you will need to add the directory [NAGCPP_INSTALL_DIR]/include to the list of directories your compiler searches for header files in addition to using any compiler flags usually required by the nAG Library (as specified in the Users' Notes supplied with your version of the library and also available from the nAG website at https://support.nag.com/content/nagr-library-mark-30).

Full Documentation for the C++ Interfaces

A more comprehensive set of documentation is available from the nAG website: https://support.nag.com/numeric/nl/nagdoc_30.2/cpphtml/frontmatter/manconts.html