Stokhos::LTBSparse3Tensor< ordinal_type, value_type > Class Template Reference

Data structure storing a sparse 3-tensor C(i,j,k) in a a tree-based format for lexicographically ordered product bases. More...

#include <Stokhos_LTBSparse3Tensor.hpp>

Classes
struct	CijkNode
	Node type used in constructing the tree. More...

Public Member Functions
	LTBSparse3Tensor (const bool symm)
	Constructor. More...
	~LTBSparse3Tensor ()
	Destructor. More...
void	setHeadNode (const Teuchos::RCP< CijkNode > &h)
	Set the head node. More...
Teuchos::RCP< const CijkNode >	getHeadNode () const
	Get the head node. More...
void	print (std::ostream &os) const
	Print tensor. More...
value_type	getValue (ordinal_type i, ordinal_type j, ordinal_type k) const
	Get Cijk value for a given i, j, k indices. More...
ordinal_type	num_entries () const
	Return number of non-zero entries. More...
ordinal_type	num_leafs () const
	Return number of nodes. More...
bool	symmetric () const
	Return if symmetric. More...

Protected Attributes
Teuchos::RCP< CijkNode >	head
bool	is_symmetric

Private Member Functions
	LTBSparse3Tensor (const LTBSparse3Tensor &)
LTBSparse3Tensor &	operator= (const LTBSparse3Tensor &b)

Related Functions
(Note that these are not member functions.)
template<typename ordinal_type , typename value_type >
std::ostream &	operator<< (std::ostream &os, const LTBSparse3Tensor< ordinal_type, value_type > &Cijk)

Detailed Description

template<typename ordinal_type, typename value_type>
class Stokhos::LTBSparse3Tensor< ordinal_type, value_type >

Data structure storing a sparse 3-tensor C(i,j,k) in a a tree-based format for lexicographically ordered product bases.

Definition at line 25 of file Stokhos_LTBSparse3Tensor.hpp.

Constructor & Destructor Documentation

template<typename ordinal_type, typename value_type>

Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::LTBSparse3Tensor ( const bool  symm )

inline

Constructor.

Definition at line 41 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::~LTBSparse3Tensor ( )

inline

Destructor.

Definition at line 44 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::LTBSparse3Tensor ( const LTBSparse3Tensor< ordinal_type, value_type > &  )

private

Member Function Documentation

template<typename ordinal_type, typename value_type>

void Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::setHeadNode ( const Teuchos::RCP< CijkNode > &  h )

inline

Set the head node.

Definition at line 47 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

Teuchos::RCP<const CijkNode> Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::getHeadNode ( ) const

inline

Get the head node.

Definition at line 50 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

void Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::print ( std::ostream &  os ) const

inline

Print tensor.

Definition at line 53 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

value_type Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::getValue ( ordinal_type  i, ordinal_type  j, ordinal_type  k  ) const

inline

Get Cijk value for a given i, j, k indices.

Definition at line 56 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

ordinal_type Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::num_entries ( ) const

inline

Return number of non-zero entries.

Definition at line 60 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

ordinal_type Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::num_leafs ( ) const

inline

Return number of nodes.

Definition at line 67 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

bool Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::symmetric ( ) const

inline

Return if symmetric.

Definition at line 74 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

LTBSparse3Tensor& Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::operator= ( const LTBSparse3Tensor< ordinal_type, value_type > &  b )

private

Friends And Related Function Documentation

template<typename ordinal_type , typename value_type >

std::ostream & operator<< ( std::ostream &  os, const LTBSparse3Tensor< ordinal_type, value_type > &  Cijk  )

related

Print triple product tensor to output stream

Definition at line 96 of file Stokhos_LTBSparse3Tensor.hpp.

Member Data Documentation

template<typename ordinal_type, typename value_type>

Teuchos::RCP<CijkNode> Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::head

protected

Definition at line 86 of file Stokhos_LTBSparse3Tensor.hpp.

template<typename ordinal_type, typename value_type>

bool Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::is_symmetric

protected

Definition at line 87 of file Stokhos_LTBSparse3Tensor.hpp.

---

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

• Stokhos_LTBSparse3Tensor.hpp