|
|
Prev | Next | InstallUnix |
cppad-20121230.
cppad-20121230/build,
which will be referred to as the build directory below.
./configure \
--prefix=prefix_dir \
--with-Documentation \
--with-testvector \
--with-sparse_option \
MAX_NUM_THREADS=max_num_threads \
CXX_FLAGS=cxx_flags \
OPENMP_FLAGS=openmp_flags \
POSTFIX_DIR=postfix_dir \
ADOLC_DIR=adolc_dir \
BOOST_DIR=boost_dir \
EIGEN_DIR=eigen_dir \
FADBAD_DIR=fadbad_dir \
SADADO_DIR=sacado_dir \
IPOPT_DIR=ipopt_dir \
TAPE_ADDR_TYPE=tape_addr_type \
TAPE_ID_TYPE=tape_id_type
configure line need appear; i.e.,
the entries in all of the other lines are optional.
The text in italic is replaced values that you choose;
see discussion below.
make
make command,
you can run the correctness and speed tests.
make test
| get_started | Getting Started Using CppAD to Compute Derivatives |
| exp_apx_main | Correctness Tests For Exponential Approximation in Introduction |
| example | CppAD Examples and Tests |
| print_for_cout | Printing During Forward Mode: Example and Test |
| speed_example | Run the Speed Examples |
| speed_double | Speed Test of Functions in Double |
| speed_adolc | Speed Test of Derivatives Using Adolc |
| speed_cppad | Speed Test Derivatives Using CppAD |
| speed_fadbad | Speed Test Derivatives Using Fadbad |
| speed_sacado | Speed Test Derivatives Using Sacado |
cd test_more
make test
cd speed/profile
make test
make test, you can run a profile speed test
by executing the command ./profile;
see speed_main
for the meaning of the command line
options to this program.
gprof -b profile
profile by profile.exe
in the gprof command above; i.e.,
gprof -b profile.exe
gprof output hard to read
(the routine names can be very long).
You can remove the template parameters and argument types from the
routine names by executing the following command
gprof -b profile | sed -f gprof.sed
gprof -b profile.exe | sed -f gprof.sed
$HOME
i.e., by default the CppAD include files
will install
below $HOME.
If you want to install elsewhere, you will have to use this option.
As an example of using the
--prefix=prefix_dir
option,
if you specify
./configure --prefix=/usr/local
/usr/local/include/cppad
/usr/local/share/doc/cppad-20121230
--with-Documentation is specified,
the CppAD documentation HTML and XML files are copied to the directory
prefix_dir/share/doc/postfix_dir/cppad-20121230
prefix_dir/share/doc/postfix_dir/cppad-20121230/cppad.htm
prefix_dir/share/doc/postfix_dir/cppad-20121230/cppad.xml
CppAD::vector<Scalar>
.
If one, and only one, of the following command line arguments is specified:
--with-stdvector
--with-boostvector
--with-eigenvector
std::vector<Scalar>
boost::numeric::ublas::vector<Scalar>
Eigen::matrix<Scalar, Eigen::Dynamic, 1>
CPPAD_INTERNAL_SPARSE_SET.
If --with-sparse_set
(--with-sparse_list) is specified,
this symbol is sparse_set (sparse_list).
This should affect the speed and memory required by the
sparse_jacobian
, sparse_hessian
, and the
sparse drivers
.
max_num_threads >= 4
.
CompilerFlags
is present,
it specifies compiler flags.
For example,
CXX_FLAGS="-Wall -ansi"
-Wall
and -ansi should be included
in all the C++ compile commands.
The error and warning flags chosen must be valid options
for the C++ compiler.
The default value for
CompilerFlags
is the
empty string.
OpenmpFlags
is present,
it specifies the necessary flags so that the compiler will
properly interpret OpenMP directives.
For example, when using the GNU g++ compiler,
the following setting includes the OpenMP tests:
OPENMP_FLAGS=-fopenmp
POSTFIX_DIR=postfix_dir
option,
if you specify
./configure --prefix=/usr/local POSTFIX_DIR=coin
/usr/local/include/coin/cppad
/usr/local/share/doc/coin/cppad-20121230
adolc_dir
in the
configure
command line.
The value of
adolc_dir
must be such that
adolc_dir/include/adolc/adouble.h
adouble.h.
In this case, you can run the Adolc speed correctness tests
by executing the following commands starting in the build directory:
cd speed/adolc
make test
make test, you can run an Adolc speed tests
by executing the command ./adolc;
see speed_main
for the meaning of the command line
options to this program.
Note that these speed tests assume Adolc has been configure with
its sparse matrix computations enabled using
--with-colpack=colpack_dir
adolc_dir/lib
to LD_LIBRARY_PATH.
For example, if you use the bash shell to run your programs,
you could include
LD_LIBRARY_PATH=adolc_dir/lib:${LD_LIBRARY_PATH}
export LD_LIBRARY_PATH
$HOME/.bash_profile file.
.bash_profile in your home directory:
PATH=adolc_dir/bin:${PATH}
export PATH
adolc_dir
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_dir
.
BOOST_DIR=boost_dir
boost_dir/include/boost/numeric/ublas/vector.hpp
boost_dir/include/boost/thread.hpp
eigen_dir
.
It must be such that
eigen_dir/include/Eigen/Core
fadbad_dir
.
It must be such that
fadbad_dir/include/FADBAD++/badiff.h
badiff.h.
In this case, you can run the Fadbad speed correctness tests
by executing the following commands starting in the build directory:
cd speed/fadbad
make test
make test, you can run a Fadbad speed tests
by executing the command ./fadbad;
see speed_main
for the meaning of the command line
options to this program.
ipopt_dir
.
It must be such that
ipopt_dir/include/coin/IpIpoptApplication.hpp
IpIpoptApplication.hpp.
In this case, the CppAD interface to Ipopt
examples
can be built and tested
by executing the following commands starting in the build directory:
make
#
cd cppad_ipopt/example
make test
#
cd ../test
make test
#
cd ../speed
make test
./speed in the build/cppad_ipopt/speed directory;
see ipopt_ode_speed.cpp
.
sacado_dir
.
It must be such that
sacado_dir/include/Sacado.hpp
Sacado.hpp.
In this case, you can run the Sacado speed correctness tests
by executing the following commands starting in the build directory:
cd speed/sacado
make test
make test, you can run a Sacado speed tests
by executing the command ./sacado;
see speed_main
for the meaning of the command line
options to this program.
tape_addr_type
is present,
it specifies the type used for address in the AD recordings (tapes).
The valid values for this argument are
unsigned short int,
unsigned int,
size_t.
The smaller the value of
sizeof(tape_addr_type)
,
the less memory is used.
On the other hand, the value
std::numeric_limits<tape_addr_type>::max()
tape_id_type
is present,
it specifies the type used for identifying tapes.
The valid values for this argument are
unsigned short int,
unsigned int,
size_t.
The smaller the value of
sizeof(tape_id_type)
,
the less memory is used.
On the other hand, the value
std::numeric_limits<tape_id_type>::max()
make install
prefix_dir
directory to execute this command.
You may optionally specify a destination directory for the install; i.e.,
make install DESTDIR=DestinationDirectory