<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Construct an ADFun Object and Stop Recording</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Construct an ADFun Object and Stop Recording"/>
<meta name="keywords" id="keywords" content=" construct an adfun object and stop recording Adfun tape syntax purpose x y vectorad default constructor sequence copy assignment operator taylor coefficients sparsity patterns parallel mode example "/>
<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='_funconstruct_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="independent.cpp.xml" target="_top">Prev</a>
</td><td><a href="fun_assign.cpp.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-></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-></option>
<option>CppAD</option>
<option>ADFun</option>
<option>FunConstruct</option>
</select>
</td>
<td>
<select onchange='choose_down2(this)'>
<option>CppAD-></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>
<select onchange='choose_down1(this)'>
<option>ADFun-></option>
<option>Independent</option>
<option>FunConstruct</option>
<option>Dependent</option>
<option>abort_recording</option>
<option>seq_property</option>
<option>FunEval</option>
<option>Drivers</option>
<option>FunCheck</option>
<option>optimize</option>
<option>check_for_nan</option>
</select>
</td>
<td>
<select onchange='choose_down0(this)'>
<option>FunConstruct-></option>
<option>fun_assign.cpp</option>
</select>
</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-></option>
<option>Syntax</option>
<option>Purpose</option>
<option>x</option>
<option>y</option>
<option>VectorAD</option>
<option>Default Constructor</option>
<option>Sequence Constructor</option>
<option>Copy Constructor</option>
<option>Assignment Operator</option>
<option>---..Taylor Coefficients</option>
<option>---..Sparsity Patterns</option>
<option>Parallel Mode</option>
<option>Example</option>
<option>---..Sequence Constructor</option>
<option>---..Default Constructor</option>
<option>---..Assignment Operator</option>
</select>
</td>
</tr></table><br/>
<center><b><big><big>Construct an ADFun Object and Stop Recording</big></big></b></center>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>
<br/>
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'> = </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
The
<code><font color="blue"><span style='white-space: nowrap'>AD<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
object
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
can
store an AD of
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
<a href="glossary.xml#Operation.Sequence" target="_top"><span style='white-space: nowrap'>operation sequence</span></a>
.
It can then be used to calculate derivatives of the corresponding
<a href="glossary.xml#AD Function" target="_top"><span style='white-space: nowrap'>AD function</span></a>
<math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><mrow>
<mi mathvariant='italic'>F</mi>
<mo stretchy="false">:</mo>
<msup><mi mathvariant='italic'>B</mi>
<mi mathvariant='italic'>n</mi>
</msup>
<mo stretchy="false">→</mo>
<msup><mi mathvariant='italic'>B</mi>
<mi mathvariant='italic'>m</mi>
</msup>
</mrow></math>
where
<math xmlns="http://www.w3.org/1998/Math/MathML" display="inline"><mrow>
<mi mathvariant='italic'>B</mi>
</mrow></math>
is the space corresponding to objects of type
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
.
<br/>
<br/>
<b><big><a name="x" id="x">x</a></big></b>
<br/>
If the argument
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
is present, it has prototype
<code><font color="blue"><span style='white-space: nowrap'><br/>
     const </span></font><i><font color="black"><span style='white-space: nowrap'>VectorAD</span></font></i><font color="blue"><span style='white-space: nowrap'> &</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
It must be the vector argument in the previous call to
<a href="independent.xml" target="_top"><span style='white-space: nowrap'>Independent</span></a>
.
Neither its size, or any of its values, are allowed to change
between calling
<code><font color="blue"><span style='white-space: nowrap'><br/>
     Independent(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
and
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
<br/>
<b><big><a name="y" id="y">y</a></big></b>
<br/>
If the argument
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
is present, it has prototype
<code><font color="blue"><span style='white-space: nowrap'><br/>
     const </span></font><i><font color="black"><span style='white-space: nowrap'>VectorAD</span></font></i><font color="blue"><span style='white-space: nowrap'> &</span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
The sequence of operations that map
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
to
<code><i><font color="black"><span style='white-space: nowrap'>y</span></font></i></code>
are stored in the ADFun object
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
.
<br/>
<br/>
<b><big><a name="VectorAD" id="VectorAD">VectorAD</a></big></b>
<br/>
The type
<code><i><font color="black"><span style='white-space: nowrap'>VectorAD</span></font></i></code>
must be a <a href="simplevector.xml" target="_top"><span style='white-space: nowrap'>SimpleVector</span></a>
class with
<a href="simplevector.xml#Elements of Specified Type" target="_top"><span style='white-space: nowrap'>elements of type</span></a>
<code><font color="blue"><span style='white-space: nowrap'>AD<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
.
The routine <a href="checksimplevector.xml" target="_top"><span style='white-space: nowrap'>CheckSimpleVector</span></a>
will generate an error message
if this is not the case.
<br/>
<br/>
<b><big><a name="Default Constructor" id="Default Constructor">Default Constructor</a></big></b>
<br/>
The default constructor
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
creates an
<code><font color="blue"><span style='white-space: nowrap'>AD<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
object with no corresponding operation sequence; i.e.,
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_var()<br/>
</span></font></code>
returns the value zero (see <a href="seq_property.xml#size_var" target="_top"><span style='white-space: nowrap'>size_var</span></a>
).
<br/>
<br/>
<b><big><a name="Sequence Constructor" id="Sequence Constructor">Sequence Constructor</a></big></b>
<br/>
The sequence constructor
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
creates the
<code><font color="blue"><span style='white-space: nowrap'>AD<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
object
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
,
stops the recording of AD of
<code><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i></code>
operations
corresponding to the call
<code><font color="blue"><span style='white-space: nowrap'><br/>
     Independent(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
and stores the corresponding operation sequence in the object
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
.
It then stores the zero order Taylor coefficients
(corresponding to the value of
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
) in
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
.
This is equivalent to the following steps using the default constructor:
<ol type="1"><li>
Create
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
with the default constructor
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>;<br/>
</span></font></code>
</li><li>
Stop the tape and storing the operation sequence using
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.Dependent(</span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>);<br/>
</span></font></code>
(see <a href="dependent.xml" target="_top"><span style='white-space: nowrap'>Dependent</span></a>
).
</li><li>
Calculate the zero order Taylor coefficients for all
the variables in the operation sequence using
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.Forward(</span></font><i><font color="black"><span style='white-space: nowrap'>p</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>x_p</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
with
<code><i><font color="black"><span style='white-space: nowrap'>p</span></font></i></code>
equal to zero and the elements of
<code><i><font color="black"><span style='white-space: nowrap'>x_p</span></font></i></code>
equal to the corresponding elements of
<code><i><font color="black"><span style='white-space: nowrap'>x</span></font></i></code>
(see <a href="forward.xml" target="_top"><span style='white-space: nowrap'>Forward</span></a>
).
</li></ol>
<br/>
<br/>
<b><big><a name="Copy Constructor" id="Copy Constructor">Copy Constructor</a></big></b>
<br/>
It is an error to attempt to use the
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
copy constructor;
i.e., the following syntax is not allowed:
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'>(</span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
where
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
is an
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
object.
Use its <a href="funconstruct.xml#Default Constructor" target="_top"><span style='white-space: nowrap'>default constructor</span></a>
instead
and its assignment operator.
<br/>
<br/>
<b><big><a name="Assignment Operator" id="Assignment Operator">Assignment Operator</a></big></b>
<br/>
The
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
assignment operation
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'> = </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
makes a copy of the operation sequence currently stored in
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
in the object
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i></code>
.
The object
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
is not affected by this operation and
can be <code><font color="blue">const</font></code>.
All of information (state) stored in
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
is copied to
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i></code>
and any information originally in
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i></code>
is lost.
<br/>
<br/>
<b><a name="Assignment Operator.Taylor Coefficients" id="Assignment Operator.Taylor Coefficients">Taylor Coefficients</a></b>
<br/>
The Taylor coefficient information currently stored in
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
(computed by <a href="forward.xml" target="_top"><span style='white-space: nowrap'>f.Forward</span></a>
) is
copied to
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i></code>
.
Hence, directly after this operation
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_order() == </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_order()<br/>
</span></font></code>
<br/>
<b><a name="Assignment Operator.Sparsity Patterns" id="Assignment Operator.Sparsity Patterns">Sparsity Patterns</a></b>
<br/>
The forward Jacobian sparsity pattern currently stored in
<code><i><font color="black"><span style='white-space: nowrap'>f</span></font></i></code>
(computed by <a href="forsparsejac.xml" target="_top"><span style='white-space: nowrap'>f.ForSparseJac</span></a>
) is
copied to
<code><i><font color="black"><span style='white-space: nowrap'>g</span></font></i></code>
.
Hence, directly after this operation
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_forward_bool() == </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_forward_bool()<br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>g</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_forward_set()  == </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.size_forward_set()<br/>
</span></font></code>
<br/>
<b><big><a name="Parallel Mode" id="Parallel Mode">Parallel Mode</a></big></b>
<br/>
The call to <code><font color="blue">Independent</font></code>,
and the corresponding call to
<code><font color="blue"><span style='white-space: nowrap'><br/>
     ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>> </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>( </span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
or
<code><font color="blue"><span style='white-space: nowrap'><br/>
     </span></font><i><font color="black"><span style='white-space: nowrap'>f</span></font></i><font color="blue"><span style='white-space: nowrap'>.Dependent( </span></font><i><font color="black"><span style='white-space: nowrap'>x</span></font></i><font color="blue"><span style='white-space: nowrap'>, </span></font><i><font color="black"><span style='white-space: nowrap'>y</span></font></i><font color="blue"><span style='white-space: nowrap'>)<br/>
</span></font></code>
or <a href="abort_recording.xml" target="_top"><span style='white-space: nowrap'>abort_recording</span></a>
,
must be preformed by the same thread; i.e.,
<a href="ta_thread_num.xml" target="_top"><span style='white-space: nowrap'>thread_alloc::thread_num</span></a>
must be the same.
<br/>
<br/>
<b><big><a name="Example" id="Example">Example</a></big></b>
<br/>
<br/>
<b><a name="Example.Sequence Constructor" id="Example.Sequence Constructor">Sequence Constructor</a></b>
<br/>
The file
<a href="independent.cpp.xml" target="_top"><span style='white-space: nowrap'>independent.cpp</span></a>
contains an example and test of the sequence constructor.
It returns true if it succeeds and false otherwise.
<br/>
<br/>
<b><a name="Example.Default Constructor" id="Example.Default Constructor">Default Constructor</a></b>
<br/>
The files
<a href="fun_check.cpp.xml" target="_top"><span style='white-space: nowrap'>fun_check.cpp</span></a>
and
<a href="hes_lagrangian.cpp.xml" target="_top"><span style='white-space: nowrap'>hes_lagrangian.cpp</span></a>
contain an examples and tests using the default constructor.
They return true if they succeed and false otherwise.
<br/>
<br/>
<b><a name="Example.Assignment Operator" id="Example.Assignment Operator">Assignment Operator</a></b>
<br/>
The file
<a href="fun_assign.cpp.xml" target="_top"><span style='white-space: nowrap'>fun_assign.cpp</span></a>
contains an example and test of the
<code><font color="blue"><span style='white-space: nowrap'>ADFun<</span></font><i><font color="black"><span style='white-space: nowrap'>Base</span></font></i><font color="blue"><span style='white-space: nowrap'>></span></font></code>
assignment operator.
It returns true if it succeeds and false otherwise.
<hr/>Input File: cppad/local/fun_construct.hpp
</body>
</html>
