Codebase list cppad / upstream/2015.00.00.7 doc / preprocessor.xml
upstream/2015.00.00.7

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

preprocessor.xml @upstream/2015.00.00.7raw · history · blame

<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>CppAD API Preprocessor Symbols</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="CppAD API Preprocessor Symbols"/>
<meta name="keywords" id="keywords" content=" cppad api preprocessor symbols Cppad_ symbol purpose documented here cppad_null Null pointer Cppad_null cppad_package_string elsewhere deprecated "/>
<style type='text/css'>
body { color : black }
body { background-color : white }
A:link { color : blue }
A:visited { color : purple }
A:active { color : purple }
</style>
<script type='text/javascript' language='JavaScript' src='_preprocessor_xml.js'>
</script>
</head>
<body>
<table><tr>
<td>
<a href="http://www.coin-or.org/CppAD/" target="_top"><img border="0" src="_image.gif"/></a>
</td>
<td><a href="check_for_nan.cpp.xml" target="_top">Prev</a>
</td><td><a href="multi_thread.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-&gt;</option>
<option>contents</option>
<option>reference</option>
<option>index</option>
<option>search</option>
<option>external</option>
</select>
</td>
<td>
<select onchange='choose_up0(this)'>
<option>Up-&gt;</option>
<option>CppAD</option>
<option>preprocessor</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>CppAD-&gt;</option>
<option>Install</option>
<option>Introduction</option>
<option>AD</option>
<option>ADFun</option>
<option>preprocessor</option>
<option>multi_thread</option>
<option>library</option>
<option>ipopt_solve</option>
<option>Example</option>
<option>speed</option>
<option>Appendix</option>
</select>
</td>
<td>preprocessor</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Purpose</option>
<option>Documented Here</option>
<option>---..CPPAD_NULL</option>
<option>CPPAD_PACKAGE_STRING</option>
<option>Documented Elsewhere</option>
<option>Deprecated</option>
</select>
</td>
</tr></table><br/>



<center><b><big><big>CppAD API Preprocessor Symbols</big></big></b></center>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
The CppAD include files define preprocessor symbols all of which begin
with <code><font color="blue">CPPAD_</font></code>.
Note that there are some old, deprecated preprocessor symbols that
begin with <code><font color="blue">CppAD</font></code>.
In this section we list all of the CppAD preprocessor symbols that
are part of the CppAD Application Interface (API).

<br/>
<br/>
<b><big><a name="Documented Here" id="Documented Here">Documented Here</a></big></b>


<br/>
<br/>
<b><a name="Documented Here.CPPAD_NULL" id="Documented Here.CPPAD_NULL">CPPAD_NULL</a></b>


<br/>
Is a null pointer used by CppAD,
instead of just using the value zero which was often done in C++98,
which has been replaced by the value <code><font color="blue">nullptr</font></code> in C++11.

<br/>
<br/>
<b><big><a name="CPPAD_PACKAGE_STRING" id="CPPAD_PACKAGE_STRING">CPPAD_PACKAGE_STRING</a></big></b>
<br/>
Is a <code><font color="blue">const char*</font></code> representation of this version of CppAD.


<br/>
<br/>
<b><big><a name="Documented Elsewhere" id="Documented Elsewhere">Documented Elsewhere</a></big></b>

<table><tr><td align='left'  valign='top'>

<a href="boolfun.xml#Create Binary" target="_top"><span style='white-space: nowrap'>CPPAD_BOOL_BINARY</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="boolfun.xml#Create Unary" target="_top"><span style='white-space: nowrap'>CPPAD_BOOL_UNARY</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="discrete.xml" target="_top"><span style='white-space: nowrap'>CPPAD_DISCRETE_FUNCTION</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="multi_thread.xml#CPPAD_MAX_NUM_THREADS" target="_top"><span style='white-space: nowrap'>CPPAD_MAX_NUM_THREADS</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="cmake.xml#cppad_tape_addr_type" target="_top"><span style='white-space: nowrap'>CPPAD_TAPE_ADDR_TYPE</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="cmake.xml#cppad_tape_id_type" target="_top"><span style='white-space: nowrap'>CPPAD_TAPE_ID_TYPE</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="testvector.xml" target="_top"><span style='white-space: nowrap'>CPPAD_TESTVECTOR</span></a>

</td></tr>
</table>
<br/>
<b><big><a name="Deprecated" id="Deprecated">Deprecated</a></big></b>

<table><tr><td align='left'  valign='top'>

<a href="discrete.xml#Deprecated" target="_top"><span style='white-space: nowrap'>CppADCreateDiscrete</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="test_vector.xml#Deprecated" target="_top"><span style='white-space: nowrap'>CppADvector</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="test_vector.xml" target="_top"><span style='white-space: nowrap'>CPPAD_TEST_VECTOR</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackNewVec.Macro" target="_top"><span style='white-space: nowrap'>CPPAD_TRACK_NEW_VEC</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackDelVec.Macro" target="_top"><span style='white-space: nowrap'>CPPAD_TRACK_DEL_VEC</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackExtend.Macro" target="_top"><span style='white-space: nowrap'>CPPAD_TRACK_EXTEND</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackCount.Macro" target="_top"><span style='white-space: nowrap'>CPPAD_TRACK_COUNT</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="old_atomic.xml" target="_top"><span style='white-space: nowrap'>CPPAD_USER_ATOMIC</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackNewVec.Previously Deprecated" target="_top"><span style='white-space: nowrap'>CppADTrackNewVec</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackDelVec.Previously Deprecated" target="_top"><span style='white-space: nowrap'>CppADTrackDelVec</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackExtend.Previously Deprecated" target="_top"><span style='white-space: nowrap'>CppADTrackExtend</span></a>

</td></tr><tr><td align='left'  valign='top'>

<a href="tracknewdel.xml#TrackCount.Previously Deprecated" target="_top"><span style='white-space: nowrap'>CppADTrackCount</span></a>

</td></tr>
</table>

<hr/>Input File: omh/preprocessor.omh

</body>
</html>