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 | Static Private Attributes | List of all members
Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U > Class Template Reference

Derivative array storage class that is a view into a contiguous memory allocation. It does not provide proper value semantics and thus should not be used in a general-purpose scalar type. More...

#include <Sacado_Fad_Exp_ViewStorage.hpp>

Classes

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

Public Types

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

Public Member Functions

KOKKOS_INLINE_FUNCTION ViewStorage ()
 Default constructor (needed to satisfy interface) More...
 
KOKKOS_INLINE_FUNCTION ViewStorage (const T &x)
 Constructor with value (needed to satisfy interface) More...
 
KOKKOS_INLINE_FUNCTION ViewStorage (const int sz, const T &x, const DerivInit zero_out)
 Constructor with size sz (needed to satisfy interface) More...
 
KOKKOS_INLINE_FUNCTION ViewStorage (T *v, const int arg_size=0, const int arg_stride=0)
 Constructor. More...
 
KOKKOS_INLINE_FUNCTION ViewStorage (T *arg_dx, T *arg_val, const int arg_size=0, const int arg_stride=0)
 Constructor. More...
 
KOKKOS_INLINE_FUNCTION ViewStorage (const ViewStorage &x)
 Copy constructor. More...
 
KOKKOS_INLINE_FUNCTION ~ViewStorage ()
 Destructor. More...
 
KOKKOS_INLINE_FUNCTION
ViewStorage
operator= (const ViewStorage &x)
 Assignment. More...
 
KOKKOS_INLINE_FUNCTION
constexpr int 
size () const
 Returns number of derivative components. More...
 
KOKKOS_INLINE_FUNCTION
constexpr 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...
 
KOKKOS_INLINE_FUNCTION
ViewFadPtr< T, static_length,
static_stride, U > 
operator& () const
 Overload of addressof operator. More...
 

Static Public Attributes

static constexpr bool is_statically_sized = (static_length > 0)
 
static constexpr int static_size = static_length
 

Protected Attributes

const
mpl::integral_nonzero_constant
< int, static_length > 
sz_
 Derivative array size. More...
 
const
mpl::integral_nonzero_constant
< int, static_stride > 
stride_
 Derivative array stride. More...
 
Tval_
 Value. More...
 
Tdx_
 Derivative array. More...
 

Static Private Attributes

static constexpr bool stride_one = (1 == static_stride)
 

Detailed Description

template<typename T, unsigned static_length, unsigned static_stride, typename U>
class Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >

Derivative array storage class that is a view into a contiguous memory allocation. It does not provide proper value semantics and thus should not be used in a general-purpose scalar type.

Definition at line 54 of file Sacado_Fad_Exp_ViewStorage.hpp.

Member Typedef Documentation

template<typename T , unsigned static_length, unsigned static_stride, typename U >
typedef std::remove_cv<T>::type Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::value_type

Definition at line 63 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
typedef U Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::base_fad_type

Definition at line 66 of file Sacado_Fad_Exp_ViewStorage.hpp.

Constructor & Destructor Documentation

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( )
inline

Default constructor (needed to satisfy interface)

Definition at line 82 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( const T x)
inline

Constructor with value (needed to satisfy interface)

Definition at line 87 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( const int  sz,
const T x,
const DerivInit  zero_out 
)
inline

Constructor with size sz (needed to satisfy interface)

Definition at line 92 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( T v,
const int  arg_size = 0,
const int  arg_stride = 0 
)
inline

Constructor.

Definition at line 97 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( T arg_dx,
T arg_val,
const int  arg_size = 0,
const int  arg_stride = 0 
)
inline

Constructor.

Definition at line 102 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::ViewStorage ( const ViewStorage< T, static_length, static_stride, U > &  x)
inline

Copy constructor.

Definition at line 108 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::~ViewStorage ( )
inline

Destructor.

Definition at line 113 of file Sacado_Fad_Exp_ViewStorage.hpp.

Member Function Documentation

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION ViewStorage& Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::operator= ( const ViewStorage< T, static_length, static_stride, U > &  x)
inline

Assignment.

Definition at line 117 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION constexpr int Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::size ( ) const
inline

Returns number of derivative components.

Definition at line 132 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION constexpr int Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::length ( ) const
inline

Returns array length.

Definition at line 136 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::resize ( int  sz)
inline

Resize the derivative array to sz.

Since we can't actually resize, we check for resizes to zero, which signify assigning a constant. Thus we zero out the derivative components.

Definition at line 145 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::resizeAndZero ( int  sz)
inline

Resize the derivative array to sz.

We don't do anything here as this is used in the context of resizing the derivative array to zero and then back to some size > 0. Instead we zero out components when it is resized to zero above.

Definition at line 156 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::expand ( int  sz)
inline

Expand derivative array to size sz.

Definition at line 160 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::zero ( )
inline

Zero out derivative array.

Definition at line 164 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION const T& Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::val ( ) const
inline

Returns value.

Definition at line 170 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION T& Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::val ( )
inline

Returns value.

Definition at line 174 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION const T* Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::dx ( ) const
inline

Returns derivative array.

Definition at line 178 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION T Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::dx ( int  i) const
inline

Returns derivative component i with bounds checking.

Definition at line 182 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION T& Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::fastAccessDx ( int  i)
inline

Returns derivative component i without bounds checking.

Definition at line 188 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION const T& Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::fastAccessDx ( int  i) const
inline

Returns derivative component i without bounds checking.

Definition at line 194 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
KOKKOS_INLINE_FUNCTION ViewFadPtr<T,static_length,static_stride,U> Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::operator& ( ) const
inline

Overload of addressof operator.

Definition at line 200 of file Sacado_Fad_Exp_ViewStorage.hpp.

Member Data Documentation

template<typename T , unsigned static_length, unsigned static_stride, typename U >
constexpr bool Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::stride_one = (1 == static_stride)
staticprivate

Definition at line 59 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
constexpr bool Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::is_statically_sized = (static_length > 0)
static

Definition at line 64 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
constexpr int Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::static_size = static_length
static

Definition at line 65 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
const mpl::integral_nonzero_constant< int, static_length > Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::sz_
protected

Derivative array size.

Definition at line 208 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
const mpl::integral_nonzero_constant< int, static_stride > Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::stride_
protected

Derivative array stride.

Definition at line 211 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
T* Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::val_
protected

Value.

Definition at line 214 of file Sacado_Fad_Exp_ViewStorage.hpp.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
T* Sacado::Fad::Exp::ViewStorage< T, static_length, static_stride, U >::dx_
protected

Derivative array.

Definition at line 217 of file Sacado_Fad_Exp_ViewStorage.hpp.


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