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 | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
Sacado::Fad::Exp::StaticStorage< T, Num > Class Template Reference

Derivative array storage class using static memory allocation. More...

#include <Sacado_Fad_Exp_StaticStorage.hpp>

Classes

struct  apply
 Turn StaticStorage into a meta-function class usable with mpl::apply. More...
 
struct  apply_N
 Replace static derivative length (interpreted as a fixed length) More...
 

Public Types

typedef std::remove_cv< T >::type value_type
 

Public Member Functions

KOKKOS_INLINE_FUNCTION StaticStorage ()
 Default constructor. More...
 
KOKKOS_INLINE_FUNCTION StaticStorage (const T &x)
 Constructor with value. More...
 
KOKKOS_INLINE_FUNCTION StaticStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz. More...
 
KOKKOS_INLINE_FUNCTION StaticStorage (const int sz, const int i, const value_type &x)
 Constructor with size sz, index i, and value x. More...
 
KOKKOS_INLINE_FUNCTION StaticStorage (const StaticStorage &x)
 Copy constructor. More...
 
KOKKOS_INLINE_FUNCTION StaticStorage (StaticStorage &&x)
 Move constructor. More...
 
KOKKOS_INLINE_FUNCTION ~StaticStorage ()
 Destructor. More...
 
KOKKOS_INLINE_FUNCTION
StaticStorage
operator= (const StaticStorage &x)
 Assignment. More...
 
KOKKOS_INLINE_FUNCTION
StaticStorage
operator= (StaticStorage &&x)
 Move assignment. More...
 
KOKKOS_INLINE_FUNCTION int size () const
 Returns number of derivative components. More...
 
KOKKOS_INLINE_FUNCTION int length () const
 Returns array length. More...
 
KOKKOS_INLINE_FUNCTION void resize (int sz)
 Resize the derivative array to sz. More...
 
KOKKOS_INLINE_FUNCTION void resizeAndZero (int sz)
 Resize the derivative array to sz. More...
 
KOKKOS_INLINE_FUNCTION void expand (int sz)
 Expand derivative array to size sz. More...
 
KOKKOS_INLINE_FUNCTION void zero ()
 Zero out derivative array. More...
 
KOKKOS_INLINE_FUNCTION const Tval () const
 Returns value. More...
 
KOKKOS_INLINE_FUNCTION Tval ()
 Returns value. More...
 
KOKKOS_INLINE_FUNCTION const Tdx () const
 Returns derivative array. More...
 
KOKKOS_INLINE_FUNCTION T dx (int i) const
 Returns derivative component i with bounds checking. More...
 
KOKKOS_INLINE_FUNCTION TfastAccessDx (int i)
 Returns derivative component i without bounds checking. More...
 
KOKKOS_INLINE_FUNCTION const TfastAccessDx (int i) const
 Returns derivative component i without bounds checking. More...
 

Static Public Attributes

static constexpr bool is_statically_sized = false
 
static constexpr int static_size = 0
 
static constexpr bool is_view = false
 

Protected Attributes

T val_
 Value. More...
 
T dx_ [Num]
 Derivative array. More...
 
int sz_
 Size of derivative array. More...
 

Detailed Description

template<typename T, int Num>
class Sacado::Fad::Exp::StaticStorage< T, Num >

Derivative array storage class using static memory allocation.

This class uses a statically allocated array whose dimension is fixed by the template parameter Num.

Definition at line 50 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Typedef Documentation

template<typename T , int Num>
typedef std::remove_cv<T>::type Sacado::Fad::Exp::StaticStorage< T, Num >::value_type

Definition at line 54 of file Sacado_Fad_Exp_StaticStorage.hpp.

Constructor & Destructor Documentation

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( )
inline

Default constructor.

Definition at line 73 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( const T x)
inline

Constructor with value.

Definition at line 78 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( const int  sz,
const T x,
const DerivInit  zero_out = InitDerivArray 
)
inline

Constructor with size sz.

Initializes derivative array 0 of length sz

Definition at line 86 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( 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 104 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( const StaticStorage< T, Num > &  x)
inline

Copy constructor.

Definition at line 111 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( StaticStorage< T, Num > &&  x)
inline

Move constructor.

Definition at line 120 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::~StaticStorage ( )
inline

Destructor.

Definition at line 128 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Function Documentation

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION StaticStorage& Sacado::Fad::Exp::StaticStorage< T, Num >::operator= ( const StaticStorage< T, Num > &  x)
inline

Assignment.

Definition at line 132 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION StaticStorage& Sacado::Fad::Exp::StaticStorage< T, Num >::operator= ( StaticStorage< T, Num > &&  x)
inline

Move assignment.

Definition at line 145 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION int Sacado::Fad::Exp::StaticStorage< T, Num >::size ( ) const
inline

Returns number of derivative components.

Definition at line 157 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION int Sacado::Fad::Exp::StaticStorage< T, Num >::length ( ) const
inline

Returns array length.

Definition at line 161 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::resize ( int  sz)
inline

Resize the derivative array to sz.

Definition at line 165 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::resizeAndZero ( int  sz)
inline

Resize the derivative array to sz.

This method doest not preserve any existing derivative components but sets any that are added to zero.

Definition at line 179 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::expand ( int  sz)
inline

Expand derivative array to size sz.

This method preserves any existing derivative components and sets any that are added to zero.

Definition at line 195 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::zero ( )
inline

Zero out derivative array.

Definition at line 208 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION const T& Sacado::Fad::Exp::StaticStorage< T, Num >::val ( ) const
inline

Returns value.

Definition at line 212 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION T& Sacado::Fad::Exp::StaticStorage< T, Num >::val ( )
inline

Returns value.

Definition at line 216 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION const T* Sacado::Fad::Exp::StaticStorage< T, Num >::dx ( ) const
inline

Returns derivative array.

Definition at line 220 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION T Sacado::Fad::Exp::StaticStorage< T, Num >::dx ( int  i) const
inline

Returns derivative component i with bounds checking.

Definition at line 224 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION T& Sacado::Fad::Exp::StaticStorage< T, Num >::fastAccessDx ( int  i)
inline

Returns derivative component i without bounds checking.

Definition at line 228 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
KOKKOS_INLINE_FUNCTION const T& Sacado::Fad::Exp::StaticStorage< T, Num >::fastAccessDx ( int  i) const
inline

Returns derivative component i without bounds checking.

Definition at line 232 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Data Documentation

template<typename T , int Num>
constexpr bool Sacado::Fad::Exp::StaticStorage< T, Num >::is_statically_sized = false
static

Definition at line 55 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
constexpr int Sacado::Fad::Exp::StaticStorage< T, Num >::static_size = 0
static

Definition at line 56 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
constexpr bool Sacado::Fad::Exp::StaticStorage< T, Num >::is_view = false
static

Definition at line 57 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
T Sacado::Fad::Exp::StaticStorage< T, Num >::val_
protected

Value.

Definition at line 237 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
T Sacado::Fad::Exp::StaticStorage< T, Num >::dx_[Num]
protected

Derivative array.

Definition at line 240 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>
int Sacado::Fad::Exp::StaticStorage< T, Num >::sz_
protected

Size of derivative array.

Definition at line 243 of file Sacado_Fad_Exp_StaticStorage.hpp.


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