Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
Stokhos::StandardStorage< ordinal_type, value_type > Class Template Reference

#include <Stokhos_StandardStorage.hpp>

Inheritance diagram for Stokhos::StandardStorage< ordinal_type, value_type >:
Inheritance graph
[legend]

Classes

struct  apply
 Turn StandardStorage 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
 

Public Member Functions

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

Private Attributes

Teuchos::Array< value_type > coeff_
 Coefficient values.
 

Detailed Description

template<typename ordinal_type, typename value_type>
class Stokhos::StandardStorage< ordinal_type, value_type >

Definition at line 53 of file Stokhos_StandardStorage.hpp.

Member Typedef Documentation

◆ reference

template<typename ordinal_type , typename value_type >
typedef value_type& Stokhos::StandardStorage< ordinal_type, value_type >::reference

Definition at line 56 of file Stokhos_StandardStorage.hpp.

◆ const_reference

template<typename ordinal_type , typename value_type >
typedef const value_type& Stokhos::StandardStorage< ordinal_type, value_type >::const_reference

Definition at line 57 of file Stokhos_StandardStorage.hpp.

◆ pointer

template<typename ordinal_type , typename value_type >
typedef value_type* Stokhos::StandardStorage< ordinal_type, value_type >::pointer

Definition at line 58 of file Stokhos_StandardStorage.hpp.

◆ const_pointer

template<typename ordinal_type , typename value_type >
typedef const value_type* Stokhos::StandardStorage< ordinal_type, value_type >::const_pointer

Definition at line 59 of file Stokhos_StandardStorage.hpp.

Constructor & Destructor Documentation

◆ StandardStorage()

template<typename ordinal_type , typename value_type >
Stokhos::StandardStorage< ordinal_type, value_type >::StandardStorage ( const ordinal_type & sz,
const value_type & x = value_type(0.0) )
inline

Constructor.

Definition at line 68 of file Stokhos_StandardStorage.hpp.

◆ ~StandardStorage()

template<typename ordinal_type , typename value_type >
Stokhos::StandardStorage< ordinal_type, value_type >::~StandardStorage ( )
inline

Destructor.

Definition at line 73 of file Stokhos_StandardStorage.hpp.

Member Function Documentation

◆ init() [1/2]

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

Initialize values to a constant value.

Definition at line 76 of file Stokhos_StandardStorage.hpp.

◆ init() [2/2]

template<typename ordinal_type , typename value_type >
void Stokhos::StandardStorage< ordinal_type, value_type >::init ( const_pointer v,
const ordinal_type & sz = 0 )
inline

Initialize values to an array of values.

Definition at line 81 of file Stokhos_StandardStorage.hpp.

◆ load()

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

Load values to an array of values.

Definition at line 89 of file Stokhos_StandardStorage.hpp.

◆ resize()

template<typename ordinal_type , typename value_type >
void Stokhos::StandardStorage< ordinal_type, value_type >::resize ( const ordinal_type & sz)
inline

Resize to new size (values are preserved)

Definition at line 94 of file Stokhos_StandardStorage.hpp.

◆ size()

template<typename ordinal_type , typename value_type >
ordinal_type Stokhos::StandardStorage< ordinal_type, value_type >::size ( ) const
inline

Return size.

Definition at line 97 of file Stokhos_StandardStorage.hpp.

◆ operator[]() [1/2]

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

Coefficient access (avoid if possible)

Definition at line 100 of file Stokhos_StandardStorage.hpp.

◆ operator[]() [2/2]

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

Coefficient access (avoid if possible)

Definition at line 105 of file Stokhos_StandardStorage.hpp.

◆ coeff() [1/2]

template<typename ordinal_type , typename value_type >
const_pointer Stokhos::StandardStorage< ordinal_type, value_type >::coeff ( ) const
inline

Get coefficients.

Definition at line 110 of file Stokhos_StandardStorage.hpp.

◆ coeff() [2/2]

template<typename ordinal_type , typename value_type >
pointer Stokhos::StandardStorage< ordinal_type, value_type >::coeff ( )
inline

Get coefficients.

Definition at line 113 of file Stokhos_StandardStorage.hpp.

Member Data Documentation

◆ coeff_

template<typename ordinal_type , typename value_type >
Teuchos::Array<value_type> Stokhos::StandardStorage< ordinal_type, value_type >::coeff_
private

Coefficient values.

Definition at line 118 of file Stokhos_StandardStorage.hpp.


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