Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
Sacado::ELRFad::Expr< GeneralFad< T, Storage > > Class Template Reference

GeneralFad expression template specialization. More...

#include <Sacado_ELRFad_GeneralFadExpr.hpp>

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

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::ELRFad::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...
 
SACADO_INLINE_FUNCTION void computePartials (const T &bar, value_type partials[]) const
 Return partials w.r.t. arguments. More...
 
SACADO_INLINE_FUNCTION void getTangents (int i, value_type dots[]) const
 Return tangent component i of arguments. More...
 
template<int Arg>
SACADO_INLINE_FUNCTION bool isActive () const
 Return whether argument is active. More...
 
SACADO_INLINE_FUNCTION bool isActive2 (int j) const
 Return whether argument is active. More...
 
SACADO_INLINE_FUNCTION bool isLinear () const
 Return whether expression is linear. More...
 
template<int Arg>
SACADO_INLINE_FUNCTION const T & getTangent (int i) const
 Return tangent component i of argument Arg. More...
 
SACADO_INLINE_FUNCTION const
value_type * 		getDx (int j) const
 Get dx array. More...
 
SACADO_INLINE_FUNCTION int numActiveArgs () const
 
SACADO_INLINE_FUNCTION void computeActivePartials (const T &bar, value_type *partials) const
 Return partials w.r.t. arguments. More...
 
- Public Member Functions inherited from Sacado::ELRFad::GeneralFad< T, Storage >
template<typename S >
SACADO_INLINE_FUNCTION SACADO_ENABLE_VALUE_FUNC (GeneralFad &) operator
 Assignment operator with constant right-hand-side. More...
 
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...
 

Static Public Attributes

static const int num_args = 1
 Number of arguments. More...
 
static const bool is_linear = true
 Is expression linear. More...
 

Detailed Description

template<typename T, typename Storage>
class Sacado::ELRFad::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_ELRFad_GeneralFadExpr.hpp.

Member Typedef Documentation

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

Typename of values.

Definition at line 51 of file Sacado_ELRFad_GeneralFadExpr.hpp.

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

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

Definition at line 54 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
typedef BaseExpr< GeneralFad<T,Storage> >::type Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::base_expr_type

Typename of base-expressions.

Definition at line 57 of file Sacado_ELRFad_GeneralFadExpr.hpp.

Constructor & Destructor Documentation

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::Expr ( )
inline

Default constructor.

Definition at line 67 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<typename S >
SACADO_INLINE_FUNCTION Sacado::ELRFad::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 76 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::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 84 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::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 94 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::Expr ( const Storage &  s)
inline

Constructor with supplied storage s.

Definition at line 99 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::Expr ( const Expr< GeneralFad< T, Storage > > &  x)
inline

Copy constructor.

Definition at line 104 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<typename S >
SACADO_INLINE_FUNCTION Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::Expr ( const Expr< S > &  x,
SACADO_ENABLE_EXPR_CTOR_DECL   
)
inline

Copy constructor from any Expression object.

Definition at line 110 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::~Expr ( )
inline

Destructor.

Definition at line 115 of file Sacado_ELRFad_GeneralFadExpr.hpp.

Member Function Documentation

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

Return partials w.r.t. arguments.

Definition at line 119 of file Sacado_ELRFad_GeneralFadExpr.hpp.

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

Return tangent component i of arguments.

Definition at line 125 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<int Arg>
SACADO_INLINE_FUNCTION bool Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::isActive ( ) const
inline

Return whether argument is active.

Definition at line 135 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION bool Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::isActive2 ( int  j) const
inline

Return whether argument is active.

Definition at line 139 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION bool Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::isLinear ( ) const
inline

Return whether expression is linear.

Definition at line 143 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
template<int Arg>
SACADO_INLINE_FUNCTION const T& Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::getTangent ( int  i) const
inline

Return tangent component i of argument Arg.

Definition at line 148 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION const value_type* Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::getDx ( int  j) const
inline

Get dx array.

Definition at line 152 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION int Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::numActiveArgs ( ) const
inline

Definition at line 155 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
SACADO_INLINE_FUNCTION void Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::computeActivePartials ( const T &  bar,
value_type *  partials 
) const
inline

Return partials w.r.t. arguments.

Definition at line 161 of file Sacado_ELRFad_GeneralFadExpr.hpp.

Member Data Documentation

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

Number of arguments.

Definition at line 60 of file Sacado_ELRFad_GeneralFadExpr.hpp.

template<typename T , typename Storage >
const bool Sacado::ELRFad::Expr< GeneralFad< T, Storage > >::is_linear = true
static

Is expression linear.

Definition at line 63 of file Sacado_ELRFad_GeneralFadExpr.hpp.

The documentation for this class was generated from the following file:
Generated on Wed May 1 2024 09:23:54 for Sacado Package Browser (Single Doxygen Collection) by   doxygen 1.8.5