Stokhos Package Browser (Single Doxygen Collection): Stokhos::StandardStorage< ordinal_type, value_type > Class Template Reference

Stokhos Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

#include <Stokhos_StandardStorage.hpp>

Inheritance diagram for Stokhos::StandardStorage< ordinal_type, value_type >:

Inheritance graph

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. More...

	~StandardStorage ()
	Destructor. 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
Teuchos::Array< value_type >	coeff_
	Coefficient values. More...

Detailed Description

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

Definition at line 19 of file Stokhos_StandardStorage.hpp.

Member Typedef Documentation

template<typename ordinal_type, typename value_type>

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

Definition at line 22 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

Definition at line 23 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

Definition at line 24 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

Definition at line 25 of file Stokhos_StandardStorage.hpp.

Constructor & Destructor Documentation

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 34 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

Stokhos::StandardStorage< ordinal_type, value_type >::~StandardStorage ( )

inline

Destructor.

Definition at line 39 of file Stokhos_StandardStorage.hpp.

Member Function Documentation

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 42 of file Stokhos_StandardStorage.hpp.

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 47 of file Stokhos_StandardStorage.hpp.

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 55 of file Stokhos_StandardStorage.hpp.

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 60 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

inline

Return size.

Definition at line 63 of file Stokhos_StandardStorage.hpp.

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 66 of file Stokhos_StandardStorage.hpp.

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 71 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

inline

Get coefficients.

Definition at line 76 of file Stokhos_StandardStorage.hpp.

template<typename ordinal_type, typename value_type>

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

inline

Get coefficients.

Definition at line 79 of file Stokhos_StandardStorage.hpp.

Member Data Documentation

template<typename ordinal_type, typename value_type>

Teuchos::Array<value_type> Stokhos::StandardStorage< ordinal_type, value_type >::coeff_

private

Coefficient values.

Definition at line 84 of file Stokhos_StandardStorage.hpp.

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

Stokhos_StandardStorage.hpp