Expression template forward-mode AD class with static memory allocation. More...

#include <Sacado_ELRCacheFad_SFad.hpp>

Classes
struct	LocalAccumOp
Public Types
typedef T	value_type
	Typename of values.
typedef ScalarType< T >::type	scalar_type
	Typename of scalar's (which may be different from T)
typedef Expr< SFadExprTag< T, Num > >	base_expr_type
	Typename of base-expressions.
Static Public Attributes
static const int	num_args = 1
	Number of arguments.
static const bool	is_linear = true
	Is expression linear.
Protected Attributes
T	val_
	Value.
T	dx_ [Num]
	Derivatives.
bool	update_val_
	Update value.
Initialization methods
	Expr ()
	Default constructor.
	Expr (const T &x)
	Constructor with supplied value `x`.
	Expr (const int sz, const T &x)
	Constructor with size `sz` and value `x`.
	Expr (const int sz, const int i, const T &x)
	Constructor with size `sz`, index `i`, and value `x`.
	Expr (const Expr &x)
	Copy constructor.
template<typename S >
	Expr (const Expr< S > &x)
	Copy constructor from any Expression object.
	~Expr ()
	Destructor.
void	diff (const int ith, const int n)
	Set Fad object as the `ith` independent variable.
void	resize (int sz)
	Resize derivative array to length `sz`.
void	expand (int sz)
	Expand derivative array to size sz.
void	zero ()
	Zero out the derivative array.
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.
Value accessor methods
const T &	val () const
	Returns value.
T &	val ()
	Returns value.
Derivative accessor methods
int	size () const
	Returns number of derivative components.
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.
const T *	dx () const
	Returns derivative array.
const T &	dx (int i) const
	Returns derivative component `i` with bounds checking.
T &	fastAccessDx (int i)
	Returns derivative component `i` without bounds checking.
const T &	fastAccessDx (int i) const
	Returns derivative component `i` without bounds checking.
void	computePartials (const T &bar, T partials[]) const
	Return partials w.r.t. arguments.
void	getTangents (int i, T dots[]) const
	Return tangent component `i` of arguments.
template<int Arg>
bool	isActive () const
	Return whether argument is active.
template<int Arg>
T	getTangent (int i) const
	Return tangent component `i` of argument `Arg`.
Assignment operators
Expr< SFadExprTag< T, Num > > &	operator= (const T &val)
	Assignment operator with constant right-hand-side.
Expr< SFadExprTag< T, Num > > &	operator= (const Expr< SFadExprTag< T, Num > > &x)
	Assignment with Expr right-hand-side.
template<typename S >
Expr< SFadExprTag< T, Num > > &	operator= (const Expr< S > &x)
	Assignment operator with any expression right-hand-side.
Unary operators
Expr< SFadExprTag< T, Num > > &	operator+= (const T &x)
	Addition-assignment operator with constant right-hand-side.
Expr< SFadExprTag< T, Num > > &	operator-= (const T &x)
	Subtraction-assignment operator with constant right-hand-side.
Expr< SFadExprTag< T, Num > > &	operator*= (const T &x)
	Multiplication-assignment operator with constant right-hand-side.
Expr< SFadExprTag< T, Num > > &	operator/= (const T &x)
	Division-assignment operator with constant right-hand-side.
template<typename S >
Expr< SFadExprTag< T, Num > > &	operator+= (const Expr< S > &x)
	Addition-assignment operator with Expr right-hand-side.
template<typename S >
Expr< SFadExprTag< T, Num > > &	operator-= (const Expr< S > &x)
	Subtraction-assignment operator with Expr right-hand-side.
template<typename S >
Expr< SFadExprTag< T, Num > > &	operator*= (const Expr< S > &x)
	Multiplication-assignment operator with Expr right-hand-side.
template<typename S >
Expr< SFadExprTag< T, Num > > &	operator/= (const Expr< S > &x)
	Division-assignment operator with Expr right-hand-side.

Detailed Description

template<typename T, int Num>
class Sacado::ELRCacheFad::Expr< SFadExprTag< T, Num > >

Expression template forward-mode AD class with static memory allocation.

This classes specializes Expr to SFad expressions.

Definition at line 78 of file Sacado_ELRCacheFad_SFad.hpp.