Stokhos 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 Member Functions | Static Public Attributes | Private Attributes | List of all members
Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t > Class Template Reference

Statically allocated storage class. More...

#include <Stokhos_StaticFixedStorage.hpp>

Classes

struct  apply
 Turn StaticFixedStorage into a meta-function class usable with mpl::apply. More...
 
struct  apply_N
 

Public Types

typedef ordinal_t ordinal_type
 
typedef value_t value_type
 
typedef device_t::execution_space execution_space
 
typedef device_t::memory_space memory_space
 
typedef value_type & reference
 
typedef volatile value_type & volatile_reference
 
typedef const value_type & const_reference
 
typedef const volatile value_type & const_volatile_reference
 
typedef value_type * pointer
 
typedef volatile value_type * volatile_pointer
 
typedef const value_type * const_pointer
 
typedef const volatile value_type * const_volatile_pointer
 
typedef
Stokhos::StaticArrayTraits
< value_type, execution_space > 		ss
 
typedef Stokhos::MemoryTraits
< memory_space > 		MemTraits
 

Public Member Functions

KOKKOS_DEFAULTED_FUNCTION StaticFixedStorage ()=default
 Constructor. More...
 
KOKKOS_INLINE_FUNCTION StaticFixedStorage (const ordinal_type &sz, const value_type &x=value_type(0.0))
 Constructor. More...
 
KOKKOS_INLINE_FUNCTION StaticFixedStorage (const ordinal_type &sz, const value_type *x)
 Constructor from array. More...
 
KOKKOS_INLINE_FUNCTION StaticFixedStorage (const ordinal_type &sz, pointer v, bool owned)
 Constructor for creating a view (not allowed) More...
 
KOKKOS_DEFAULTED_FUNCTION StaticFixedStorage (const StaticFixedStorage &s)=default
 Copy constructor. More...
 
KOKKOS_INLINE_FUNCTION StaticFixedStorage (const volatile StaticFixedStorage &s)
 Copy constructor. More...
 
KOKKOS_DEFAULTED_FUNCTION ~StaticFixedStorage ()=default
 Destructor. More...
 
KOKKOS_DEFAULTED_FUNCTION
StaticFixedStorage & 		operator= (const StaticFixedStorage &s)=default
 Assignment operator. More...
 
KOKKOS_INLINE_FUNCTION
StaticFixedStorage & 		operator= (const volatile StaticFixedStorage &s)
 Assignment operator. More...
 
KOKKOS_INLINE_FUNCTION
StaticFixedStorage & 		operator= (const StaticFixedStorage &s) volatile
 Assignment operator. More...
 
KOKKOS_INLINE_FUNCTION
StaticFixedStorage & 		operator= (const volatile StaticFixedStorage &s) volatile
 Assignment operator. More...
 
KOKKOS_INLINE_FUNCTION void init (const_reference v)
 Initialize values to a constant value. More...
 
KOKKOS_INLINE_FUNCTION void init (const_reference v) volatile
 Initialize values to a constant value. More...
 
KOKKOS_INLINE_FUNCTION void init (const_pointer v, const ordinal_type &sz=0)
 Initialize values to an array of values. More...
 
KOKKOS_INLINE_FUNCTION void init (const_pointer v, const ordinal_type &sz=0) volatile
 Initialize values to an array of values. More...
 
KOKKOS_INLINE_FUNCTION void load (pointer v)
 Load values to an array of values. More...
 
KOKKOS_INLINE_FUNCTION void load (pointer v) volatile
 Load values to an array of values. More...
 
KOKKOS_INLINE_FUNCTION void resize (const ordinal_type &sz)
 Resize to new size (values are preserved) More...
 
KOKKOS_INLINE_FUNCTION void resize (const ordinal_type &sz) volatile
 Resize to new size (values are preserved) More...
 
KOKKOS_INLINE_FUNCTION void shallowReset (pointer v, const ordinal_type &sz, const ordinal_type &stride, bool owned)
 Reset storage to given array, size, and stride. More...
 
KOKKOS_INLINE_FUNCTION void shallowReset (pointer v, const ordinal_type &sz, const ordinal_type &stride, bool owned) volatile
 Reset storage to given array, size, and stride. More...
 
KOKKOS_INLINE_FUNCTION
const_reference 		operator[] (const ordinal_type &i) const
 Coefficient access (avoid if possible) More...
 
KOKKOS_INLINE_FUNCTION
const_volatile_reference 		operator[] (const ordinal_type &i) const volatile
 Coefficient access (avoid if possible) More...
 
KOKKOS_INLINE_FUNCTION reference operator[] (const ordinal_type &i)
 Coefficient access (avoid if possible) More...
 
KOKKOS_INLINE_FUNCTION
volatile_reference 		operator[] (const ordinal_type &i) volatile
 Coefficient access (avoid if possible) More...
 
template<int i>
KOKKOS_INLINE_FUNCTION reference getCoeff ()
 
template<int i>
KOKKOS_INLINE_FUNCTION
volatile_reference 		getCoeff () volatile
 
template<int i>
KOKKOS_INLINE_FUNCTION
const_volatile_reference 		getCoeff () const volatile
 
template<int i>
KOKKOS_INLINE_FUNCTION
const_reference 		getCoeff () const
 
KOKKOS_INLINE_FUNCTION
const_volatile_pointer 		coeff () const volatile
 Get coefficients. More...
 
KOKKOS_INLINE_FUNCTION
const_pointer 		coeff () const
 Get coefficients. More...
 
KOKKOS_INLINE_FUNCTION
volatile_pointer 		coeff () volatile
 Get coefficients. More...
 
KOKKOS_INLINE_FUNCTION pointer coeff ()
 Get coefficients. More...
 

Static Public Member Functions

static KOKKOS_INLINE_FUNCTION
ordinal_type 		size ()
 Return size. More...
 

Static Public Attributes

static const bool is_static = true
 
static const int static_size = Num
 
static const bool supports_reset = false
 

Private Attributes

value_type coeff_ [Num]
 Coefficient values. More...
 

Detailed Description

template<typename ordinal_t, typename value_t, int Num, typename device_t>
class Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >

Statically allocated storage class.

Definition at line 37 of file Stokhos_StaticFixedStorage.hpp.

Member Typedef Documentation

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef ordinal_t Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::ordinal_type

Definition at line 44 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef value_t Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::value_type

Definition at line 45 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef device_t::execution_space Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::execution_space

Definition at line 46 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef device_t::memory_space Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::memory_space

Definition at line 47 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef value_type& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::reference

Definition at line 48 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef volatile value_type& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::volatile_reference

Definition at line 49 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef const value_type& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::const_reference

Definition at line 50 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef const volatile value_type& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::const_volatile_reference

Definition at line 51 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef value_type* Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::pointer

Definition at line 52 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef volatile value_type* Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::volatile_pointer

Definition at line 53 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef const value_type* Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::const_pointer

Definition at line 54 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef const volatile value_type* Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::const_volatile_pointer

Definition at line 55 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef Stokhos::StaticArrayTraits<value_type,execution_space> Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::ss

Definition at line 56 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
typedef Stokhos::MemoryTraits<memory_space> Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::MemTraits

Definition at line 58 of file Stokhos_StaticFixedStorage.hpp.

Constructor & Destructor Documentation

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_DEFAULTED_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( )
default

Constructor.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( const ordinal_type &  sz,
const value_type &  x = value_type(0.0) 
)
inline

Constructor.

Definition at line 77 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( const ordinal_type &  sz,
const value_type *  x 
)
inline

Constructor from array.

Definition at line 84 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( const ordinal_type &  sz,
pointer  v,
bool  owned 
)
inline

Constructor for creating a view (not allowed)

Definition at line 90 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_DEFAULTED_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( const StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s)
default

Copy constructor.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::StaticFixedStorage ( const volatile StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s)
inline

Copy constructor.

Definition at line 98 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_DEFAULTED_FUNCTION Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::~StaticFixedStorage ( )
default

Destructor.

Member Function Documentation

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_DEFAULTED_FUNCTION StaticFixedStorage& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator= ( const StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s)
default

Assignment operator.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION StaticFixedStorage& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator= ( const volatile StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s)
inline

Assignment operator.

Definition at line 112 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION StaticFixedStorage& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator= ( const StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s) volatile
inline

Assignment operator.

Definition at line 120 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION StaticFixedStorage& Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator= ( const volatile StaticFixedStorage< ordinal_t, value_t, Num, device_t > &  s) volatile
inline

Assignment operator.

Definition at line 128 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::init ( const_reference  v)
inline

Initialize values to a constant value.

Definition at line 135 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::init ( const_reference  v) volatile
inline

Initialize values to a constant value.

Definition at line 141 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::init ( const_pointer  v,
const ordinal_type &  sz = 0 
)
inline

Initialize values to an array of values.

Definition at line 147 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::init ( const_pointer  v,
const ordinal_type &  sz = 0 
) volatile
inline

Initialize values to an array of values.

Definition at line 156 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::load ( pointer  v)
inline

Load values to an array of values.

Definition at line 165 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::load ( pointer  v) volatile
inline

Load values to an array of values.

Definition at line 171 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::resize ( const ordinal_type &  sz)
inline

Resize to new size (values are preserved)

Definition at line 177 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::resize ( const ordinal_type &  sz) volatile
inline

Resize to new size (values are preserved)

Definition at line 181 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::shallowReset ( pointer  v,
const ordinal_type &  sz,
const ordinal_type &  stride,
bool  owned 
)
inline

Reset storage to given array, size, and stride.

Definition at line 185 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION void Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::shallowReset ( pointer  v,
const ordinal_type &  sz,
const ordinal_type &  stride,
bool  owned 
) volatile
inline

Reset storage to given array, size, and stride.

Definition at line 190 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
static KOKKOS_INLINE_FUNCTION ordinal_type Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::size ( )
inlinestatic

Return size.

Definition at line 195 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION const_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator[] ( const ordinal_type &  i) const
inline

Coefficient access (avoid if possible)

Definition at line 199 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION const_volatile_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator[] ( const ordinal_type &  i) const volatile
inline

Coefficient access (avoid if possible)

Definition at line 205 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator[] ( const ordinal_type &  i)
inline

Coefficient access (avoid if possible)

Definition at line 211 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION volatile_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::operator[] ( const ordinal_type &  i) volatile
inline

Coefficient access (avoid if possible)

Definition at line 215 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
template<int i>
KOKKOS_INLINE_FUNCTION reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::getCoeff ( )
inline

Definition at line 220 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
template<int i>
KOKKOS_INLINE_FUNCTION volatile_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::getCoeff ( ) volatile
inline

Definition at line 224 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
template<int i>
KOKKOS_INLINE_FUNCTION const_volatile_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::getCoeff ( ) const volatile
inline

Definition at line 228 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
template<int i>
KOKKOS_INLINE_FUNCTION const_reference Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::getCoeff ( ) const
inline

Definition at line 232 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION const_volatile_pointer Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::coeff ( ) const volatile
inline

Get coefficients.

Definition at line 236 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION const_pointer Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::coeff ( ) const
inline

Get coefficients.

Definition at line 240 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION volatile_pointer Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::coeff ( ) volatile
inline

Get coefficients.

Definition at line 244 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
KOKKOS_INLINE_FUNCTION pointer Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::coeff ( )
inline

Get coefficients.

Definition at line 248 of file Stokhos_StaticFixedStorage.hpp.

Member Data Documentation

template<typename ordinal_t , typename value_t , int Num, typename device_t >
const bool Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::is_static = true
static

Definition at line 40 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
const int Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::static_size = Num
static

Definition at line 41 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
const bool Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::supports_reset = false
static

Definition at line 42 of file Stokhos_StaticFixedStorage.hpp.

template<typename ordinal_t , typename value_t , int Num, typename device_t >
value_type Stokhos::StaticFixedStorage< ordinal_t, value_t, Num, device_t >::coeff_[Num]
private

Coefficient values.

Definition at line 256 of file Stokhos_StaticFixedStorage.hpp.

The documentation for this class was generated from the following file:
Generated on Fri Nov 22 2024 09:18:21 for Stokhos Package Browser (Single Doxygen Collection) by   doxygen 1.8.5