Codebase list cppad / upstream/2016.00.00.0 omh / addon.omh
upstream/2016.00.00.0

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

addon.omh @upstream/2016.00.00.0raw · history · blame

// $Id$
/* --------------------------------------------------------------------------
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 addon$$
$spell
	Addons
	addon
	libdir
	includedir
	libcppad
	adcomp
	CppAD
	cppad.hpp
	ons
	namespace
	cg
	pycppad
$$


$section CppAD Addons$$

$head Name$$
Each CppAD addon has a short name which we denote by $icode name$$ below,
a longer name $icode longer$$ and a $icode description$$:

$table
$icode name$$  $pre  $$ $cnext
$icode longer$$ $pre  $$ $cnext
$icode description$$
$rnext
$href%https://github.com/joaoleal/CppADCodeGen/%cg%$$ $cnext
	$code CppADCodeGen$$ $cnext
	C++ Source Code Generation of CppAD Derivative Calculations
$rnext
$href%http://www.seanet.com/~bradbell/pycppad/pycppad.htm%py%$$ $cnext
	$code pycppad$$ $cnext
	A Python Interface to CppAD
$rnext
$href%https://github.com/kaskr/adcomp%tmb%$$ $cnext
	$code adcomp$$ $cnext
	An R Interface to CppAD with Random Effects Modeling Utilities
$rnext
$href%http://moby.ihme.washington.edu/bradbell/cppad_mixed%mixed%$$
	$cnext $code cppad_mixed$$ $cnext
	A C++ Interface to Random Effects Laplace Approximation
$tend

$head Include Files$$
If $icode includedir$$ is the directory where the include files are installed,
the file
$codei%
	%includedir%/cppad/%name%.hpp
%$$
and the directory
$codei%
	%includedir%/cppad/%name%
%$$
are reserved for use by the $icode name$$ addon.

$head Library Files$$
If $icode libdir$$ is the directory where CppAD library files are installed,
files with the name
$codei%
	%libdir%/libcppad_%name%.%ext%
	%libdir%/libcppad_%name%_%anything%.%ext%
%$$
where $icode anything$$ and $icode ext$$ are arbitrary,
are reserved for use by the $icode name$$ addon.

$head Preprocessor Symbols$$
C++ preprocessor symbols that begin with
$codei%
	CPPAD_%NAME%_
%$$
where $icode NAME$$ is a upper-case version of $icode name$$,
are reserved for use by the $icode name$$ addon.

$head Namespace$$
The C++ namespace
$codei%
	CppAD::%name%
%$$
is reserved for use by the $icode name$$ addon.


$end