Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
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_typemultiindex_type
 
typedef Iterator iterator
 
typedef Iterator const_iterator
 

Public Member Functions

 TotalOrderIndexSet (ordinal_type dim_, ordinal_type lower_, ordinal_type upper_)
 Constructor. More...
 
 TotalOrderIndexSet (ordinal_type dim_, ordinal_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...
 
ordinal_type lower
 Lower order of index set. More...
 
ordinal_type upper
 Upper order of index set. More...
 

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.

Definition at line 183 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

template<typename ordinal_t>
typedef ordinal_t Stokhos::TotalOrderIndexSet< ordinal_t >::ordinal_type

Definition at line 187 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
typedef MultiIndex<ordinal_type> Stokhos::TotalOrderIndexSet< ordinal_t >::multiindex_type

Definition at line 190 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
typedef Iterator Stokhos::TotalOrderIndexSet< ordinal_t >::iterator

Definition at line 191 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
typedef Iterator Stokhos::TotalOrderIndexSet< ordinal_t >::const_iterator

Definition at line 192 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

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)

Definition at line 199 of file Stokhos_ProductBasisUtils.hpp.

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)

Definition at line 209 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

template<typename ordinal_t>
ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::dimension ( ) const
inline

Return dimension.

Definition at line 214 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
multiindex_type Stokhos::TotalOrderIndexSet< ordinal_t >::max_orders ( ) const
inline

Return maximum order for each dimension.

Definition at line 217 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
const_iterator Stokhos::TotalOrderIndexSet< ordinal_t >::begin ( ) const
inline

Return iterator for first element in the set.

Definition at line 222 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
const_iterator Stokhos::TotalOrderIndexSet< ordinal_t >::end ( ) const
inline

Return iterator for end of the index set.

Definition at line 229 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

template<typename ordinal_t>
ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::dim
protected

Dimension.

Definition at line 238 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::lower
protected

Lower order of index set.

Definition at line 241 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
ordinal_type Stokhos::TotalOrderIndexSet< ordinal_t >::upper
protected

Upper order of index set.

Definition at line 244 of file Stokhos_ProductBasisUtils.hpp.


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