Stokhos  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Stokhos::MultiIndex< ordinal_t > Class Template Reference

A multidimensional index. More...

#include <Stokhos_ProductBasisUtils.hpp>

Public Types

typedef ordinal_t ordinal_type
 
typedef ordinal_t element_type
 

Public Member Functions

 MultiIndex ()
 Constructor.
 
 MultiIndex (ordinal_type dim, ordinal_type v=ordinal_type(0))
 Constructor.
 
 ~MultiIndex ()
 Destructor.
 
ordinal_type dimension () const
 Dimension.
 
ordinal_type size () const
 Size.
 
const ordinal_type & operator[] (ordinal_type i) const
 Term access.
 
ordinal_type & operator[] (ordinal_type i)
 Term access.
 
const Teuchos::Array
< element_type > & 
getTerm () const
 Term access.
 
Teuchos::Array< element_type > & getTerm ()
 Term access.
 
void init (ordinal_type v)
 Initialize.
 
void resize (ordinal_type d, ordinal_type v=ordinal_type(0))
 Resize.
 
ordinal_type order () const
 Compute total order of index.
 
bool operator== (const MultiIndex &idx) const
 Compare equality.
 
bool operator!= (const MultiIndex &idx) const
 Compare equality.
 
bool termWiseLEQ (const MultiIndex &idx) const
 Compare term-wise less-than or equal-to.
 
std::ostream & print (std::ostream &os) const
 Print multiindex.
 
MultiIndextermWiseMin (const MultiIndex &idx)
 Replace multiindex with min of this and other multiindex.
 
MultiIndextermWiseMin (const ordinal_type idx)
 Replace multiindex with min of this and given value.
 
MultiIndextermWiseMax (const MultiIndex &idx)
 Replace multiindex with max of this and other multiindex.
 
MultiIndextermWiseMax (const ordinal_type idx)
 Replace multiindex with max of this and given value.
 

Protected Attributes

Teuchos::Array< ordinal_type > index
 index terms
 

Detailed Description

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

A multidimensional index.


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