In addition, NAG recommends that before calling any Library routine you should read the following reference material (see Section 5):
(a) Essential Introduction
(b) Chapter Introduction
(c) Routine Document
The libraries supplied with this implementation have been compiled in a manner that facilitates the use of multiple threads.
http://www.nag.co.uk/doc/inun/cl24/luxdcl/postrelease.html
for details of any new information related to the applicability or usage of this implementation.
If your machine has more than one processor or a multicore chip, then it is recommended that you set the environment variable OMP_NUM_THREADS to the number of available threads, e.g.
setenv OMP_NUM_THREADS 4in the C shell, or
OMP_NUM_THREADS=4 export OMP_NUM_THREADSin the Bourne shell. This will enable the Intel MKL BLAS to make use of the extra processor(s) / core(s) and will thus speed up the computation of many of the Library procedures.
With MKL version 10.0 or newer, this is the default behaviour. In this case, if you do not want MKL to make use of multiple cores, OMP_NUM_THREADS must be set to 1.
If you are running on an Intel processor and using an MKL-based variant of the NAG Library, performance may be enhanced by using the Conditional Numerical Reproducibility settings introduced in MKL 11.0. To get the best performance from the MKL routines, set the environment variable MKL_CBWR appropriately for your processor. See http://software.intel.com/sites/products/documentation/doclib/mkl_sa/11/mkl_userguide_lnx/index.htm#GUID-DCB010F6-DDBF-4A00-8BB3-049BEFDC2ED2.htm for the various settings available. Alternatively, call the mkl_set_cbwr_branch function from your code prior to calling any NAG Library routines.
Please note that this implementation is not compatible with versions of MKL earlier than 10.3.
In this section we assume that the library and the NAG include files have been installed in the directory [INSTALL_DIR].
By default [INSTALL_DIR] (see Installer's Note (in.html)) is /opt/NAG/cllux24dcl or /usr/local/NAG/cllux24dcl depending on your system; however it could have been changed by the person who did the installation. To identify [INSTALL_DIR] for this installation:
icc driver.c -I[INSTALL_DIR]/include [INSTALL_DIR]/lib/libnagc_mkl.a \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_intel.a \
-Wl,--start-group \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_intel_thread.a \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_core.a \
-Wl,--end-group \
[INSTALL_DIR]/rtl/ia32/libifcoremt.a \
[INSTALL_DIR]/rtl/ia32/libiomp5.a \
[INSTALL_DIR]/rtl/ia32/libirc.a \
-lpthread -lm
where driver.c is your application program;
or
icc driver.c -I[INSTALL_DIR]/include [INSTALL_DIR]/lib/libnagc_mkl.so \
-L[INSTALL_DIR]/mkl_11.1.1/lib/ia32 -lmkl_intel \
-Wl,--start-group \
-lmkl_intel_thread -lmkl_core \
-Wl,--end-group \
-L[INSTALL_DIR]/rtl/ia32 \
-liomp5 -lpthread -lm
if the shareable library is required.
However, if you prefer to link to a version of the NAG C Library which does not require the use of MKL you may wish to use the self-contained libraries as follows:
icc driver.c -I[INSTALL_DIR]/include [INSTALL_DIR]/lib/libnagc_nag.a \
[INSTALL_DIR]/rtl/ia32/libifcoremt.a \
[INSTALL_DIR]/rtl/ia32/libirc.a \
-lpthread -lm
or
icc driver.c -I[INSTALL_DIR]/include [INSTALL_DIR]/lib/libnagc_nag.so \
[INSTALL_DIR]/rtl/ia32/libifcoremt.a \
-lpthread -lm
if the shareable library is required.
If you want to use a different compiler or an earlier version of the Intel compiler, icc, you may need to link against the libraries provided in [INSTALL_DIR]/rtl/. For example, to use gcc 4.1.2 onwards, you can use one of the following commands:
To use the MKL-based NAG C Library with static linkage:
gcc driver.c -I[INSTALL_DIR]/include -m32 \
[INSTALL_DIR]/lib/libnagc_mkl.a \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_intel.a \
-Wl,--start-group \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_intel_thread.a \
[INSTALL_DIR]/mkl_11.1.1/lib/ia32/libmkl_core.a \
-Wl,--end-group \
[INSTALL_DIR]/rtl/ia32/libifcoremt.a \
[INSTALL_DIR]/rtl/ia32/libiomp5.a \
[INSTALL_DIR]/rtl/ia32/libimf.a \
[INSTALL_DIR]/rtl/ia32/libsvml.a \
[INSTALL_DIR]/rtl/ia32/libirc.a \
-ldl -lpthread -lm
To use the MKL-based NAG C Library with shared linkage:
gcc driver.c -I[INSTALL_DIR]/include -m32 \
[INSTALL_DIR]/lib/libnagc_mkl.so \
-L[INSTALL_DIR]/mkl_11.1.1/lib/ia32 -lmkl_intel \
-Wl,--start-group \
-lmkl_intel_thread -lmkl_core \
-Wl,--end-group \
-L[INSTALL_DIR]/rtl/ia32 \
-liomp5 -ldl -lpthread -lm
To use the self-contained NAG C Library with static linkage:
gcc driver.c -I[INSTALL_DIR]/include -m32 \
[INSTALL_DIR]/lib/libnagc_nag.a \
[INSTALL_DIR]/rtl/ia32/libifcoremt.a \
[INSTALL_DIR]/rtl/ia32/libimf.a \
[INSTALL_DIR]/rtl/ia32/libsvml.a \
[INSTALL_DIR]/rtl/ia32/libirc.a \
-ldl -lpthread -lm
To use the self-contained NAG C Library with shared linkage:
gcc driver.c -I[INSTALL_DIR]/include -m32 \
[INSTALL_DIR]/lib/libnagc_nag.so \
-L[INSTALL_DIR]/rtl/ia32 \
-lsvml -ldl -lpthread -lm
If your application has been linked with the shareable NAG and MKL libraries then the environment variable LD_LIBRARY_PATH must be set (or extended) to allow run-time linkage.
In the C shell type:
setenv LD_LIBRARY_PATH [INSTALL_DIR]/lib:[INSTALL_DIR]/mkl_11.1.1/lib/ia32to set LD_LIBRARY_PATH, or
setenv LD_LIBRARY_PATH \
[INSTALL_DIR]/lib:[INSTALL_DIR]/mkl_11.1.1/lib/ia32:${LD_LIBRARY_PATH}
to extend LD_LIBRARY_PATH if you already have it set.
In the Bourne shell, type:
LD_LIBRARY_PATH=[INSTALL_DIR]/lib:[INSTALL_DIR]/mkl_11.1.1/lib/ia32 export LD_LIBRARY_PATHto set LD_LIBRARY_PATH, or
LD_LIBRARY_PATH=[INSTALL_DIR]/lib:[INSTALL_DIR]/mkl_11.1.1/lib/ia32:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH
to extend LD_LIBRARY_PATH if you already have it set.
Note that you may also need to set LD_LIBRARY_PATH to point at other items such as compiler run-time libraries, for example if you are using a newer version of the compiler.
If you are using a different compiler, you may need to link against the Intel icl run-time libraries provided in [INSTALL_DIR]/rtl.
The distributed example results are those obtained with the static library libnagc_mkl.a (using the MKL BLAS and LAPACK routines).
Note that the example material has been adapted, if necessary, from that published in the Library Manual, so that programs are suitable for execution with this implementation with no further changes. The distributed example programs should be used in preference to the versions in the Library Manual wherever possible.
The directory [INSTALL_DIR]/scripts contains four scripts: nagc_example_mkl, nagc_example_shar_mkl, nagc_example and nagc_example_shar.
The example programs are most easily accessed by one of the commands
Each command will provide you with a copy of an example program (and its data and options file, if any), compile the program and link it with the appropriate libraries (showing you the compile command so that you can recompile your own version of the program). Finally, the executable program will be run with appropriate arguments specifying data, options and results files as needed.
The example program concerned is specified by the argument to the command, e.g.
nagc_example_mkl e04uccwill copy the example program and its data and options files (e04ucce.c, e04ucce.d and e04ucce.opt) into the current directory, compile the program and run it to produce the example program results in the file e04ucce.r.
| NAG Type | C Type | Size (bytes) |
|---|---|---|
| Integer | long | 4 |
| Pointer | void * | 4 |
The values for sizeof(Integer) and sizeof(Pointer) are also given by the a00aac example program. Information on other NAG data types is available in the Essential Introduction section of the Library Manual (see Section 5).
dgemqrt dgeqrt dtpmqrt dtpqrt zgemqrt zgeqrt zgesvd zggevx ztpmqrt ztpqrt
The behaviour of functions in these Chapters may depend on implementation-specific values.
General details are given in the Library Manual, but the specific values used in this implementation are as follows:
s10aac E_1 = 1.8715e+1
s10abc E_1 = 7.080e+2
s10acc E_1 = 7.080e+2
s13aac x_hi = 7.083e+2
s13acc x_hi = 1.0e+16
s13adc x_hi = 1.0e+17
s14aac fail.code = NE_REAL_ARG_GT if x > 1.70e+2
fail.code = NE_REAL_ARG_LT if x < -1.70e+2
fail.code = NE_REAL_ARG_TOO_SMALL if abs(x) < 2.23e-308
s14abc fail.code = NE_REAL_ARG_GT if x > x_big = 2.55e+305
s15adc x_hi = 2.65e+1
s15aec x_hi = 2.65e+1
s15agc fail.code = NW_HI if x >= 2.53e+307
fail.code = NW_REAL if 4.74e+7 <= x < 2.53e+307
fail.code = NW_NEG if x < -2.66e+1
s17acc fail.code = NE_REAL_ARG_GT if x > 1.0e+16
s17adc fail.code = NE_REAL_ARG_GT if x > 1.0e+16
fail.code = NE_REAL_ARG_TOO_SMALL if 0 < x <= 2.23e-308
s17aec fail.code = NE_REAL_ARG_GT if abs(x) > 1.0e+16
s17afc fail.code = NE_REAL_ARG_GT if abs(x) > 1.0e+16
s17agc fail.code = NE_REAL_ARG_GT if x > 1.038e+2
fail.code = NE_REAL_ARG_LT if x < -5.7e+10
s17ahc fail.code = NE_REAL_ARG_GT if x > 1.041e+2
fail.code = NE_REAL_ARG_LT if x < -5.7e+10
s17ajc fail.code = NE_REAL_ARG_GT if x > 1.041e+2
fail.code = NE_REAL_ARG_LT if x < -1.9e+9
s17akc fail.code = NE_REAL_ARG_GT if x > 1.041e+2
fail.code = NE_REAL_ARG_LT if x < -1.9e+9
s17dcc fail.code = NE_OVERFLOW_LIKELY if abs(z) < 3.92223e-305
fail.code = NW_SOME_PRECISION_LOSS if abs(z) or fnu+n-1 > 3.27679e+4
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) or fnu+n-1 > 1.07374e+9
s17dec fail.code = NE_OVERFLOW_LIKELY if AIMAG(z) > 7.00921e+2
fail.code = NW_SOME_PRECISION_LOSS if abs(z) or fnu+n-1 > 3.27679e+4
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) or fnu+n-1 > 1.07374e+9
s17dgc fail.code = NW_SOME_PRECISION_LOSS if abs(z) > 1.02399e+3
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) > 1.04857e+6
s17dhc fail.code = NW_SOME_PRECISION_LOSS if abs(z) > 1.02399e+3
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) > 1.04857e+6
s17dlc fail.code = NE_OVERFLOW_LIKELY if abs(z) < 3.92223e-305
fail.code = NW_SOME_PRECISION_LOSS if abs(z) or fnu+n-1 > 3.27679e+4
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) or fnu+n-1 > 1.07374e+9
s18adc fail.code = NE_REAL_ARG_TOO_SMALL if 0 < x <= 2.23e-308
s18aec fail.code = NE_REAL_ARG_GT if abs(x) > 7.116e+2
s18afc fail.code = NE_REAL_ARG_GT if abs(x) > 7.116e+2
s18dcc fail.code = NE_OVERFLOW_LIKELY if abs(z) < 3.92223e-305
fail.code = NW_SOME_PRECISION_LOSS if abs(z) or fnu+n-1 > 3.27679e+4
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) or fnu+n-1 > 1.07374e+9
s18dec fail.code = NE_OVERFLOW_LIKELY if REAL(z) > 7.00921e+2
fail.code = NW_SOME_PRECISION_LOSS if abs(z) or fnu+n-1 > 3.27679e+4
fail.code = NE_TOTAL_PRECISION_LOSS if abs(z) or fnu+n-1 > 1.07374e+9
s19aac fail.code = NE_REAL_ARG_GT if abs(x) >= 5.04818e+1
s19abc fail.code = NE_REAL_ARG_GT if abs(x) >= 5.04818e+1
s19acc fail.code = NE_REAL_ARG_GT if x > 9.9726e+2
s19adc fail.code = NE_REAL_ARG_GT if x > 9.9726e+2
s21bcc fail.code = NE_REAL_ARG_LT if an argument < 1.583e-205
fail.code = NE_REAL_ARG_GE if an argument >= 3.765e+202
s21bdc fail.code = NE_REAL_ARG_LT if an argument < 2.813e-103
fail.code = NE_REAL_ARG_GT if an argument >= 1.407e+102
The values of the mathematical constants are provided in the header file nagx01.h:
X01AAC (pi) = 3.1415926535897932 X01ABC (gamma) = 0.5772156649015328
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 = 1024Derived parameters of the floating-point arithmetic
X02AJC = 1.11022302462516e-16 X02AKC = 2.22507385850721e-308 X02ALC = 1.79769313486231e+308 X02AMC = 2.22507385850721e-308 X02ANC = 2.22507385850721e-308Parameters of other aspects of the computing environment
X02AHC = 1.42724769270596e+45 X02BBC = 2147483647 X02BEC = 15
The Library Manual is available as part of the installation or via download from the NAG website. The most up-to-date version of the documentation is accessible via the NAG website at http://www.nag.co.uk/numeric/CL/CLdocumentation.asp.
The Library Manual is supplied in the following formats:
The following main index files have been provided for these formats:
nagdoc_cl24/html/FRONTMATTER/manconts.html nagdoc_cl24/pdf/FRONTMATTER/manconts.pdf nagdoc_cl24/pdf/FRONTMATTER/manconts.htmlUse your web browser to navigate from here. For convenience, a master index file containing links to the above files has been provided at
nagdoc_cl24/index.html
Advice on viewing and navigating the formats available can be found in the Online Documentation document.
In addition the following are provided:
The NAG Technical Support Service is available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.
The technical support desks are open during office hours, but contact is possible by email and phone (answering machine) at all times.
When contacting us, it helps us deal with your enquiry quickly if you can quote your NAG customer reference number and NAG product code (in this case CLLUX24DCL).
The NAG websites provide information about implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at the following URLs:
NAG Ltd Wilkinson House Jordan Hill Road OXFORD OX2 8DR Technical Support (Europe & ROW) United Kingdom email: support@nag.co.uk Tel: +44 (0)1865 511245 Tel: +44 (0)1865 311744 NAG Inc 801 Warrenville Road Suite 185 Lisle, IL 60532-4332 Technical Support (North America) USA email: support@nag.com Tel: +1 630 971 2337 Tel: +1 630 971 2337 Nihon NAG KK Hatchobori Frontier Building 2F 4-9-9 Hatchobori Chuo-ku Tokyo 104-0032 Technical Support (Japan) Japan email: naghelp@nag-j.co.jp Tel: +81 3 5542 6311 Tel: +81 3 5542 6311