Sacado Package Browser (Single Doxygen Collection) Version of the Day
Classes | Public Types | Public Member Functions
Sacado::CacheFad::SFad< ValueT, Num > Class Template Reference

Forward-mode AD class using static memory allocation and caching expression templates. More...

#include <Sacado_CacheFad_SFad.hpp>

Inheritance diagram for Sacado::CacheFad::SFad< ValueT, Num >:
Inheritance graph
[legend]

List of all members.

Classes

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

Public Types

typedef ScalarType< ValueT >::type ScalarT
 Typename of scalar's (which may be different from ValueT)

Public Member Functions

 ~SFad ()
 Destructor.
SFadoperator= (const ValueT &v)
 Assignment operator with constant right-hand-side.
SFadoperator= (const typename dummy< ValueT, ScalarT >::type &v)
 Assignment operator with constant right-hand-side.
SFadoperator= (const SFad &x)
 Assignment operator with DFad right-hand-side.
template<typename S >
SFadoperator= (const Expr< S > &x)
 Assignment operator with any expression right-hand-side.

Initialization methods

 SFad ()
 Default constructor.
 SFad (const ValueT &x)
 Constructor with supplied value x.
 SFad (const typename dummy< ValueT, ScalarT >::type &x)
 Constructor with supplied value x of type ScalarT.
 SFad (const int sz, const ValueT &x)
 Constructor with size sz and value x.
 SFad (const int sz, const int i, const ValueT &x)
 Constructor with size sz, index i, and value x.
 SFad (const SFad &x)
 Copy constructor.
template<typename S >
 SFad (const Expr< S > &x)
 Copy constructor from any Expression object.

Detailed Description

template<typename ValueT, int Num>
class Sacado::CacheFad::SFad< ValueT, Num >

Forward-mode AD class using static memory allocation and caching expression templates.

This is the user-level class for forward mode AD with static memory allocation, and is appropriate for whenever the number of derivative components is known at compile time. The size of the derivative array is fixed by the template parameter Num. It is similar to Sacado::Fad::SFad, except it uses the caching expression templates that cache the results of val() calculations for later dx() calculations.

Definition at line 305 of file Sacado_CacheFad_SFad.hpp.


Member Typedef Documentation

template<typename ValueT, int Num>
typedef ScalarType<ValueT>::type Sacado::CacheFad::SFad< ValueT, Num >::ScalarT

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

Definition at line 311 of file Sacado_CacheFad_SFad.hpp.


Constructor & Destructor Documentation

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( ) [inline]

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 328 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const ValueT &  x) [inline]

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 335 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const typename dummy< ValueT, ScalarT >::type &  x) [inline]

Constructor with supplied value x of type ScalarT.

Initializes value to ValueT(x) and derivative array is empty. Creates a dummy overload when ValueT and ScalarT are the same type.

Definition at line 343 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const int  sz,
const ValueT &  x 
) [inline]

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 350 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const int  sz,
const int  i,
const ValueT &  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 359 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const SFad< ValueT, Num > &  x) [inline]

Copy constructor.

Definition at line 363 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
template<typename S >
Sacado::CacheFad::SFad< ValueT, Num >::SFad ( const Expr< S > &  x) [inline]

Copy constructor from any Expression object.

Definition at line 367 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
Sacado::CacheFad::SFad< ValueT, Num >::~SFad ( ) [inline]

Destructor.

Definition at line 373 of file Sacado_CacheFad_SFad.hpp.


Member Function Documentation

template<typename ValueT, int Num>
SFad& Sacado::CacheFad::SFad< ValueT, Num >::operator= ( const ValueT &  v) [inline]

Assignment operator with constant right-hand-side.

Definition at line 376 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
SFad& Sacado::CacheFad::SFad< ValueT, Num >::operator= ( const typename dummy< ValueT, ScalarT >::type &  v) [inline]

Assignment operator with constant right-hand-side.

Creates a dummy overload when ValueT and ScalarT are the same type.

Definition at line 385 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
SFad& Sacado::CacheFad::SFad< ValueT, Num >::operator= ( const SFad< ValueT, Num > &  x) [inline]

Assignment operator with DFad right-hand-side.

Definition at line 391 of file Sacado_CacheFad_SFad.hpp.

template<typename ValueT, int Num>
template<typename S >
SFad& Sacado::CacheFad::SFad< ValueT, Num >::operator= ( const Expr< S > &  x) [inline]

Assignment operator with any expression right-hand-side.

Definition at line 397 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