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

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

#include <Sacado_Fad_DMFad.hpp>

Inheritance diagram for Sacado::Fad::DMFad< ValueT >:

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

Public Types
typedef MemPoolStorage< ValueT >	StorageType
	Base classes. More...
typedef GeneralFad< ValueT, StorageType >	GeneralFadType
typedef Expr< GeneralFadType >	ExprType
typedef ExprType::value_type	value_type
	Typename of values. More...
typedef ExprType::scalar_type	scalar_type
	Typename of scalar's (which may be different from value_type) More...
typedef ScalarType< ValueT >::type	ScalarT
	Typename of scalar's (which may be different from ValueT) More...
Public Types inherited from Sacado::Fad::Expr< GeneralFad< ValueT, MemPoolStorage< ValueT > > >
typedef GeneralFad< ValueT, MemPoolStorage< ValueT > >	value_type

Public Member Functions
	~DMFad ()
	Destructor. More...

Initialization methods
	DMFad ()
	Default constructor. More...
template<typename S >
	DMFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value x convertible to ValueT. More...
	DMFad (const int sz, const ValueT &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz and value x. More...
	DMFad (const int sz, const int i, const ValueT &x)
	Constructor with size sz, index i, and value x. More...
	DMFad (const DMFad &x)
	Copy constructor. More...
template<typename S >
	DMFad (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object. More...

Detailed Description

template<typename ValueT>
class Sacado::Fad::DMFad< 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::GeneralFad.

Definition at line 68 of file Sacado_Fad_DMFad.hpp.

Member Typedef Documentation

template<typename ValueT>

typedef MemPoolStorage<ValueT> Sacado::Fad::DMFad< ValueT >::StorageType

Base classes.

Definition at line 73 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

typedef GeneralFad<ValueT,StorageType> Sacado::Fad::DMFad< ValueT >::GeneralFadType

Definition at line 74 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

typedef Expr<GeneralFadType> Sacado::Fad::DMFad< ValueT >::ExprType

Definition at line 75 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

typedef ExprType::value_type Sacado::Fad::DMFad< ValueT >::value_type

Typename of values.

Definition at line 78 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

typedef ExprType::scalar_type Sacado::Fad::DMFad< ValueT >::scalar_type

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

Definition at line 81 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

typedef ScalarType<ValueT>::type Sacado::Fad::DMFad< ValueT >::ScalarT

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

Definition at line 84 of file Sacado_Fad_DMFad.hpp.

Constructor & Destructor Documentation

template<typename ValueT>

Sacado::Fad::DMFad< ValueT >::DMFad ( )

inline

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 101 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

template<typename S >

Sacado::Fad::DMFad< ValueT >::DMFad ( const S &  x, SACADO_ENABLE_VALUE_CTOR_DECL    )

inline

Constructor with supplied value x convertible to ValueT.

Initializes value to ValueT(x) and derivative array is empty.

Definition at line 109 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

Sacado::Fad::DMFad< ValueT >::DMFad ( const int  sz, const ValueT &  x, const DerivInit  zero_out = InitDerivArray  )

inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 116 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

Sacado::Fad::DMFad< ValueT >::DMFad ( 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 125 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

Sacado::Fad::DMFad< ValueT >::DMFad ( const DMFad< ValueT > &  x )

inline

Copy constructor.

Definition at line 129 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

template<typename S >

Sacado::Fad::DMFad< ValueT >::DMFad ( const Expr< S > &  x, SACADO_ENABLE_EXPR_CTOR_DECL    )

inline

Copy constructor from any Expression object.

Definition at line 134 of file Sacado_Fad_DMFad.hpp.

template<typename ValueT>

Sacado::Fad::DMFad< ValueT >::~DMFad ( )

inline

Destructor.

Definition at line 140 of file Sacado_Fad_DMFad.hpp.

---

The documentation for this class was generated from the following file:

• Sacado_Fad_DMFad.hpp