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

#include <Sacado_Fad_Exp_GeneralFad.hpp>

Inheritance diagram for Sacado::Fad::Exp::GeneralFad< Storage >:

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

struct	apply_N
	Replace static derivative length. More...

Public Types
typedef Storage	StorageType
	Storage type. More...

typedef Expr< GeneralFad < Storage > >	ExprType
	Expression type. More...

typedef Extender< Storage >	ExtenderType
	Extender type. More...

typedef ScalarType< value_type > ::type	scalar_type
	Typename of scalar's (which may be different from T) More...

Public Types inherited from Sacado::Fad::Exp::Expr< GeneralFad< Storage > >
typedef GeneralFad< Storage >	derived_type
	Typename of derived object, returned by derived() More...

Public Types inherited from Sacado::Fad::Exp::Extender< Storage >
typedef ExprSpecDefault	expr_spec_type

Static Public Attributes
static constexpr bool	is_view = Storage::is_view
	Whether we are a view. More...

Initialization methods
SACADO_DEFAULTED_FUNCTION	GeneralFad ()=default
	Default constructor. More...

SACADO_DEFAULTED_FUNCTION	GeneralFad (const GeneralFad &x)=default
	Copy constructor. More...

SACADO_DEFAULTED_FUNCTION	GeneralFad (GeneralFad &&x)=default
	Move constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	GeneralFad (const S &x, SACADO_EXP_ENABLE_VALUE_CTOR_DECL)
	Constructor with value (disabled for ViewFad) More...

template<typename S >
SACADO_INLINE_FUNCTION	GeneralFad (const Expr< S > &x, SACADO_EXP_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object (disabled for ViewFad) More...

SACADO_DEFAULTED_FUNCTION	~GeneralFad ()=default
	Destructor. More...

SACADO_INLINE_FUNCTION void	diff (const int ith, const int n)
	Set GeneralFad object as the `ith` independent variable. More...

SACADO_INLINE_FUNCTION void	setUpdateValue (bool update_val)
	Set whether this Fad object should update values. More...

SACADO_INLINE_FUNCTION bool	updateValue () const
	Return whether this Fad object has an updated value. More...

SACADO_INLINE_FUNCTION void	cache () const
	Cache values. More...

template<typename S >
SACADO_INLINE_FUNCTION	SACADO_EXP_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &xx) const
	Returns whether two Fad objects have the same values. More...

Derivative accessor methods
SACADO_INLINE_FUNCTION int	availableSize () const
	Returns number of derivative components that can be stored without reallocation. More...

SACADO_INLINE_FUNCTION bool	hasFastAccess () const
	Returns true if derivative array is not empty. More...

SACADO_INLINE_FUNCTION void	setIsConstant (bool is_const)
	Set whether variable is constant. More...

Assignment operators
template<typename S >
SACADO_INLINE_FUNCTION	SACADO_ENABLE_VALUE_FUNC (GeneralFad &) operator
	Assignment operator with constant right-hand-side. More...

SACADO_DEFAULTED_FUNCTION GeneralFad &	operator= (GeneralFad &&x)=default
	Move assignment with GeneralFad right-hand-side. More...

Additional Inherited Members
Public Member Functions inherited from Sacado::Fad::Exp::Expr< GeneralFad< Storage > >
SACADO_INLINE_FUNCTION const derived_type &	derived () const
	Return derived object. More...

SACADO_INLINE_FUNCTION const volatile derived_type &	derived () const volatile
	Return derived object. More...

Detailed Description

template<typename Storage>
class Sacado::Fad::Exp::GeneralFad< 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.

Definition at line 30 of file Sacado_Fad_Exp_GeneralFad.hpp.

Member Typedef Documentation

template<typename Storage>

typedef Storage Sacado::Fad::Exp::GeneralFad< Storage >::StorageType

Storage type.

Definition at line 37 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

typedef Expr< GeneralFad<Storage> > Sacado::Fad::Exp::GeneralFad< Storage >::ExprType

Expression type.

Definition at line 40 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

typedef Extender<Storage> Sacado::Fad::Exp::GeneralFad< Storage >::ExtenderType

Extender type.

Definition at line 43 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

typedef ScalarType<value_type>::type Sacado::Fad::Exp::GeneralFad< Storage >::scalar_type

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

Definition at line 49 of file Sacado_Fad_Exp_GeneralFad.hpp.

Constructor & Destructor Documentation

template<typename Storage>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( )

default

Default constructor.

template<typename Storage>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const GeneralFad< Storage > & x )

default

Copy constructor.

template<typename Storage>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( GeneralFad< Storage > && x )

default

Move constructor.

template<typename Storage>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad	(	const S &	x,
		SACADO_EXP_ENABLE_VALUE_CTOR_DECL
	)

inline

Constructor with value (disabled for ViewFad)

Definition at line 91 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad	(	const Expr< S > &	x,
		SACADO_EXP_ENABLE_EXPR_CTOR_DECL
	)

inline

Copy constructor from any Expression object (disabled for ViewFad)

Definition at line 97 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::~GeneralFad ( )

default

Destructor.

Member Function Documentation

template<typename Storage>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< 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.

Definition at line 115 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< Storage >::setUpdateValue ( bool update_val )

inline

Set whether this Fad object should update values.

Retained for backward compatibility.

Definition at line 127 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION bool Sacado::Fad::Exp::GeneralFad< Storage >::updateValue ( ) const

inline

Return whether this Fad object has an updated value.

Retained for backward compatibility.

Definition at line 133 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< Storage >::cache ( ) const

inline

Cache values.

Retained for backward compatibility.

Definition at line 139 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::SACADO_EXP_ENABLE_EXPR_FUNC ( bool ) const

inline

Returns whether two Fad objects have the same values.

Definition at line 144 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION int Sacado::Fad::Exp::GeneralFad< Storage >::availableSize ( ) const

inline

Returns number of derivative components that can be stored without reallocation.

Definition at line 169 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION bool Sacado::Fad::Exp::GeneralFad< Storage >::hasFastAccess ( ) const

inline

Returns true if derivative array is not empty.

Definition at line 173 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< Storage >::setIsConstant ( bool is_const )

inline

Set whether variable is constant.

Definition at line 177 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::SACADO_ENABLE_VALUE_FUNC ( GeneralFad< Storage > & )

Assignment operator with constant right-hand-side.

template<typename Storage>

SACADO_DEFAULTED_FUNCTION GeneralFad& Sacado::Fad::Exp::GeneralFad< Storage >::operator= ( GeneralFad< Storage > && x )

default

Move assignment with GeneralFad right-hand-side.

Member Data Documentation

template<typename Storage>

constexpr bool Sacado::Fad::Exp::GeneralFad< Storage >::is_view = Storage::is_view

static

Whether we are a view.

Definition at line 52 of file Sacado_Fad_Exp_GeneralFad.hpp.

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

Sacado_Fad_Exp_GeneralFad.hpp

Classes

Public Types

Static Public Attributes

Initialization methods

Derivative accessor methods

Assignment operators

Additional Inherited Members

Detailed Description

template<typename Storage> class Sacado::Fad::Exp::GeneralFad< Storage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Storage>
class Sacado::Fad::Exp::GeneralFad< Storage >