Sacado Package Browser (Single Doxygen Collection) Version of the Day
Public Types | Protected Attributes
Sacado::CacheFad::Expr< SFadExprTag< T, Num > > Class Template Reference

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

#include <Sacado_CacheFad_SFad.hpp>

List of all members.

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)

Protected Attributes

val_
 Value.
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.

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::CacheFad::Expr< SFadExprTag< T, Num > >

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

This classes specializes Expr to SFad expressions.

Definition at line 79 of file Sacado_CacheFad_SFad.hpp.


Member Typedef Documentation

template<typename T , int Num>
typedef T Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::value_type

Typename of values.

Definition at line 84 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
typedef ScalarType<T>::type Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::scalar_type

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

Definition at line 87 of file Sacado_CacheFad_SFad.hpp.


Constructor & Destructor Documentation

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( ) [inline]

Default constructor.

Definition at line 95 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( const T &  x) [inline]

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 101 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( const int  sz,
const T &  x 
)

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( const int  sz,
const int  i,
const T &  x 
)

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.

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( const Expr< SFadExprTag< T, Num > > &  x)

Copy constructor.

template<typename T , int Num>
template<typename S >
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::Expr ( const Expr< S > &  x)

Copy constructor from any Expression object.

template<typename T , int Num>
Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::~Expr ( ) [inline]

Destructor.

Definition at line 125 of file Sacado_CacheFad_SFad.hpp.


Member Function Documentation

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::diff ( const int  ith,
const int  n 
)

Set Fad 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 , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::resize ( int  sz)

Resize derivative array to length sz.

Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::expand ( int  sz) [inline]

Expand derivative array to size sz.

Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.

Definition at line 148 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::zero ( ) [inline]

Zero out the derivative array.

Definition at line 151 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::setUpdateValue ( bool  update_val) [inline]

Set whether this Fad object should update values.

Definition at line 154 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
bool Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::updateValue ( ) const [inline]

Return whether this Fad object has an updated value.

Definition at line 157 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::cache ( ) const [inline]

Cache values.

Definition at line 160 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
template<typename S >
bool Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::isEqualTo ( const Expr< S > &  x) const [inline]

Returns whether two Fad objects have the same values.

Definition at line 164 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
const T& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::val ( ) const [inline]

Returns value.

Definition at line 181 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
T& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::val ( ) [inline]

Returns value.

Definition at line 184 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
int Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::size ( ) const [inline]

Returns number of derivative components.

Definition at line 194 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
int Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::availableSize ( ) const [inline]

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

Definition at line 200 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
bool Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::hasFastAccess ( ) const [inline]

Returns true if derivative array is not empty.

Definition at line 203 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
bool Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::isPassive ( ) const [inline]

Returns true if derivative array is empty.

Definition at line 206 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
void Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::setIsConstant ( bool  is_const) [inline]

Set whether variable is constant.

Definition at line 209 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
const T* Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::dx ( ) const [inline]

Returns derivative array.

Definition at line 212 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
const T& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::dx ( int  i) const [inline]

Returns derivative component i with bounds checking.

Definition at line 215 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
T& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::fastAccessDx ( int  i) [inline]

Returns derivative component i without bounds checking.

Definition at line 218 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
const T& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::fastAccessDx ( int  i) const [inline]

Returns derivative component i without bounds checking.

Definition at line 221 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator= ( const T &  val)

Assignment operator with constant right-hand-side.

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator= ( const Expr< SFadExprTag< T, Num > > &  x)

Assignment with Expr right-hand-side.

template<typename T , int Num>
template<typename S >
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator= ( const Expr< S > &  x)

Assignment operator with any expression right-hand-side.

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator+= ( const T &  x)

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

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator-= ( const T &  x)

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

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator*= ( const T &  x)

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

template<typename T , int Num>
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator/= ( const T &  x)

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

template<typename T , int Num>
template<typename S >
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator+= ( const Expr< S > &  x)

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

template<typename T , int Num>
template<typename S >
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator-= ( const Expr< S > &  x)

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

template<typename T , int Num>
template<typename S >
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator*= ( const Expr< S > &  x)

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

template<typename T , int Num>
template<typename S >
Expr< SFadExprTag<T,Num> >& Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::operator/= ( const Expr< S > &  x)

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


Member Data Documentation

template<typename T , int Num>
T Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::val_ [protected]

Value.

Definition at line 281 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
T Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::dx_[Num] [protected]

Derivatives.

Definition at line 284 of file Sacado_CacheFad_SFad.hpp.

template<typename T , int Num>
bool Sacado::CacheFad::Expr< SFadExprTag< T, Num > >::update_val_ [protected]

Update value.

Definition at line 287 of file Sacado_CacheFad_SFad.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines