Sacado::Fad::DVFad< ValueT > Class Template Reference

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

#include <Sacado_Fad_DVFad.hpp>

Inheritance diagram for Sacado::Fad::DVFad< ValueT >:
Inheritance graph
[legend]

List of all members.

Classes

struct  apply
 Turn DVFad 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).

Public Member Functions

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

Initialization methods



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

Detailed Description

template<typename ValueT>
class Sacado::Fad::DVFad< ValueT >

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

This is the 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::Fad::GeneralVFad.

Definition at line 55 of file Sacado_Fad_DVFad.hpp.


Member Typedef Documentation

template<typename ValueT>
typedef ScalarType<ValueT>::type Sacado::Fad::DVFad< ValueT >::ScalarT

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

Definition at line 61 of file Sacado_Fad_DVFad.hpp.


Constructor & Destructor Documentation

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad (  )  [inline]

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 78 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( const ValueT &  x  )  [inline]

Constructor with supplied value x of type ValueT.

Initializes value to x and derivative array is empty

Definition at line 85 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( 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 93 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( 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 100 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( 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 109 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( const int  sz,
ValueT *  x,
ValueT *  dx,
bool  zero_out = false 
) [inline]

Constructor with supplied memory.

Initializes value to point to x and derivative array to point todx. Derivative array is zero'd out if zero_out is true.

Definition at line 117 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( const int  sz,
const int  i,
ValueT *  x,
ValueT *  dx 
) [inline]

Constructor with supplied memory and index i.

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

Definition at line 126 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::DVFad ( const DVFad< ValueT > &  x  )  [inline]

Copy constructor.

Definition at line 130 of file Sacado_Fad_DVFad.hpp.

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

Copy constructor from any Expression object.

Definition at line 134 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
Sacado::Fad::DVFad< ValueT >::~DVFad (  )  [inline]

Destructor.

Definition at line 140 of file Sacado_Fad_DVFad.hpp.


Member Function Documentation

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

Assignment operator with constant right-hand-side.

Definition at line 143 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>
DVFad& Sacado::Fad::DVFad< 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 152 of file Sacado_Fad_DVFad.hpp.

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

Assignment operator with DVFad right-hand-side.

Definition at line 158 of file Sacado_Fad_DVFad.hpp.

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

Assignment operator with any expression right-hand-side.

Definition at line 164 of file Sacado_Fad_DVFad.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:44 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3