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

#include <Sacado_Fad_DFad_tmpl.hpp>

Inherits Expr< GeneralFad< ValueT, Fad::DynamicStorage< ValueT > > >.

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

struct	apply_N
	Replace static derivative length. More...

Public Types
typedef Fad::DynamicStorage < 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 Member Functions
SACADO_INLINE_FUNCTION	~DFad ()
	Destructor. More...

Initialization methods
SACADO_INLINE_FUNCTION	DFad ()
	Default constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	DFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value `x` convertible to ValueT. More...

SACADO_INLINE_FUNCTION	DFad (const int sz, const ValueT &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz` and value `x`. More...

SACADO_INLINE_FUNCTION	DFad (const int sz, const int i, const ValueT &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

SACADO_INLINE_FUNCTION	DFad (const DFad &x)
	Copy constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	DFad (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object. More...

Detailed Description

template<typename ValueT>
class Sacado::FAD_NS::DFad< 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_NS::GeneralFad.

Definition at line 30 of file Sacado_Fad_DFad_tmpl.hpp.

Member Typedef Documentation

template<typename ValueT >

typedef Fad::DynamicStorage<ValueT> Sacado::FAD_NS::DFad< ValueT >::StorageType

Base classes.

Definition at line 36 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

typedef GeneralFad<ValueT,StorageType> Sacado::FAD_NS::DFad< ValueT >::GeneralFadType

Definition at line 37 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

typedef Expr<GeneralFadType> Sacado::FAD_NS::DFad< ValueT >::ExprType

Definition at line 38 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

typedef ExprType::value_type Sacado::FAD_NS::DFad< ValueT >::value_type

Typename of values.

Definition at line 41 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

typedef ExprType::scalar_type Sacado::FAD_NS::DFad< ValueT >::scalar_type

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

Definition at line 44 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

typedef ScalarType<ValueT>::type Sacado::FAD_NS::DFad< ValueT >::ScalarT

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

Definition at line 47 of file Sacado_Fad_DFad_tmpl.hpp.

Constructor & Destructor Documentation

template<typename ValueT >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::DFad ( )

inline

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 71 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

template<typename S >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::DFad	(	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 80 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::DFad	(	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 88 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::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 98 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::DFad ( const DFad< ValueT > & x )

inline

Copy constructor.

Definition at line 103 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

template<typename S >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::DFad	(	const Expr< S > &	x,
		SACADO_ENABLE_EXPR_CTOR_DECL
	)

inline

Copy constructor from any Expression object.

Definition at line 109 of file Sacado_Fad_DFad_tmpl.hpp.

template<typename ValueT >

SACADO_INLINE_FUNCTION Sacado::FAD_NS::DFad< ValueT >::~DFad ( )

inline

Destructor.

Definition at line 116 of file Sacado_Fad_DFad_tmpl.hpp.

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

Sacado_Fad_DFad_tmpl.hpp

Classes

Public Types

Public Member Functions

Initialization methods

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

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