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

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

#include <Sacado_Fad_SimpleFad.hpp>

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

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

List of all members.

Classes
struct	apply
	Turn SimpleFad into a meta-function class usable with mpl::apply. More...
Public Types
typedef ValueT	value_type
	Typename of values.
typedef ScalarType< ValueT >::type	ScalarT
	Typename of scalar's (which may be different from ValueT)
Public Member Functions
	~SimpleFad ()
	Destructor.
bool	isEqualTo (const SimpleFad &x) const
	Returns whether two Fad objects have the same values.
SimpleFad &	operator= (const ValueT &v)
	Assignment operator with constant right-hand-side.
SimpleFad &	operator= (const typename dummy< ValueT, ScalarT >::type &v)
	Assignment operator with constant right-hand-side.
SimpleFad &	operator= (const SimpleFad &x)
	Assignment operator with SimpleFad right-hand-side.
SimpleFad &	operator+= (const SimpleFad &x)
	Addition-assignment operator with Expr right-hand-side.
SimpleFad &	operator-= (const SimpleFad &x)
	Subtraction-assignment operator with Expr right-hand-side.
SimpleFad &	operator*= (const SimpleFad &x)
	Multiplication-assignment operator with Expr right-hand-side.
SimpleFad &	operator/= (const SimpleFad &x)
	Division-assignment operator with Expr right-hand-side.
Initialization methods
	SimpleFad ()
	Default constructor.
	SimpleFad (const ValueT &x)
	Constructor with supplied value x of type ValueT.
	SimpleFad (const typename dummy< ValueT, ScalarT >::type &x)
	Constructor with supplied value x of type ScalarT.
	SimpleFad (const int sz, const ValueT &x)
	Constructor with size sz and value x.
	SimpleFad (const int sz, const int i, const ValueT &x)
	Constructor with size sz, index i, and value x.
	SimpleFad (const SimpleFad &x)
	Copy constructor.
	SimpleFad (const SimpleFad &x, const ValueT &v, const ValueT &partial)
	Tangent copy constructor.

---

Detailed Description

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

Forward-mode AD class using dynamic memory allocation but no 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.

---

Constructor & Destructor Documentation

template<typename ValueT >

Sacado::Fad::SimpleFad< ValueT >::SimpleFad

(

)

[inline]

Default constructor.

Initializes value to 0 and derivative array is empty

template<typename ValueT >

Sacado::Fad::SimpleFad< ValueT >::SimpleFad

(

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

(

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::SimpleFad< ValueT >::SimpleFad	(	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::SimpleFad< ValueT >::SimpleFad	(	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.

---

Member Function Documentation

template<typename ValueT >

SimpleFad& Sacado::Fad::SimpleFad< 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 files:

• Sacado_Fad_SimpleFad.hpp
• Sacado_Fad_SimpleFadImp.hpp