Including the ADOL-C Examples and Tests
Keywords: including the adol-c examples tests adolc prefix get purpose adolc_prefix speed unix cygwin get_adolc

| Prev | Next |  |  |  |  |  |  |

Including the ADOL-C Examples and Tests
Purpose
CppAD includes examples and tests that can use the AD package ADOL-C . The includes speed comparison with other AD packages; see speed_adolc . It also includes examples that combine ADOL-C with CppAD; see

base_adolc.hpp | Enable use of AD<Base> where Base is Adolc's adouble Type
mul_level_adolc.cpp | Using Adolc with Multiple Levels of Taping: Example and Test
mul_level_adolc_ode.cpp | Taylor's Ode Solver: A Multi-Level Adolc Example and Test

adolc_prefix
If ADOL-C is installed on your system, you can specify a value for its install `adolc_prefix` on the cmake command line. The value of `adolc_prefix` must be such that, for one of the directories `dir` in cmake_install_includedirs , `
adolc_prefix/dir/adolc/adouble.h
` is a valid way to reference to the include file `adouble.h`; Note that CppAD assumes ADOL-C has been configured with its sparse matrix computations enabled; i.e, using `
--with-colpack=adolc_prefix
` In other words ColPack is installed and with the same prefix as ACOL-C; see get_colpack.sh .
Examples
If you include `adolc_prefix` on the cmake command line, you will be able to run the ADOL-C examples listed above by executing the following commands starting in the distribution directory : `
cd build/example
make check_example
` If you do this, you will see an indication that the examples `mul_level_adolc` and `mul_level_adolc_ode` have passed their correctness check.
Speed Tests
If you include `adolc_prefix` on the cmake command line, you will be able to run the ADOL-C speed correctness tests by executing the following commands starting in the distribution directory : `
cd build/speed/adolc
make check_speed_adolc
` After executing `make check_speed_adolc`, you can run a specific ADOL-C speed tests by executing the command `./speed_adolc`; see speed_main for the meaning of the command line options to this program.
Unix
If you are using Unix, you may have to add `adolc_prefix` to `LD_LIBRARY_PATH`. For example, if you use the `bash` shell to run your programs, you could include `
LD_LIBRARY_PATH=adolc_prefix/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH
` in your `$HOME/.bashrc` file.
Cygwin
If you are using Cygwin, you may have to add to following lines to the file `.bashrc` in your home directory: `
PATH=adolc_prefix/bin:${PATH}
export PATH
` in order for ADOL-C to run properly. If `adolc_prefix` begins with a disk specification, you must use the Cygwin format for the disk specification. For example, if `d:/adolc_base` is the proper directory, `/cygdrive/d/adolc_base` should be used for `adolc_prefix` .
get_adolc
If you are using Unix, you can download and install a copy of Adolc using get_adolc.sh . The corresponding `adolc_prefix` would be `build/prefix`.

Input File: omh/install/adolc_prefix.omh