Sacado Package Browser (Single Doxygen Collection) Version of the Day
Public Types | Public Member Functions | Static Public Attributes
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > > Class Template Reference

GeneralFad expression template specialization. More...

#include <Sacado_ELRCacheFad_GeneralFadExpr.hpp>

Inheritance diagram for Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef GeneralFad< T, Storage >
::value_type 
value_type
 Typename of values.
typedef GeneralFad< T, Storage >
::scalar_type 
scalar_type
 Typename of scalar's (which may be different from T)
typedef GeneralFad< T, Storage > base_expr_type
 Typename of base-expressions.

Public Member Functions

 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 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>
getTangent (int i) const
 Return tangent component i of argument Arg.

Static Public Attributes

static const int num_args = 1
 Number of arguments.

Detailed Description

template<typename T, typename Storage>
class Sacado::ELRCacheFad::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 using the caching expression-level-revese-mode expression templates.

Definition at line 49 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.


Member Typedef Documentation

template<typename T , typename Storage >
typedef GeneralFad<T,Storage>::value_type Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::value_type

Typename of values.

Reimplemented from Sacado::ELRCacheFad::GeneralFad< T, Storage >.

Definition at line 53 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
typedef GeneralFad<T,Storage>::scalar_type Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::scalar_type

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

Reimplemented from Sacado::ELRCacheFad::GeneralFad< T, Storage >.

Definition at line 54 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
typedef GeneralFad<T,Storage> Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::base_expr_type

Typename of base-expressions.

Definition at line 57 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.


Constructor & Destructor Documentation

template<typename T , typename Storage >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::Expr ( ) [inline]

Default constructor.

Definition at line 63 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::Expr ( const T &  x) [inline]

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 70 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::Expr ( const int  sz,
const T &  x 
) [inline]

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 77 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
Sacado::ELRCacheFad::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 86 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::Expr ( const Expr< GeneralFad< T, Storage > > &  x) [inline]

Copy constructor.

Definition at line 90 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<typename S >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::Expr ( const Expr< S > &  x) [inline]

Copy constructor from any Expression object.

Definition at line 94 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::~Expr ( ) [inline]

Destructor.

Definition at line 98 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.


Member Function Documentation

template<typename T , typename Storage >
void Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::computePartials ( const T &  bar,
partials[] 
) const [inline]

Return partials w.r.t. arguments.

Definition at line 101 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
void Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::getTangents ( int  i,
dots[] 
) const [inline]

Return tangent component i of arguments.

Definition at line 106 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<int Arg>
bool Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::isActive ( ) const [inline]

Return whether argument is active.

Definition at line 115 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<int Arg>
T Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::getTangent ( int  i) const [inline]

Return tangent component i of argument Arg.

Definition at line 119 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.


Member Data Documentation

template<typename T , typename Storage >
const int Sacado::ELRCacheFad::Expr< GeneralFad< T, Storage > >::num_args = 1 [static]

Number of arguments.

Definition at line 60 of file Sacado_ELRCacheFad_GeneralFadExpr.hpp.


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