doc.omh

-------------------------------------------------------------------------------
          cppad_py: A C++ Object Library and Python Interface to Cppad
           Copyright (C) 2017-18 Bradley M. Bell (bradbell@seanet.com)
               This program is distributed under the terms of the
               GNU General Public License version 3.0 or later see
                     https://www.gnu.org/licenses/gpl-3.0.txt
-------------------------------------------------------------------------------
$begin cppad_py$$
$comment -------------------------------------------------------------
default automatic indexing command for all cppad_py documentaiton
$$
$aindex section head subhead$$
$comment -------------------------------------------------------------
Latex macros used throughout Cppad Py documentation
$$
$latex
\newcommand{\B}[1]{ {\bf #1} }
\newcommand{\R}[1]{ {\rm #1} }
$$
$comment -------------------------------------------------------------$$
$spell
	https
	bradbell
	usr
	Cppad
	Py
	Linux
	msys
	perl
	Cppad
	Py
	cmake
	Github
	xam
$$

$section cppad_py-20181110: A C++ Object Library and Python Interface to Cppad$$

$head Purpose$$
$list number$$
Provide a connection from Python
to the Algorithmic Differentiation (AD) package Cppad; see $cref py_lib$$.
$lnext
Provide an AD object library; see $cref cpp_lib$$.
$lnext
Prove a concrete example of how
$href%https://github.com/bradbell/cppad_swig%cppad_swig%$$
can be used to connect any scripting language to Cppad.
$lend

$head Under Construction$$
This version is preliminary and the user API is subject to change.
See $cref whats_new_2018$$ for changes.

$head Getting Started$$
The following is a good place to see what the interface is like:
$cref/Python/fun_jacobian_xam.py/$$.

$head C++ Function Speed$$
One can use Cppad Py to get faster function evaluation in scripting Python,
when the sequence of floating point operations does not depend on the
independent variables.
Once an $cref py_fun$$ is recorded, zero order
$cref/forward mode/py_fun_forward/$$ can be used to
effectively evaluate the function in C++ instead of Python.

$head License$$
This program is distributed under the terms of the
    GNU General Public License version 3.0 or later see
$href%http://www.gnu.org/licenses/gpl-3.0.txt%gpl-3.0.txt%$$.

$childtable%
	setup.py%
	lib/library.omh%
	whats_new/2018.omh
%$$


$end