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 | Protected Attributes | List of all members
Sacado::ELRCacheFad::ConstExpr< ConstT > Class Template Reference

Constant expression template. More...

#include <Sacado_ELRCacheFad_Expression.hpp>

Public Types

typedef ConstT value_type
 Typename of argument values. More...
 
typedef ScalarType< value_type >
::type 
scalar_type
 Typename of scalar's (which may be different from ConstT) More...
 
typedef ConstT base_expr_type
 Typename of base-expressions. More...
 

Public Member Functions

KOKKOS_INLINE_FUNCTION ConstExpr (const ConstT &constant)
 Constructor. More...
 
KOKKOS_INLINE_FUNCTION int size () const
 Return size of the derivative array of the operation. More...
 
KOKKOS_INLINE_FUNCTION bool updateValue () const
 Return whether value should be updated. More...
 
KOKKOS_INLINE_FUNCTION void cache () const
 Cache values. More...
 
KOKKOS_INLINE_FUNCTION value_type val () const
 Return value of operation. More...
 
KOKKOS_INLINE_FUNCTION void computePartials (const value_type &bar, value_type partials[]) const
 Return partials w.r.t. arguments. More...
 
KOKKOS_INLINE_FUNCTION void getTangents (int i, value_type dots[]) const
 Rturn tangent component i of arguments. More...
 
template<int Arg>
KOKKOS_INLINE_FUNCTION value_type getTangent (int i) const
 Return tangent component i of argument Arg. More...
 
template<int Arg>
KOKKOS_INLINE_FUNCTION bool isActive () const
 Return whether argument is active. More...
 
KOKKOS_INLINE_FUNCTION bool isLinear () const
 Return whether expression is linear. More...
 

Static Public Attributes

static const int num_args = 0
 Number of arguments. More...
 

Protected Attributes

const ConstT & constant_
 The constant. More...
 

Detailed Description

template<typename ConstT>
class Sacado::ELRCacheFad::ConstExpr< ConstT >

Constant expression template.

This template class represents a constant expression.

Definition at line 112 of file Sacado_ELRCacheFad_Expression.hpp.

Member Typedef Documentation

template<typename ConstT >
typedef ConstT Sacado::ELRCacheFad::ConstExpr< ConstT >::value_type

Typename of argument values.

Definition at line 117 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
typedef ScalarType<value_type>::type Sacado::ELRCacheFad::ConstExpr< ConstT >::scalar_type

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

Definition at line 120 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
typedef ConstT Sacado::ELRCacheFad::ConstExpr< ConstT >::base_expr_type

Typename of base-expressions.

Definition at line 123 of file Sacado_ELRCacheFad_Expression.hpp.

Constructor & Destructor Documentation

template<typename ConstT >
KOKKOS_INLINE_FUNCTION Sacado::ELRCacheFad::ConstExpr< ConstT >::ConstExpr ( const ConstT &  constant)
inline

Constructor.

Definition at line 130 of file Sacado_ELRCacheFad_Expression.hpp.

Member Function Documentation

template<typename ConstT >
KOKKOS_INLINE_FUNCTION int Sacado::ELRCacheFad::ConstExpr< ConstT >::size ( ) const
inline

Return size of the derivative array of the operation.

Definition at line 134 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION bool Sacado::ELRCacheFad::ConstExpr< ConstT >::updateValue ( ) const
inline

Return whether value should be updated.

Definition at line 138 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION void Sacado::ELRCacheFad::ConstExpr< ConstT >::cache ( ) const
inline

Cache values.

Definition at line 142 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION value_type Sacado::ELRCacheFad::ConstExpr< ConstT >::val ( ) const
inline

Return value of operation.

Definition at line 146 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION void Sacado::ELRCacheFad::ConstExpr< ConstT >::computePartials ( const value_type bar,
value_type  partials[] 
) const
inline

Return partials w.r.t. arguments.

Definition at line 150 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION void Sacado::ELRCacheFad::ConstExpr< ConstT >::getTangents ( int  i,
value_type  dots[] 
) const
inline

Rturn tangent component i of arguments.

Definition at line 155 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
template<int Arg>
KOKKOS_INLINE_FUNCTION value_type Sacado::ELRCacheFad::ConstExpr< ConstT >::getTangent ( int  i) const
inline

Return tangent component i of argument Arg.

Definition at line 160 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
template<int Arg>
KOKKOS_INLINE_FUNCTION bool Sacado::ELRCacheFad::ConstExpr< ConstT >::isActive ( ) const
inline

Return whether argument is active.

Definition at line 165 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
KOKKOS_INLINE_FUNCTION bool Sacado::ELRCacheFad::ConstExpr< ConstT >::isLinear ( ) const
inline

Return whether expression is linear.

Definition at line 169 of file Sacado_ELRCacheFad_Expression.hpp.

Member Data Documentation

template<typename ConstT >
const int Sacado::ELRCacheFad::ConstExpr< ConstT >::num_args = 0
static

Number of arguments.

Definition at line 126 of file Sacado_ELRCacheFad_Expression.hpp.

template<typename ConstT >
const ConstT& Sacado::ELRCacheFad::ConstExpr< ConstT >::constant_
protected

The constant.

Definition at line 174 of file Sacado_ELRCacheFad_Expression.hpp.


The documentation for this class was generated from the following file: