Stokhos Package Browser (Single Doxygen Collection)
Version of the Day
|
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. 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... | |
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.
typedef ordinal_t Stokhos::TotalOrderIndexSet< ordinal_t >::ordinal_type |
Definition at line 187 of file Stokhos_ProductBasisUtils.hpp.
typedef MultiIndex<ordinal_type> Stokhos::TotalOrderIndexSet< ordinal_t >::multiindex_type |
Definition at line 190 of file Stokhos_ProductBasisUtils.hpp.
typedef Iterator Stokhos::TotalOrderIndexSet< ordinal_t >::iterator |
Definition at line 191 of file Stokhos_ProductBasisUtils.hpp.
typedef Iterator Stokhos::TotalOrderIndexSet< ordinal_t >::const_iterator |
Definition at line 192 of file Stokhos_ProductBasisUtils.hpp.
|
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.
|
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.
|
inline |
Return dimension.
Definition at line 214 of file Stokhos_ProductBasisUtils.hpp.
|
inline |
Return maximum order for each dimension.
Definition at line 217 of file Stokhos_ProductBasisUtils.hpp.
|
inline |
Return iterator for first element in the set.
Definition at line 222 of file Stokhos_ProductBasisUtils.hpp.
|
inline |
Return iterator for end of the index set.
Definition at line 229 of file Stokhos_ProductBasisUtils.hpp.
|
protected |
Dimension.
Definition at line 238 of file Stokhos_ProductBasisUtils.hpp.
|
protected |
Lower order of index set.
Definition at line 241 of file Stokhos_ProductBasisUtils.hpp.
|
protected |
Upper order of index set.
Definition at line 244 of file Stokhos_ProductBasisUtils.hpp.