source: trunk/omh/preprocessor.omh @ 2859

Last change on this file since 2859 was 2859, checked in by bradbell, 7 years ago

merge in changes from branches/atomic; see bin/svn_merge.sh

  • Property svn:keywords set to Id
File size: 2.6 KB
Line 
1/* $Id: preprocessor.omh 2859 2013-05-28 06:03:21Z bradbell $ */
2/* --------------------------------------------------------------------------
3CppAD: C++ Algorithmic Differentiation: Copyright (C) 2003-13 Bradley M. Bell
4
5CppAD is distributed under multiple licenses. This distribution is under
6the terms of the
7                    Eclipse Public License Version 1.0.
8
9A copy of this license is included in the COPYING file of this distribution.
10Please visit http://www.coin-or.org/CppAD/ for information on other licenses.
11-------------------------------------------------------------------------- */
12$begin preprocessor$$
13$spell
14        const
15        nullptr
16        CppADvector
17        Vec
18$$
19
20$section CppAD API Preprocessor Symbols$$
21$index preprocessor, CPPAD_ symbol$$
22$index symbol, preprocessor CPPAD_$$
23$index CPPAD_, preprocessor symbol$$
24
25$head Purpose$$
26The CppAD include files define preprocessor symbols all of which begin
27with $code CPPAD_$$.
28Note that there are some old, deprecated preprocessor symbols that
29begin with $code CppAD$$.
30In this section we list all of the CppAD preprocessor symbols that
31are part of the CppAD Application Interface (API).
32
33$head Documented Here$$
34
35$subhead CPPAD_NULL$$
36$index NULL, pointer$$
37$index CPPAD_NULL$$
38Is a null pointer used by CppAD,
39instead of just using the value zero which was often done in C++98,
40which has been replaced by the value $code nullptr$$ in C++11.
41
42$head CPPAD_PACKAGE_STRING$$
43Is a $code const char*$$ representation of this version of CppAD.
44
45
46$head Documented Elsewhere$$
47$table
48$cref/CPPAD_BOOL_UNARY/BoolFun/Create Unary/$$
49$rnext
50$cref/CPPAD_BOOL_UNARY/BoolFun/Create Binary/$$
51$rnext
52$cref/CPPAD_DISCRETE_FUNCTION/Discrete/$$
53$rnext
54$cref/CPPAD_MAX_NUM_THREADS/multi_thread/CPPAD_MAX_NUM_THREADS/$$
55$rnext
56$cref/CPPAD_TAPE_ADDR_TYPE/cmake/cppad_tape_addr_type/$$
57$rnext
58$cref/CPPAD_TAPE_ID_TYPE/cmake/cppad_tape_id_type/$$
59$rnext
60$cref/CPPAD_TESTVECTOR/testvector/$$
61$rnext
62$cref/CPPAD_USER_ATOMIC/old_atomic/$$
63$tend
64
65$head Deprecated$$
66$table
67$cref/CppADCreateDiscrete/Discrete/Deprecated/$$
68$rnext
69$cref/CppADvector/test_vector/Deprecated/$$
70$rnext
71$cref/CPPAD_TEST_VECTOR/test_vector/$$
72$rnext
73$cref/CPPAD_TRACK_NEW_VEC/TrackNewDel/TrackNewVec/Macro/$$
74$rnext
75$cref/CPPAD_TRACK_DEL_VEC/TrackNewDel/TrackDelVec/Macro/$$
76$rnext
77$cref/CPPAD_TRACK_EXTEND/TrackNewDel/TrackExtend/Macro/$$
78$rnext
79$cref/CPPAD_TRACK_COUNT/TrackNewDel/TrackCount/Macro/$$
80$rnext
81$cref/CppADTrackNewVec/TrackNewDel/TrackNewVec/Previously Deprecated/$$
82$rnext
83$cref/CppADTrackDelVec/TrackNewDel/TrackDelVec/Previously Deprecated/$$
84$rnext
85$cref/CppADTrackExtend/TrackNewDel/TrackExtend/Previously Deprecated/$$
86$rnext
87$cref/CppADTrackCount/TrackNewDel/TrackCount/Previously Deprecated/$$
88$tend
89
90
91$end
Note: See TracBrowser for help on using the repository browser.