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 >:

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

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.
DVFad &	operator= (const ValueT &v)
	Assignment operator with constant right-hand-side.
DVFad &	operator= (const typename dummy< ValueT, ScalarT >::type &v)
	Assignment operator with constant right-hand-side.
DVFad &	operator= (const DVFad &x)
	Assignment operator with DVFad right-hand-side.
template<typename S >
DVFad &	operator= (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.

---

Constructor & Destructor Documentation

template<typename ValueT >

Sacado::Fad::DVFad< ValueT >::DVFad

(

)

[inline]

Default constructor.

Initializes value to 0 and derivative array is empty

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

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.

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

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.

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.

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.

---

Member Function Documentation

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.

---

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

• Sacado_Fad_DVFad.hpp