Sacado::Fad::Exp::GeneralFad< Storage > Class Template Reference

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

Collaboration 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.
typedef Expr< GeneralFad < Storage > >	ExprType
	Expression type.
typedef Extender< Storage >	ExtenderType
	Extender type.
typedef ScalarType< value_type > ::type	scalar_type
	Typename of scalar's (which may be different from T)
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

Public Member Functions
Initialization methods
SACADO_DEFAULTED_FUNCTION	GeneralFad ()=default
	Default constructor.
SACADO_DEFAULTED_FUNCTION	GeneralFad (const GeneralFad &x)=default
	Copy constructor.
SACADO_DEFAULTED_FUNCTION	GeneralFad (GeneralFad &&x)=default
	Move constructor.
template<typename S >
SACADO_INLINE_FUNCTION	GeneralFad (const S &x, SACADO_EXP_ENABLE_VALUE_CTOR_DECL)
	Constructor with value (disabled for ViewFad)
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)
SACADO_DEFAULTED_FUNCTION	~GeneralFad ()=default
	Destructor.
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.
Derivative accessor methods
SACADO_INLINE_FUNCTION int	availableSize () const
	Returns number of derivative components that can be stored without reallocation.
SACADO_INLINE_FUNCTION bool	hasFastAccess () const
	Returns true if derivative array is not empty.
SACADO_INLINE_FUNCTION void	setIsConstant (bool is_const)
	Set whether variable is constant.
Assignment operators
template<typename S >
SACADO_INLINE_FUNCTION	SACADO_ENABLE_VALUE_FUNC (GeneralFad &) operator
	Assignment operator with constant right-hand-side.
SACADO_DEFAULTED_FUNCTION GeneralFad &	operator= (GeneralFad &&x)=default
	Move assignment with GeneralFad right-hand-side.
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...

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

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.

Member Function Documentation

template<typename Storage>

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

inline

Cache values.

Retained for backward compatibility.

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.

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.

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.

---

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

• Sacado_Fad_Exp_GeneralFad.hpp