Codebase list cppad / upstream/2014.03.29 omh / example.omh
upstream/2014.03.29

Tree @upstream/2014.03.29 (Download .tar.gz)

example.omh @upstream/2014.03.29raw · history · blame

$Id: example.omh 2506 2012-10-24 19:36:49Z bradbell $
/* --------------------------------------------------------------------------
CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-12 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 Example$$
$spell
	CppAD
	Cygwin
	Microsoft
	chdir
	nmake
	mak
	Workspace
	dsw
	exe
	Example example
$$

$section Examples$$
$index example$$


$head Introduction$$
This section organizes the information related to the CppAD examples.
Each CppAD operation has its own specific example,
for example $cref add.cpp$$ is an example for 
$cref/addition/ad_binary/$$.
Some of the examples are of a more general nature
(not connected of a specific feature of CppAD).
In addition, there are some utility functions that are used
by the examples.

$head Running Examples$$
The 
$cref/installation instructions/Install/$$
show how the examples can be run on your system.


$head The CppAD Test Vector Template Class$$
Many of the examples use the 
$small $cref/CPPAD_TESTVECTOR/testvector/$$ $$ preprocessor symbol 
to determine which $cref SimpleVector$$ template class is used with
the examples. 


$contents%
	omh/example_list.omh%
	cppad/local/testvector.hpp
%$$


$end