Stokhos::MultiIndex< ordinal_t > Class Template Reference

A multidimensional index. More...

#include <Stokhos_ProductBasisUtils.hpp>

Public Types
typedef ordinal_t	ordinal_type
typedef ordinal_t	element_type

Public Member Functions
	MultiIndex ()
	Constructor.
	MultiIndex (ordinal_type dim, ordinal_type v=ordinal_type(0))
	Constructor.
	~MultiIndex ()
	Destructor.
ordinal_type	dimension () const
	Dimension.
ordinal_type	size () const
	Size.
const ordinal_type &	operator[] (ordinal_type i) const
	Term access.
ordinal_type &	operator[] (ordinal_type i)
	Term access.
const Teuchos::Array< element_type > &	getTerm () const
	Term access.
Teuchos::Array< element_type > &	getTerm ()
	Term access.
void	init (ordinal_type v)
	Initialize.
void	resize (ordinal_type d, ordinal_type v=ordinal_type(0))
	Resize.
ordinal_type	order () const
	Compute total order of index.
bool	operator== (const MultiIndex &idx) const
	Compare equality.
bool	operator!= (const MultiIndex &idx) const
	Compare equality.
bool	termWiseLEQ (const MultiIndex &idx) const
	Compare term-wise less-than or equal-to.
std::ostream &	print (std::ostream &os) const
	Print multiindex.
MultiIndex &	termWiseMin (const MultiIndex &idx)
	Replace multiindex with min of this and other multiindex.
MultiIndex &	termWiseMin (const ordinal_type idx)
	Replace multiindex with min of this and given value.
MultiIndex &	termWiseMax (const MultiIndex &idx)
	Replace multiindex with max of this and other multiindex.
MultiIndex &	termWiseMax (const ordinal_type idx)
	Replace multiindex with max of this and given value.

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

Detailed Description

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

A multidimensional index.

Member Function Documentation

dimension()

template<typename ordinal_t>

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

inline

Dimension.

Referenced by Stokhos::CompletePolynomialBasisUtils< ordinal_type, value_type >::compute_index(), and Stokhos::MultiIndex< ordinal_type >::operator==().

size()

template<typename ordinal_t>

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

inline

Size.

Referenced by Stokhos::OrthogPolyApprox< ordinal_type, value_type, storage_type >::print(), and Stokhos::VectorOrthogPoly< coeff_type >::print().

Member Data Documentation

index

template<typename ordinal_t>

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

protected

index terms

Referenced by Stokhos::MultiIndex< ordinal_type >::operator==(), and Stokhos::MultiIndex< ordinal_type >::termWiseLEQ().

---

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

• Stokhos_ProductBasisUtils.hpp