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

#include <Sacado_Fad_DVFad.hpp>

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

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

Public Types
typedef VectorDynamicStorage < 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 T) 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, VectorDynamicStorage< ValueT > > >
typedef GeneralFad< ValueT, VectorDynamicStorage< ValueT > >	value_type

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

Initialization methods
	DVFad ()
	Default constructor. More...

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

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

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

	DVFad (const int sz, ValueT x, ValueT dx, bool zero_out=false)
	Constructor with supplied memory. More...

	DVFad (const int sz, const int i, ValueT x, ValueT dx)
	Constructor with supplied memory and index `i`. More...

	DVFad (const DVFad &x)
	Copy constructor. More...

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

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 67 of file Sacado_Fad_DVFad.hpp.

Member Typedef Documentation

template<typename ValueT>

typedef VectorDynamicStorage<ValueT> Sacado::Fad::DVFad< ValueT >::StorageType

Base classes.

Definition at line 73 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

Definition at line 74 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

Definition at line 75 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

Typename of values.

Definition at line 78 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

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

Definition at line 81 of file Sacado_Fad_DVFad.hpp.

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 84 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 101 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

template<typename S >

Sacado::Fad::DVFad< ValueT >::DVFad	(	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_DVFad.hpp.

template<typename ValueT>

Sacado::Fad::DVFad< ValueT >::DVFad	(	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_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 125 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 133 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 142 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

inline

Copy constructor.

Definition at line 146 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

template<typename S >

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

inline

Copy constructor from any Expression object.

Definition at line 151 of file Sacado_Fad_DVFad.hpp.

template<typename ValueT>

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

inline

Destructor.

Definition at line 157 of file Sacado_Fad_DVFad.hpp.

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

Sacado_Fad_DVFad.hpp

Classes

Public Types

Public Member Functions

Initialization methods

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

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