1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2003-24 Bradley M. Bell
# ----------------------------------------------------------------------------
{xrst_begin addon app}
{xrst_spell
adcomp
addons
cg
ext
includedir
libcppad
libdir
py
pycppad
tmb
}
CppAD Addons
############
Name
****
Each CppAD addon has a short name which we denote by *name* below,
a longer name *longer* and a *description* :
.. list-table::
:widths: auto
* - *name*
- *longer*
- *description*
* - `tmb <https://github.com/kaskr/adcomp>`_
- ``adcomp``
- An R Interface to CppAD with Random Effects Modeling Utilities
* - `cg <https://github.com/joaoleal/CppADCodeGen/>`_
- ``CppADCodeGen``
- C++ Source Code Generation of CppAD Derivative Calculations
* - `mixed <https://bradbell.github.io/cppad_mixed>`_
- ``cppad_mixed``
- A C++ Interface to Random Effects Laplace Approximation
* - `cppad_py <https://cppad-py.readthedocs.io>`_
- ``cppad_py``
- A Python Interface to CppAD
* - `swig <https://bradbell.github.io/cppad_swig>`_
- ``cppad_swig``
- A C++ AD Library with a Swig Interface to Perl, Octave, and Python
(no longer being developed)
* - `pycppad <https://github.com/b45ch1/pycppad>`_
- ``pycppad``
- A Python Interface to CppAD (no longer being developed)
Include Files
*************
If *includedir* is the directory where the include files are installed,
the file
*includedir* / ``include/cppad/`` *name* . ``hpp``
and the directory
*includedir* / ``include/cppad/`` *name*
are reserved for use by the *name* addon.
Library Files
*************
If *libdir* is the directory where CppAD library files are installed,
files with the name
| |tab| *libdir* / ``libcppad_`` *name* . *ext*
| |tab| *libdir* / ``libcppad_`` *name* _ *anything* . *ext*
where *anything* and *ext* are arbitrary,
are reserved for use by the *name* addon.
Preprocessor Symbols
********************
C++ preprocessor symbols that begin with
``CPPAD_`` *NAME* _
where *NAME* is a upper-case version of *name* ,
are reserved for use by the *name* addon.
Namespace
*********
The C++ namespace
``CppAD::`` *name*
is reserved for use by the *name* addon.
{xrst_end addon}
|
