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::AnisotropicTotalOrderIndexSet< ordinal_t > Class Template Reference

An anisotropic 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

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

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.

Definition at line 346 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

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

Definition at line 350 of file Stokhos_ProductBasisUtils.hpp.

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

Definition at line 353 of file Stokhos_ProductBasisUtils.hpp.

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

Definition at line 354 of file Stokhos_ProductBasisUtils.hpp.

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

Definition at line 355 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

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)

Definition at line 362 of file Stokhos_ProductBasisUtils.hpp.

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)

Definition at line 375 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

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

Return dimension.

Definition at line 383 of file Stokhos_ProductBasisUtils.hpp.

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

Return maximum order for each dimension.

Definition at line 386 of file Stokhos_ProductBasisUtils.hpp.

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

Return iterator for first element in the set.

Definition at line 389 of file Stokhos_ProductBasisUtils.hpp.

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

Return iterator for end of the index set.

Definition at line 394 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

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

Dimension.

Definition at line 403 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
ordinal_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::lower_order
protected

Lower order of index set.

Definition at line 406 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
ordinal_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::upper_order
protected

Upper order of index set.

Definition at line 409 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
multiindex_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::lower
protected

Component-wise lower bounds.

Definition at line 412 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t>
multiindex_type Stokhos::AnisotropicTotalOrderIndexSet< ordinal_t >::upper
protected

Component-wise upper bounds.

Definition at line 415 of file Stokhos_ProductBasisUtils.hpp.


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