Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Stokhos::TensorProductElement< ordinal_t, element_t > Class Template Reference

Container storing a term in a generalized tensor product. More...

#include <Stokhos_ProductBasisUtils.hpp>

Public Types

typedef ordinal_t ordinal_type
 
typedef element_t element_type
 

Public Member Functions

 TensorProductElement ()
 Default constructor. More...
 
 TensorProductElement (ordinal_type dim, const element_type &val=element_type(0))
 Constructor. More...
 
 ~TensorProductElement ()
 Destructor. More...
 
ordinal_type dimension () const
 Return dimension. More...
 
ordinal_type size () const
 Return dimension. More...
 
const element_typeoperator[] (ordinal_type i) const
 Term access. More...
 
element_typeoperator[] (ordinal_type i)
 Term access. More...
 
const Teuchos::Array
< element_type > & 
getTerm () const
 Term access. More...
 
Teuchos::Array< element_type > & getTerm ()
 Term access. More...
 
 operator Teuchos::ArrayView< element_type > ()
 Convert to ArrayView. More...
 
 operator Teuchos::ArrayView< const element_type > () const
 Convert to ArrayView. More...
 
element_type order () const
 Compute total order of tensor product element. More...
 
std::ostream & print (std::ostream &os) const
 Print multiindex. More...
 

Protected Attributes

Teuchos::Array< element_typeterm
 Array storing term elements. More...
 

Detailed Description

template<typename ordinal_t, typename element_t>
class Stokhos::TensorProductElement< ordinal_t, element_t >

Container storing a term in a generalized tensor product.

Definition at line 717 of file Stokhos_ProductBasisUtils.hpp.

Member Typedef Documentation

template<typename ordinal_t, typename element_t>
typedef ordinal_t Stokhos::TensorProductElement< ordinal_t, element_t >::ordinal_type

Definition at line 720 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
typedef element_t Stokhos::TensorProductElement< ordinal_t, element_t >::element_type

Definition at line 721 of file Stokhos_ProductBasisUtils.hpp.

Constructor & Destructor Documentation

template<typename ordinal_t, typename element_t>
Stokhos::TensorProductElement< ordinal_t, element_t >::TensorProductElement ( )
inline

Default constructor.

Definition at line 724 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
Stokhos::TensorProductElement< ordinal_t, element_t >::TensorProductElement ( ordinal_type  dim,
const element_type val = element_type(0) 
)
inline

Constructor.

Definition at line 727 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
Stokhos::TensorProductElement< ordinal_t, element_t >::~TensorProductElement ( )
inline

Destructor.

Definition at line 732 of file Stokhos_ProductBasisUtils.hpp.

Member Function Documentation

template<typename ordinal_t, typename element_t>
ordinal_type Stokhos::TensorProductElement< ordinal_t, element_t >::dimension ( ) const
inline

Return dimension.

Definition at line 735 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
ordinal_type Stokhos::TensorProductElement< ordinal_t, element_t >::size ( ) const
inline

Return dimension.

Definition at line 738 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
const element_type& Stokhos::TensorProductElement< ordinal_t, element_t >::operator[] ( ordinal_type  i) const
inline

Term access.

Definition at line 741 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
element_type& Stokhos::TensorProductElement< ordinal_t, element_t >::operator[] ( ordinal_type  i)
inline

Term access.

Definition at line 744 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
const Teuchos::Array<element_type>& Stokhos::TensorProductElement< ordinal_t, element_t >::getTerm ( ) const
inline

Term access.

Definition at line 747 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
Teuchos::Array<element_type>& Stokhos::TensorProductElement< ordinal_t, element_t >::getTerm ( )
inline

Term access.

Definition at line 750 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
Stokhos::TensorProductElement< ordinal_t, element_t >::operator Teuchos::ArrayView< element_type > ( )
inline

Convert to ArrayView.

Definition at line 753 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
Stokhos::TensorProductElement< ordinal_t, element_t >::operator Teuchos::ArrayView< const element_type > ( ) const
inline

Convert to ArrayView.

Definition at line 756 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
element_type Stokhos::TensorProductElement< ordinal_t, element_t >::order ( ) const
inline

Compute total order of tensor product element.

Definition at line 759 of file Stokhos_ProductBasisUtils.hpp.

template<typename ordinal_t, typename element_t>
std::ostream& Stokhos::TensorProductElement< ordinal_t, element_t >::print ( std::ostream &  os) const
inline

Print multiindex.

Definition at line 766 of file Stokhos_ProductBasisUtils.hpp.

Member Data Documentation

template<typename ordinal_t, typename element_t>
Teuchos::Array<element_type> Stokhos::TensorProductElement< ordinal_t, element_t >::term
protected

Array storing term elements.

Definition at line 777 of file Stokhos_ProductBasisUtils.hpp.


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