A multidimensional index. More...

#include <Stokhos_ProductBasisUtils.hpp>

Inheritance diagram for Stokhos::MultiIndex< ordinal_t >:

Public Types
typedef ordinal_t	ordinal_type

typedef ordinal_t	element_type

Public Member Functions
	MultiIndex ()
	Constructor. More...

	MultiIndex (ordinal_type dim, ordinal_type v=ordinal_type(0))
	Constructor. More...

	~MultiIndex ()
	Destructor. More...

ordinal_type	dimension () const
	Dimension. More...

ordinal_type	size () const
	Size. More...

const ordinal_type &	operator[] (ordinal_type i) const
	Term access. More...

ordinal_type &	operator[] (ordinal_type i)
	Term access. More...

const Teuchos::Array < element_type > &	getTerm () const
	Term access. More...

Teuchos::Array< element_type > &	getTerm ()
	Term access. More...

void	init (ordinal_type v)
	Initialize. More...

void	resize (ordinal_type d, ordinal_type v=ordinal_type(0))
	Resize. More...

ordinal_type	order () const
	Compute total order of index. More...

bool	operator== (const MultiIndex &idx) const
	Compare equality. More...

bool	operator!= (const MultiIndex &idx) const
	Compare equality. More...

bool	termWiseLEQ (const MultiIndex &idx) const
	Compare term-wise less-than or equal-to. More...

std::ostream &	print (std::ostream &os) const
	Print multiindex. More...

MultiIndex &	termWiseMin (const MultiIndex &idx)
	Replace multiindex with min of this and other multiindex. More...

MultiIndex &	termWiseMin (const ordinal_type idx)
	Replace multiindex with min of this and given value. More...

MultiIndex &	termWiseMax (const MultiIndex &idx)
	Replace multiindex with max of this and other multiindex. More...

MultiIndex &	termWiseMax (const ordinal_type idx)
	Replace multiindex with max of this and given value. More...

Protected Attributes
Teuchos::Array< ordinal_type >	index
	index terms More...

Detailed Description

template<typename ordinal_t>
class Stokhos::MultiIndex< ordinal_t >

A multidimensional index.

Definition at line 47 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

template<typename ordinal_t>

typedef ordinal_t Stokhos::MultiIndex< ordinal_t >::ordinal_type

Definition at line 50 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

typedef ordinal_t Stokhos::MultiIndex< ordinal_t >::element_type

Definition at line 51 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

template<typename ordinal_t>

Stokhos::MultiIndex< ordinal_t >::MultiIndex ( )

inline

Constructor.

Definition at line 54 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Stokhos::MultiIndex< ordinal_t >::MultiIndex	(	ordinal_type	dim,
		ordinal_type	v = `ordinal_type(0)`
	)

inline

Constructor.

Definition at line 57 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Stokhos::MultiIndex< ordinal_t >::~MultiIndex ( )

inline

Destructor.

Definition at line 61 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

template<typename ordinal_t>

ordinal_type Stokhos::MultiIndex< ordinal_t >::dimension ( ) const

inline

Dimension.

Definition at line 64 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

ordinal_type Stokhos::MultiIndex< ordinal_t >::size ( ) const

inline

Size.

Definition at line 67 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

const ordinal_type& Stokhos::MultiIndex< ordinal_t >::operator[] ( ordinal_type i ) const

inline

Term access.

Definition at line 70 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

ordinal_type& Stokhos::MultiIndex< ordinal_t >::operator[] ( ordinal_type i )

inline

Term access.

Definition at line 73 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

const Teuchos::Array<element_type>& Stokhos::MultiIndex< ordinal_t >::getTerm ( ) const

inline

Term access.

Definition at line 76 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Teuchos::Array<element_type>& Stokhos::MultiIndex< ordinal_t >::getTerm ( )

inline

Term access.

Definition at line 79 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

void Stokhos::MultiIndex< ordinal_t >::init ( ordinal_type v )

inline

Initialize.

Definition at line 82 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

void Stokhos::MultiIndex< ordinal_t >::resize	(	ordinal_type	d,
		ordinal_type	v = `ordinal_type(0)`
	)

inline

Resize.

Definition at line 88 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

ordinal_type Stokhos::MultiIndex< ordinal_t >::order ( ) const

inline

Compute total order of index.

Definition at line 93 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

bool Stokhos::MultiIndex< ordinal_t >::operator== ( const MultiIndex< ordinal_t > & idx ) const

inline

Compare equality.

Definition at line 100 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

bool Stokhos::MultiIndex< ordinal_t >::operator!= ( const MultiIndex< ordinal_t > & idx ) const

inline

Compare equality.

Definition at line 111 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

bool Stokhos::MultiIndex< ordinal_t >::termWiseLEQ ( const MultiIndex< ordinal_t > & idx ) const

inline

Compare term-wise less-than or equal-to.

Definition at line 114 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

std::ostream& Stokhos::MultiIndex< ordinal_t >::print ( std::ostream & os ) const

inline

Print multiindex.

Definition at line 123 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

MultiIndex& Stokhos::MultiIndex< ordinal_t >::termWiseMin ( const MultiIndex< ordinal_t > & idx )

inline

Replace multiindex with min of this and other multiindex.

Definition at line 132 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

MultiIndex& Stokhos::MultiIndex< ordinal_t >::termWiseMin ( const ordinal_type idx )

inline

Replace multiindex with min of this and given value.

Definition at line 139 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

MultiIndex& Stokhos::MultiIndex< ordinal_t >::termWiseMax ( const MultiIndex< ordinal_t > & idx )

inline

Replace multiindex with max of this and other multiindex.

Definition at line 146 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

MultiIndex& Stokhos::MultiIndex< ordinal_t >::termWiseMax ( const ordinal_type idx )

inline

Replace multiindex with max of this and given value.

Definition at line 153 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

template<typename ordinal_t>

Teuchos::Array<ordinal_type> Stokhos::MultiIndex< ordinal_t >::index

protected

index terms

Definition at line 162 of file Stokhos_ProductBasisUtils.hpp.

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

Stokhos_ProductBasisUtils.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<typename ordinal_t> class Stokhos::MultiIndex< ordinal_t >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename ordinal_t>
class Stokhos::MultiIndex< ordinal_t >