Stokhos::TensorProductIndexSet< ordinal_t > Class Template Reference

A tensor product 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
	TensorProductIndexSet (ordinal_type dim_, ordinal_type lower_, ordinal_type upper_)
	Constructor. More...
	TensorProductIndexSet (ordinal_type dim_, ordinal_type upper_)
	Constructor. More...
	TensorProductIndexSet (const multiindex_type &lower_, const multiindex_type &upper_)
	Constructor. More...
	TensorProductIndexSet (const multiindex_type &upper_)
	Constructor. More...
ordinal_type	dimension () const
	Return dimension. More...
multiindex_type	max_orders () const
	Return maximum order for each dimension. More...
const_iterator	begin () const
	Return iterator for first element in the set. More...
const_iterator	end () const
	Return iterator for end of the index set. More...

Protected Attributes
ordinal_type	dim
	Dimension. More...
multiindex_type	lower
	Lower bound of index set. More...
multiindex_type	upper
	Upper bound of index set. More...

Detailed Description

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

A tensor product index set.

Represents the set l_j <= i_j <= u_j given upper and lower bounds l_j and u_j, for j = 1,...,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.

Definition at line 558 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

template<typename ordinal_t>

typedef ordinal_t Stokhos::TensorProductIndexSet< ordinal_t >::ordinal_type

Definition at line 562 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

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

Definition at line 565 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

typedef Iterator Stokhos::TensorProductIndexSet< ordinal_t >::iterator

Definition at line 566 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

typedef Iterator Stokhos::TensorProductIndexSet< ordinal_t >::const_iterator

Definition at line 567 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

template<typename ordinal_t>

Stokhos::TensorProductIndexSet< ordinal_t >::TensorProductIndexSet ( 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)

Definition at line 574 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Stokhos::TensorProductIndexSet< ordinal_t >::TensorProductIndexSet ( 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)

Definition at line 584 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Stokhos::TensorProductIndexSet< ordinal_t >::TensorProductIndexSet ( 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)

Definition at line 593 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

Stokhos::TensorProductIndexSet< ordinal_t >::TensorProductIndexSet ( 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)

Definition at line 602 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

template<typename ordinal_t>

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

inline

Return dimension.

Definition at line 606 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

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

inline

Return maximum order for each dimension.

Definition at line 609 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

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

inline

Return iterator for first element in the set.

Definition at line 614 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

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

inline

Return iterator for end of the index set.

Definition at line 619 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

template<typename ordinal_t>

ordinal_type Stokhos::TensorProductIndexSet< ordinal_t >::dim

protected

Dimension.

Definition at line 628 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

multiindex_type Stokhos::TensorProductIndexSet< ordinal_t >::lower

protected

Lower bound of index set.

Definition at line 631 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>

multiindex_type Stokhos::TensorProductIndexSet< ordinal_t >::upper

protected

Upper bound of index set.

Definition at line 634 of file Stokhos_ProductBasisUtils.hpp.

---

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

• Stokhos_ProductBasisUtils.hpp