Sacado Package Browser (Single Doxygen Collection) Version of the Day
Classes | Public Types | Public Member Functions
Sacado::CacheFad::DFad< ValueT > Class Template Reference

Forward-mode AD class using dynamic memory allocation and caching expression templates. More...

#include <Sacado_CacheFad_DFad.hpp>

Inheritance diagram for Sacado::CacheFad::DFad< ValueT >:
Inheritance graph
[legend]

List of all members.

Classes

struct  apply
 Turn DFad into a meta-function class usable with mpl::apply. More...

Public Types

typedef ScalarType< ValueT >::type ScalarT
 Typename of scalar's (which may be different from ValueT)
typedef GeneralFad< ValueT,
Fad::DynamicStorage< ValueT >
>::value_type 
value_type
typedef GeneralFad< ValueT,
Fad::DynamicStorage< ValueT >
>::scalar_type 
scalar_type

Public Member Functions

 ~DFad ()
 Destructor.
DFadoperator= (const ValueT &v)
 Assignment operator with constant right-hand-side.
DFadoperator= (const typename dummy< ValueT, ScalarT >::type &v)
 Assignment operator with constant right-hand-side.
DFadoperator= (const DFad &x)
 Assignment operator with DFad right-hand-side.
template<typename S >
DFadoperator= (const Expr< S > &x)
 Assignment operator with any expression right-hand-side.

Initialization methods

 DFad ()
 Default constructor.
 DFad (const ValueT &x)
 Constructor with supplied value x of type ValueT.
 DFad (const typename dummy< ValueT, ScalarT >::type &x)
 Constructor with supplied value x of type ScalarT.
 DFad (const int sz, const ValueT &x)
 Constructor with size sz and value x.
 DFad (const int sz, const int i, const ValueT &x)
 Constructor with size sz, index i, and value x.
 DFad (const DFad &x)
 Copy constructor.
template<typename S >
 DFad (const Expr< S > &x)
 Copy constructor from any Expression object.

Detailed Description

template<typename ValueT>
class Sacado::CacheFad::DFad< ValueT >

Forward-mode AD class using dynamic memory allocation and caching expression templates.

This is a user-level class for forward mode AD with dynamic memory allocation, and is appropriate for whenever the number of derivative components is not known at compile time. The user interface is provided by Sacado::CacheFad::GeneralFad. It is similar to Sacado::Fad::DFad, except it uses the caching expression templates that cache the results of val() calculations for later dx() calculations.

Definition at line 58 of file Sacado_CacheFad_DFad.hpp.


Member Typedef Documentation

template<typename ValueT>
typedef ScalarType<ValueT>::type Sacado::CacheFad::DFad< ValueT >::ScalarT

Typename of scalar's (which may be different from ValueT)

Definition at line 64 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
typedef GeneralFad<ValueT,Fad::DynamicStorage<ValueT> >::value_type Sacado::CacheFad::DFad< ValueT >::value_type

Definition at line 65 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
typedef GeneralFad<ValueT,Fad::DynamicStorage<ValueT> >::scalar_type Sacado::CacheFad::DFad< ValueT >::scalar_type

Definition at line 66 of file Sacado_CacheFad_DFad.hpp.


Constructor & Destructor Documentation

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( ) [inline]

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 83 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( const ValueT &  x) [inline]

Constructor with supplied value x of type ValueT.

Initializes value to x and derivative array is empty

Definition at line 90 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( const typename dummy< ValueT, ScalarT >::type &  x) [inline]

Constructor with supplied value x of type ScalarT.

Initializes value to ValueT(x) and derivative array is empty. Creates a dummy overload when ValueT and ScalarT are the same type.

Definition at line 98 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( const int  sz,
const ValueT &  x 
) [inline]

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 105 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( const int  sz,
const int  i,
const ValueT &  x 
) [inline]

Constructor with size sz, index i, and value x.

Initializes value to x and derivative array of length sz as row i of the identity matrix, i.e., sets derivative component i to 1 and all other's to zero.

Definition at line 114 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::DFad ( const DFad< ValueT > &  x) [inline]

Copy constructor.

Definition at line 118 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
template<typename S >
Sacado::CacheFad::DFad< ValueT >::DFad ( const Expr< S > &  x) [inline]

Copy constructor from any Expression object.

Definition at line 122 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
Sacado::CacheFad::DFad< ValueT >::~DFad ( ) [inline]

Destructor.

Definition at line 128 of file Sacado_CacheFad_DFad.hpp.


Member Function Documentation

template<typename ValueT>
DFad& Sacado::CacheFad::DFad< ValueT >::operator= ( const ValueT &  v) [inline]

Assignment operator with constant right-hand-side.

Definition at line 131 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
DFad& Sacado::CacheFad::DFad< ValueT >::operator= ( const typename dummy< ValueT, ScalarT >::type &  v) [inline]

Assignment operator with constant right-hand-side.

Creates a dummy overload when ValueT and ScalarT are the same type.

Definition at line 140 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
DFad& Sacado::CacheFad::DFad< ValueT >::operator= ( const DFad< ValueT > &  x) [inline]

Assignment operator with DFad right-hand-side.

Definition at line 146 of file Sacado_CacheFad_DFad.hpp.

template<typename ValueT>
template<typename S >
DFad& Sacado::CacheFad::DFad< ValueT >::operator= ( const Expr< S > &  x) [inline]

Assignment operator with any expression right-hand-side.

Definition at line 152 of file Sacado_CacheFad_DFad.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines