AD Output Stream Operator
Keywords: ad output stream operator << syntax purpose assumption os x result operation sequence example

| Prev | Next |  |  |  |  |  |  |

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<Base> y
` 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/local/ad_io.hpp