GeneralFad expression template specialization. More...

#include <Sacado_Fad_GeneralFadExpr.hpp>

Inheritance diagram for Sacado::Fad::Expr< GeneralFad< T, Storage > >:

Public Types
typedef GeneralFad< T, Storage > ::value_type	value_type
	Typename of values. More...

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

typedef BaseExpr< GeneralFad < T, Storage > >::type	base_expr_type
	Typename of base-expressions. More...

Public Types inherited from Sacado::Fad::GeneralFad< T, Storage >
typedef RemoveConst< T >::type	value_type
	Typename of values. More...

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

Public Member Functions
SACADO_INLINE_FUNCTION	Expr ()
	Default constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	Expr (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value `x`. More...

SACADO_INLINE_FUNCTION	Expr (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz` and value `x`. More...

SACADO_INLINE_FUNCTION	Expr (const int sz, const int i, const T &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

SACADO_INLINE_FUNCTION	Expr (const Storage &s)
	Constructor with supplied storage `s`. More...

SACADO_INLINE_FUNCTION	Expr (const Expr &x)
	Copy constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	Expr (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object. More...

SACADO_INLINE_FUNCTION	~Expr ()
	Destructor. More...

Public Member Functions inherited from Sacado::Fad::GeneralFad< T, Storage >
SACADO_INLINE_FUNCTION	GeneralFad ()
	Default constructor. More...

template<typename S >
SACADO_INLINE_FUNCTION	GeneralFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value `x`. More...

SACADO_INLINE_FUNCTION	GeneralFad (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz` and value `x`. More...

SACADO_INLINE_FUNCTION	GeneralFad (const int sz, const int i, const T &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

SACADO_INLINE_FUNCTION	GeneralFad (const Storage &s)
	Constructor with supplied storage `s`. More...

SACADO_INLINE_FUNCTION	GeneralFad (const GeneralFad &x)
	Copy constructor. More...

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

SACADO_INLINE_FUNCTION	~GeneralFad ()
	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_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &x) const
	Returns whether two Fad objects have the same values. More...

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 bool	isPassive () const
	Returns true if derivative array is empty. More...

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

Detailed Description

template<typename T, typename Storage>
class Sacado::Fad::Expr< GeneralFad< T, Storage > >

GeneralFad expression template specialization.

This template class represents a simple GeneralFad expression and mixes-in the GeneralFad interface and the expression template interface.

Definition at line 46 of file Sacado_Fad_GeneralFadExpr.hpp.

Member Typedef Documentation

template<typename T , typename Storage >

typedef GeneralFad<T,Storage>::value_type Sacado::Fad::Expr< GeneralFad< T, Storage > >::value_type

Typename of values.

Definition at line 51 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

typedef GeneralFad<T,Storage>::scalar_type Sacado::Fad::Expr< GeneralFad< T, Storage > >::scalar_type

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

Definition at line 54 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

typedef BaseExpr< GeneralFad<T,Storage> >::type Sacado::Fad::Expr< GeneralFad< T, Storage > >::base_expr_type

Typename of base-expressions.

Definition at line 57 of file Sacado_Fad_GeneralFadExpr.hpp.

Constructor & Destructor Documentation

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::Expr ( )

inline

Default constructor.

Definition at line 61 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

template<typename S >

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

inline

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 70 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::Expr	(	const int	sz,
		const T &	x,
		const DerivInit	zero_out = `InitDerivArray`
	)

inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 78 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::Expr	(	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.

Definition at line 88 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::Expr ( const Storage & s )

inline

Constructor with supplied storage s.

Definition at line 93 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::Expr ( const Expr< GeneralFad< T, Storage > > & x )

inline

Copy constructor.

Definition at line 98 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

template<typename S >

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

inline

Copy constructor from any Expression object.

Definition at line 104 of file Sacado_Fad_GeneralFadExpr.hpp.

template<typename T , typename Storage >

SACADO_INLINE_FUNCTION Sacado::Fad::Expr< GeneralFad< T, Storage > >::~Expr ( )

inline

Destructor.

Definition at line 109 of file Sacado_Fad_GeneralFadExpr.hpp.

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

Sacado_Fad_GeneralFadExpr.hpp

Public Types

Public Member Functions

Detailed Description

template<typename T, typename Storage> class Sacado::Fad::Expr< GeneralFad< T, Storage > >

Member Typedef Documentation

Constructor & Destructor Documentation

template<typename T, typename Storage>
class Sacado::Fad::Expr< GeneralFad< T, Storage > >