// $Id: testvector.omh 3757 2015-11-30 12:03:07Z bradbell $
/* --------------------------------------------------------------------------
CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-15 Bradley M. Bell

CppAD is distributed under multiple licenses. This distribution is under
the terms of the
                    GNU General Public License Version 3.

A copy of this license is included in the COPYING file of this distribution.
Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
-------------------------------------------------------------------------- */
$begin cppad_testvector$$
$spell
	CppAD
	cppad
	eigen
	std
	testvector
	namespace
	cmake
$$

$section Choosing the CppAD Test Vector Template Class$$

$head Purpose$$
The value $icode cppad_testvector$$
in the $cref/cmake command/cmake/CMake Command/$$ must be one of the
following:
$code boost$$, $code cppad$$, $code eigen$$, or $code std$$.
It specifies which type of vector is corresponds to the template class
$cref/CPPAD_TESTVECTOR/testvector/$$
which is used for many of the CppAD examples and tests.

$head std$$
If $icode%cppad_testvector%$$ is $icode std$$,
the $code std::vector$$ template class is used to define
$code CPPAD_TESTVECTOR$$.

$head cppad$$
If $icode%cppad_testvector%$$ is $icode cppad$$,
the $cref cppad_vector$$ template class is used to define
$code CPPAD_TESTVECTOR$$.

$head boost$$
If $icode%cppad_testvector%$$ is $icode boost$$,
$href%
	http://www.boost.org/doc/libs/1_52_0/libs/numeric/ublas/doc/vector.htm%
	boost ublas vector
%$$
template class is used to define
$code CPPAD_TESTVECTOR$$.
In this case, the
$href%
	http://www.cmake.org/cmake/help/cmake2.6docs.html#module:FindBoost%
	cmake FindBoost
%$$
module must be able to automatically figure out where Boost is installed.

$head eigen$$
If $icode%cppad_testvector%$$ is $icode eigen$$,
one of the eigen template classes is used to define
$code CPPAD_TESTVECTOR$$.
In this case,
$cref eigen_prefix$$ must be specified on the $code cmake$$ command line.


$end
