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

Forward-mode AD class templated on the storage for the derivative array. More...

#include <Sacado_Fad_Exp_GeneralFad.hpp>

Inheritance diagram for Sacado::Fad::Exp::GeneralFad< Storage >:
Inheritance graph
[legend]

Classes

struct  apply
 Turn GeneralFad into a meta-function class usable with mpl::apply. More...
 
struct  apply_N
 Replace static derivative length. More...
 

Public Types

typedef Storage StorageType
 Storage type. More...
 
typedef Expr< GeneralFad
< Storage > > 
ExprType
 Expression type. More...
 
typedef Extender< Storage > ExtenderType
 Extender type. More...
 
typedef ScalarType< value_type >
::type 
scalar_type
 Typename of scalar's (which may be different from T) More...
 
- Public Types inherited from Sacado::Fad::Exp::Expr< GeneralFad< Storage > >
typedef GeneralFad< Storage > derived_type
 Typename of derived object, returned by derived() More...
 
- Public Types inherited from Sacado::Fad::Exp::Extender< Storage >
typedef ExprSpecDefault expr_spec_type
 

Initialization methods

 GeneralFad ()=default
 Default constructor. More...
 
template<typename S >
KOKKOS_INLINE_FUNCTION GeneralFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Constructor with value. More...
 
KOKKOS_INLINE_FUNCTION GeneralFad (const int sz, const value_type &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz. More...
 
KOKKOS_INLINE_FUNCTION GeneralFad (const int sz, const int i, const value_type &x)
 Constructor with size sz, index i, and value x. More...
 
KOKKOS_INLINE_FUNCTION GeneralFad (const Storage &s)
 Constructor with supplied storage s. More...
 
 GeneralFad (const GeneralFad &x)=default
 Copy constructor. More...
 
template<typename S >
KOKKOS_INLINE_FUNCTION GeneralFad (const Expr< S > &x, SACADO_EXP_ENABLE_EXPR_CTOR_DECL)
 Copy constructor from any Expression object. More...
 
 ~GeneralFad ()=default
 Destructor. More...
 
KOKKOS_INLINE_FUNCTION void diff (const int ith, const int n)
 Set GeneralFad object as the ith independent variable. More...
 
template<typename S >
KOKKOS_INLINE_FUNCTION SACADO_EXP_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &xx) const
 Returns whether two Fad objects have the same values. More...
 

Derivative accessor methods

KOKKOS_INLINE_FUNCTION int availableSize () const
 Returns number of derivative components that can be stored without reallocation. More...
 
KOKKOS_INLINE_FUNCTION bool hasFastAccess () const
 Returns true if derivative array is not empty. More...
 
KOKKOS_INLINE_FUNCTION void setIsConstant (bool is_const)
 Set whether variable is constant. More...
 

Assignment operators

template<typename S >
KOKKOS_INLINE_FUNCTION SACADO_ENABLE_VALUE_FUNC (GeneralFad &) operator
 Assignment operator with constant right-hand-side. More...
 

Additional Inherited Members

- Public Member Functions inherited from Sacado::Fad::Exp::Expr< GeneralFad< Storage > >
KOKKOS_INLINE_FUNCTION const
derived_type
derived () const
 Return derived object. More...
 
KOKKOS_INLINE_FUNCTION const
volatile derived_type
derived () const volatile
 Return derived object. More...
 

Detailed Description

template<typename Storage>
class Sacado::Fad::Exp::GeneralFad< Storage >

Forward-mode AD class templated on the storage for the derivative array.

This class provides a general forward mode AD implementation for any type of derivative array storage. It does not incorporate expression templates.

Definition at line 51 of file Sacado_Fad_Exp_GeneralFad.hpp.

Member Typedef Documentation

template<typename Storage>
typedef Storage Sacado::Fad::Exp::GeneralFad< Storage >::StorageType

Storage type.

Definition at line 59 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
typedef Expr< GeneralFad<Storage> > Sacado::Fad::Exp::GeneralFad< Storage >::ExprType

Expression type.

Definition at line 62 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
typedef Extender<Storage> Sacado::Fad::Exp::GeneralFad< Storage >::ExtenderType

Extender type.

Definition at line 65 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
typedef ScalarType<value_type>::type Sacado::Fad::Exp::GeneralFad< Storage >::scalar_type

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

Definition at line 71 of file Sacado_Fad_Exp_GeneralFad.hpp.

Constructor & Destructor Documentation

template<typename Storage>
Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( )
default

Default constructor.

template<typename Storage>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const S &  x,
SACADO_ENABLE_VALUE_CTOR_DECL   
)
inline

Constructor with value.

Definition at line 98 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const int  sz,
const value_type &  x,
const DerivInit  zero_out = InitDerivArray 
)
inline

Constructor with size sz.

Initializes derivative array 0 of length sz

Definition at line 106 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const int  sz,
const int  i,
const value_type &  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 117 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const Storage &  s)
inline

Constructor with supplied storage s.

Definition at line 124 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const GeneralFad< Storage > &  x)
default

Copy constructor.

template<typename Storage>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::GeneralFad ( const Expr< S > &  x,
SACADO_EXP_ENABLE_EXPR_CTOR_DECL   
)
inline

Copy constructor from any Expression object.

Definition at line 132 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
Sacado::Fad::Exp::GeneralFad< Storage >::~GeneralFad ( )
default

Destructor.

Member Function Documentation

template<typename Storage>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< Storage >::diff ( const int  ith,
const int  n 
)
inline

Set GeneralFad 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.

Definition at line 153 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::SACADO_EXP_ENABLE_EXPR_FUNC ( bool  ) const
inline

Returns whether two Fad objects have the same values.

Definition at line 164 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION int Sacado::Fad::Exp::GeneralFad< Storage >::availableSize ( ) const
inline

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

Definition at line 189 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION bool Sacado::Fad::Exp::GeneralFad< Storage >::hasFastAccess ( ) const
inline

Returns true if derivative array is not empty.

Definition at line 193 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::GeneralFad< Storage >::setIsConstant ( bool  is_const)
inline

Set whether variable is constant.

Definition at line 197 of file Sacado_Fad_Exp_GeneralFad.hpp.

template<typename Storage>
template<typename S >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::GeneralFad< Storage >::SACADO_ENABLE_VALUE_FUNC ( GeneralFad< Storage > &  )

Assignment operator with constant right-hand-side.


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