Prev Next

@(@\newcommand{\W}[1]{ \; #1 \; } \newcommand{\R}[1]{ {\rm #1} } \newcommand{\B}[1]{ {\bf #1} } \newcommand{\D}[2]{ \frac{\partial #1}{\partial #2} } \newcommand{\DD}[3]{ \frac{\partial^2 #1}{\partial #2 \partial #3} } \newcommand{\Dpow}[2]{ \frac{\partial^{#1}}{\partial {#2}^{#1}} } \newcommand{\dpow}[2]{ \frac{ {\rm d}^{#1}}{{\rm d}\, {#2}^{#1}} }@)@
AD Output Stream Operator

Syntax
os << x

Purpose
Writes the Base value, corresponding to x , to the output stream os .

Assumption
If b is a Base object,
     
os << b
returns a reference to os .

os
The operand os has prototype
     std::ostream& 
os

x
The operand x has one of the following prototypes
     const AD<
Base>&               x
     const VecAD<
Base>::reference& x

Result
The result of this operation can be used as a reference to os . For example, if the operand y has prototype
     AD<
Basey
then the syntax
     
os << x << y
will output the value corresponding to x followed by the value corresponding to y .

Operation Sequence
The result of this operation is not an AD of Base object. Thus it will not be recorded as part of an AD of Base operation sequence .

Example
The file ad_output.cpp contains an example and test of this operation. It returns true if it succeeds and false otherwise.
Input File: cppad/core/ad_io.hpp