TMB Documentation  v1.9.10
Public Member Functions | List of all members
TMBad::ReverseArgs< Type > Struct Template Reference

Access input/output values and derivatives during a reverse pass. Write access granted for the input derivative only. More...

#include <global.hpp>

Public Member Functions

Type & dx (Index j)
 Partial derivative of end result wrt. j'th input variable of this operator.
 
Type * dx_ptr (Index j)
 pointer version - use with caution.
 
segment_ref< ReverseArgs, dx_write > dx_segment (Index from, Index size)
 segment version
 
Type dy (Index j) const
 Partial derivative of end result wrt. j'th output variable of this operator.
 
Type * dy_ptr (Index j)
 pointer version - use with caution.
 
segment_ref< ReverseArgs, dy_read > dy_segment (Index from, Index size)
 segment version
 
Type x (Index j) const
 j'th input variable of this operator
 
Type * x_ptr (Index j)
 pointer version - use with caution.
 
segment_ref< ReverseArgs, x_read > x_segment (Index from, Index size)
 segment version
 
Type y (Index j) const
 j'th output variable of this operator
 
Type * y_ptr (Index j)
 pointer version - use with caution.
 
segment_ref< ReverseArgs, y_read > y_segment (Index from, Index size)
 segment version
 
- Public Member Functions inherited from TMBad::Args<>
Index input (Index j) const
 Get variable index of j'th input to current operator.
 
Index output (Index j) const
 Get variable index of j'th output of current operator.
 

Additional Inherited Members

- Public Attributes inherited from TMBad::Args<>
const Index * inputs
 Array for indirect access of operator inputs.
 
IndexPair ptr
 Input/output pointers. More...
 

Detailed Description

template<class Type>
struct TMBad::ReverseArgs< Type >

Access input/output values and derivatives during a reverse pass. Write access granted for the input derivative only.

Warning
A ReverseArgs class instance becomes invalid if global::inputs, global::values or global::derivs are modified.

Definition at line 311 of file global.hpp.


The documentation for this struct was generated from the following file:
License: GPL v2