Stokhos Development
Classes | Public Types | Public Member Functions | Protected Attributes
Stokhos::TensorProductIndexSet< ordinal_t > Class Template Reference

A tensor product index set. More...

#include <Stokhos_ProductBasisUtils.hpp>

Collaboration diagram for Stokhos::TensorProductIndexSet< ordinal_t >:
Collaboration graph
[legend]

List of all members.

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.
 TensorProductIndexSet (ordinal_type dim_, ordinal_type upper_)
 Constructor.
 TensorProductIndexSet (const multiindex_type &lower_, const multiindex_type &upper_)
 Constructor.
 TensorProductIndexSet (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.
multiindex_type lower
 Lower bound of index set.
multiindex_type upper
 Upper bound of index set.

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.


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)

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)

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)

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)


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator