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 | Private Attributes | List of all members
Stokhos::StaticStandardStorage< ordinal_type, value_type, Num > Class Template Reference

Statically allocated storage class. More...

#include <Stokhos_StaticStandardStorage.hpp>

Classes

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

Public Types

typedef value_type & reference
 
typedef const value_type & const_reference
 
typedef value_type * pointer
 
typedef const value_type * const_pointer
 
typedef Sacado::ss_array
< value_type > 		ss
 

Public Member Functions

 StaticStandardStorage (const ordinal_type &sz_, const value_type &x=value_type(0.0))
 Constructor. More...
 
 StaticStandardStorage (const StaticStandardStorage &s)
 Copy constructor. More...
 
 ~StaticStandardStorage ()
 Destructor. More...
 
StaticStandardStorage & operator= (const StaticStandardStorage &s)
 Assignment operator. More...
 
void init (const_reference v)
 Initialize values to a constant value. More...
 
void init (const_pointer v, const ordinal_type &sz_=0)
 Initialize values to an array of values. More...
 
void load (pointer v)
 Load values to an array of values. More...
 
void resize (const ordinal_type &sz_)
 Resize to new size (values are preserved) More...
 
ordinal_type size () const
 Return size. More...
 
const_reference operator[] (const ordinal_type &i) const
 Coefficient access (avoid if possible) More...
 
reference operator[] (const ordinal_type &i)
 Coefficient access (avoid if possible) More...
 
const_pointer coeff () const
 Get coefficients. More...
 
pointer coeff ()
 Get coefficients. More...
 

Private Attributes

value_type coeff_ [Num]
 Coefficient values. More...
 
ordinal_type sz
 Size of array used. More...
 

Detailed Description

template<typename ordinal_type, typename value_type, int Num>
class Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >

Statically allocated storage class.

Definition at line 20 of file Stokhos_StaticStandardStorage.hpp.

Member Typedef Documentation

template<typename ordinal_type , typename value_type , int Num>
typedef value_type& Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::reference

Definition at line 23 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
typedef const value_type& Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::const_reference

Definition at line 24 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
typedef value_type* Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::pointer

Definition at line 25 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
typedef const value_type* Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::const_pointer

Definition at line 26 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
typedef Sacado::ss_array<value_type> Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::ss

Definition at line 27 of file Stokhos_StaticStandardStorage.hpp.

Constructor & Destructor Documentation

template<typename ordinal_type , typename value_type , int Num>
Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::StaticStandardStorage ( const ordinal_type &  sz_,
const value_type &  x = value_type(0.0) 
)
inline

Constructor.

Definition at line 36 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::StaticStandardStorage ( const StaticStandardStorage< ordinal_type, value_type, Num > &  s)
inline

Copy constructor.

Definition at line 42 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::~StaticStandardStorage ( )
inline

Destructor.

Definition at line 47 of file Stokhos_StaticStandardStorage.hpp.

Member Function Documentation

template<typename ordinal_type , typename value_type , int Num>
StaticStandardStorage& Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::operator= ( const StaticStandardStorage< ordinal_type, value_type, Num > &  s)
inline

Assignment operator.

Definition at line 50 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
void Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::init ( const_reference  v)
inline

Initialize values to a constant value.

Definition at line 57 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
void Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::init ( const_pointer  v,
const ordinal_type &  sz_ = 0 
)
inline

Initialize values to an array of values.

Definition at line 62 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
void Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::load ( pointer  v)
inline

Load values to an array of values.

Definition at line 70 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
void Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::resize ( const ordinal_type &  sz_)
inline

Resize to new size (values are preserved)

Definition at line 75 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
ordinal_type Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::size ( ) const
inline

Return size.

Definition at line 82 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
const_reference Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::operator[] ( const ordinal_type &  i) const
inline

Coefficient access (avoid if possible)

Definition at line 85 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
reference Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::operator[] ( const ordinal_type &  i)
inline

Coefficient access (avoid if possible)

Definition at line 90 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
const_pointer Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::coeff ( ) const
inline

Get coefficients.

Definition at line 93 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
pointer Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::coeff ( )
inline

Get coefficients.

Definition at line 96 of file Stokhos_StaticStandardStorage.hpp.

Member Data Documentation

template<typename ordinal_type , typename value_type , int Num>
value_type Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::coeff_[Num]
private

Coefficient values.

Definition at line 101 of file Stokhos_StaticStandardStorage.hpp.

template<typename ordinal_type , typename value_type , int Num>
ordinal_type Stokhos::StaticStandardStorage< ordinal_type, value_type, Num >::sz
private

Size of array used.

Definition at line 104 of file Stokhos_StaticStandardStorage.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5