Sacado::ELRCacheFad::GeneralFad< T, Storage > Class Template Reference

Forward-mode AD class templated on the storage for the derivative array. More...

#include <Sacado_ELRCacheFad_GeneralFad.hpp>

Inheritance diagram for Sacado::ELRCacheFad::GeneralFad< T, Storage >:

List of all members.

Classes
struct	FastLocalAccumOp
struct	SlowLocalAccumOp
Public Types
typedef RemoveConst< T >::type	value_type
	Typename of values.
typedef ScalarType< value_type > ::type	scalar_type
	Typename of scalar's (which may be different from T)
Public Member Functions
Initialization methods
	GeneralFad ()
	Default constructor.
	GeneralFad (const T &x)
	Constructor with supplied value x.
	GeneralFad (const int sz, const T &x)
	Constructor with size sz and value x.
	GeneralFad (const int sz, const int i, const T &x)
	Constructor with size sz, index i, and value x.
	GeneralFad (const Storage &s)
	Constructor with supplied storage s.
	GeneralFad (const GeneralFad &x)
	Copy constructor.
template<typename S >
	GeneralFad (const Expr< S > &x)
	Copy constructor from any Expression object.
	~GeneralFad ()
	Destructor.
void	diff (const int ith, const int n)
	Set GeneralFad object as the ith independent variable.
void	setUpdateValue (bool update_val)
	Set whether this Fad object should update values.
bool	updateValue () const
	Return whether this Fad object has an updated value.
void	cache () const
	Cache values.
template<typename S >
bool	isEqualTo (const Expr< S > &x) const
	Returns whether two Fad objects have the same values.
Derivative accessor methods
int	availableSize () const
	Returns number of derivative components that can be stored without reallocation.
bool	hasFastAccess () const
	Returns true if derivative array is not empty.
bool	isPassive () const
	Returns true if derivative array is empty.
void	setIsConstant (bool is_const)
	Set whether variable is constant.
Assignment operators
GeneralFad &	operator= (const T &val)
	Assignment operator with constant right-hand-side.
GeneralFad &	operator= (const GeneralFad &x)
	Assignment with Expr right-hand-side.
template<typename S >
GeneralFad &	operator= (const Expr< S > &x)
	Assignment operator with any expression right-hand-side.
Unary operators
GeneralFad &	operator+= (const T &x)
	Addition-assignment operator with constant right-hand-side.
GeneralFad &	operator-= (const T &x)
	Subtraction-assignment operator with constant right-hand-side.
GeneralFad &	operator*= (const T &x)
	Multiplication-assignment operator with constant right-hand-side.
GeneralFad &	operator/= (const T &x)
	Division-assignment operator with constant right-hand-side.
GeneralFad &	operator+= (const typename dummy< value_type, scalar_type >::type &x)
	Addition-assignment operator with constant right-hand-side.
GeneralFad &	operator-= (const typename dummy< value_type, scalar_type >::type &x)
	Subtraction-assignment operator with constant right-hand-side.
GeneralFad &	operator*= (const typename dummy< value_type, scalar_type >::type &x)
	Multiplication-assignment operator with constant right-hand-side.
GeneralFad &	operator/= (const typename dummy< value_type, scalar_type >::type &x)
	Division-assignment operator with constant right-hand-side.
template<typename S >
GeneralFad &	operator+= (const Expr< S > &x)
	Addition-assignment operator with Expr right-hand-side.
template<typename S >
GeneralFad &	operator-= (const Expr< S > &x)
	Subtraction-assignment operator with Expr right-hand-side.
template<typename S >
GeneralFad &	operator*= (const Expr< S > &x)
	Multiplication-assignment operator with Expr right-hand-side.
template<typename S >
GeneralFad &	operator/= (const Expr< S > &x)
	Division-assignment operator with Expr right-hand-side.
Protected Attributes
bool	update_val_
	Update value.

---

Detailed Description

template<typename T, typename Storage>
class Sacado::ELRCacheFad::GeneralFad< T, Storage >

Forward-mode AD class templated on the storage for the derivative array.

This class provides a general forward mode AD implementation for any type of derivative array storage. It does not incorporate expression templates.

---

Constructor & Destructor Documentation

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage >::GeneralFad

(

const T &

x

)

[inline]

Constructor with supplied value x.

Initializes value to x and derivative array is empty

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage >::GeneralFad	(	const int	sz,
		const T &	x
	)		[inline]

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage >::GeneralFad	(	const int	sz,
		const int	i,
		const T &	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 T , typename Storage >

void Sacado::ELRCacheFad::GeneralFad< T, Storage >::diff	(	const int	ith,
		const int	n
	)		[inline]

Set GeneralFad object as the ith independent variable.

Sets the derivative array of length n to the ith row of the identity matrix and has the same affect as the Implementation(const int sz, const int i, const T & x) constructor.

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage > & Sacado::ELRCacheFad::GeneralFad< T, Storage >::operator*=

(

const typename dummy< value_type, scalar_type >::type &

x

)

[inline]

Multiplication-assignment operator with constant right-hand-side.

Creates a dummy overload when value_type and scalar_type are the same type.

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage > & Sacado::ELRCacheFad::GeneralFad< T, Storage >::operator+=

(

const typename dummy< value_type, scalar_type >::type &

x

)

[inline]

Addition-assignment operator with constant right-hand-side.

Creates a dummy overload when value_type and scalar_type are the same type.

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage > & Sacado::ELRCacheFad::GeneralFad< T, Storage >::operator-=

(

const typename dummy< value_type, scalar_type >::type &

x

)

[inline]

Subtraction-assignment operator with constant right-hand-side.

Creates a dummy overload when value_type and scalar_type are the same type.

template<typename T , typename Storage >

Sacado::ELRCacheFad::GeneralFad< T, Storage > & Sacado::ELRCacheFad::GeneralFad< T, Storage >::operator/=

(

const typename dummy< value_type, scalar_type >::type &

x

)

[inline]

Division-assignment operator with constant right-hand-side.

Creates a dummy overload when value_type and scalar_type are the same type.

---

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

• Sacado_ELRCacheFad_GeneralFad.hpp
• Sacado_ELRCacheFad_GeneralFadImp.hpp