Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t > Class Template Reference

An anisotropic total order index set. More...

#include <Stokhos_ProductBasisUtils.hpp>

Collaboration diagram for Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >:

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
	AnisotropicTotalOrderIndexSet (ordinal_type upper_order_, const multiindex_type &lower_, const multiindex_type &upper_)
	Constructor.
	AnisotropicTotalOrderIndexSet (ordinal_type upper_order_, const multiindex_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_order
	Lower order of index set.
ordinal_type	upper_order
	Upper order of index set.
multiindex_type	lower
	Component-wise lower bounds.
multiindex_type	upper
	Component-wise upper bounds.

Detailed Description

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

An anisotropic total order index set.

Represents the set l <= |i| <= u and i_j <= u_j given upper and lower order bounds l and u, upper component bounds u_j, 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

AnisotropicTotalOrderIndexSet() [1/2]

template<typename ordinal_t>

Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::AnisotropicTotalOrderIndexSet ( ordinal_type upper_order_, const multiindex_type & lower_, const multiindex_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, dimension(), lower, upper, and upper_order.

AnisotropicTotalOrderIndexSet() [2/2]

template<typename ordinal_t>

Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::AnisotropicTotalOrderIndexSet ( ordinal_type upper_order_, const multiindex_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, dimension(), lower, upper, and upper_order.

Member Function Documentation

begin()

template<typename ordinal_t>

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

inline

Return iterator for first element in the set.

References Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::Iterator::Iterator(), lower, upper, and upper_order.

dimension()

template<typename ordinal_t>

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

inline

Return dimension.

References dim.

Referenced by AnisotropicTotalOrderIndexSet(), AnisotropicTotalOrderIndexSet(), and Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::Iterator::Iterator().

end()

template<typename ordinal_t>

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

inline

Return iterator for end of the index set.

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

max_orders()

template<typename ordinal_t>

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

inline

Return maximum order for each dimension.

References upper.

Member Data Documentation

dim

template<typename ordinal_t>

ordinal_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::dim

protected

Dimension.

Referenced by AnisotropicTotalOrderIndexSet(), AnisotropicTotalOrderIndexSet(), dimension(), and end().

lower

template<typename ordinal_t>

multiindex_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::lower

protected

Component-wise lower bounds.

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

upper

template<typename ordinal_t>

multiindex_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::upper

protected

Component-wise upper bounds.

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

upper_order

template<typename ordinal_t>

ordinal_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::upper_order

protected

Upper order of index set.

Referenced by AnisotropicTotalOrderIndexSet(), AnisotropicTotalOrderIndexSet(), begin(), and end().

---

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

• Stokhos_ProductBasisUtils.hpp