Stokhos::TotalOrderIndexSet< ordinal_t > Class Template Reference

An isotropic total order index set. More...

#include <Stokhos_ProductBasisUtils.hpp>

Classes
class	Iterator
	Iterator class for iterating over elements of the index set. More...

Public Types
typedef ordinal_t	ordinal_type
typedef MultiIndex< ordinal_type >	multiindex_type
typedef Iterator	iterator
typedef Iterator	const_iterator

Public Member Functions
	TotalOrderIndexSet (ordinal_type dim_, ordinal_type lower_, ordinal_type upper_)
	Constructor.
	TotalOrderIndexSet (ordinal_type dim_, ordinal_type upper_)
	Constructor.
ordinal_type	dimension () const
	Return dimension.
multiindex_type	max_orders () const
	Return maximum order for each dimension.
const_iterator	begin () const
	Return iterator for first element in the set.
const_iterator	end () const
	Return iterator for end of the index set.

Protected Attributes
ordinal_type	dim
	Dimension.
ordinal_type	lower
	Lower order of index set.
ordinal_type	upper
	Upper order of index set.

Detailed Description

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

An isotropic total order index set.

Represents the set l <= |i| <= u given upper and lower bounds l and u, and |i| = i_1 + ... + i_d where d is the dimension of the index.

Currently this class only really provides an input iterator for iterating over the elements of the index set. One should not make any assumption on the order of these elements.

Constructor & Destructor Documentation

TotalOrderIndexSet() [1/2]

template<typename ordinal_t>

Stokhos::TotalOrderIndexSet< ordinal_t >::TotalOrderIndexSet ( ordinal_type dim_, ordinal_type lower_, ordinal_type upper_ )

inline

Constructor.

dim_ is the dimension of the index set, lower_ is the lower bound of the index set, and upper_ is the upper bound (inclusive)

References dim, lower, and upper.

TotalOrderIndexSet() [2/2]

template<typename ordinal_t>

Stokhos::TotalOrderIndexSet< ordinal_t >::TotalOrderIndexSet ( ordinal_type dim_, ordinal_type upper_ )

inline

Constructor.

dim_ is the dimension of the index set, the lower bound is zero, and upper_ is the upper bound (inclusive)

References dim, lower, and upper.

Member Function Documentation

begin()

template<typename ordinal_t>

const_iterator Stokhos::TotalOrderIndexSet< ordinal_t >::begin ( ) const

inline

Return iterator for first element in the set.

References dim, Stokhos::TotalOrderIndexSet< ordinal_t >::Iterator::Iterator(), lower, and upper.

dimension()

template<typename ordinal_t>

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

inline

Return dimension.

References dim.

Referenced by Stokhos::TotalOrderIndexSet< ordinal_t >::Iterator::Iterator().

end()

template<typename ordinal_t>

const_iterator Stokhos::TotalOrderIndexSet< ordinal_t >::end ( ) const

inline

Return iterator for end of the index set.

References dim, Stokhos::TotalOrderIndexSet< ordinal_t >::Iterator::Iterator(), and upper.

max_orders()

template<typename ordinal_t>

multiindex_type Stokhos::TotalOrderIndexSet< ordinal_t >::max_orders ( ) const

inline

Return maximum order for each dimension.

References dim, and upper.

Member Data Documentation

dim

template<typename ordinal_t>

ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::dim

protected

Dimension.

Referenced by begin(), dimension(), end(), max_orders(), TotalOrderIndexSet(), and TotalOrderIndexSet().

lower

template<typename ordinal_t>

ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::lower

protected

Lower order of index set.

Referenced by begin(), TotalOrderIndexSet(), and TotalOrderIndexSet().

upper

template<typename ordinal_t>

ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::upper

protected

Upper order of index set.

Referenced by begin(), end(), max_orders(), TotalOrderIndexSet(), and TotalOrderIndexSet().

---

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

• Stokhos_ProductBasisUtils.hpp