Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Attributes | Private Member Functions | Related Symbols | List of all members
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.
 
 ~LTBSparse3Tensor ()
 Destructor.
 
void setHeadNode (const Teuchos::RCP< CijkNode > &h)
 Set the head node.
 
Teuchos::RCP< const CijkNodegetHeadNode () const
 Get the head node.
 
void print (std::ostream &os) const
 Print tensor.
 
value_type getValue (ordinal_type i, ordinal_type j, ordinal_type k) const
 Get Cijk value for a given i, j, k indices.
 
ordinal_type num_entries () const
 Return number of non-zero entries.
 
ordinal_type num_leafs () const
 Return number of nodes.
 
bool symmetric () const
 Return if symmetric.
 

Protected Attributes

Teuchos::RCP< CijkNodehead
 
bool is_symmetric
 

Private Member Functions

 LTBSparse3Tensor (const LTBSparse3Tensor &)
 
LTBSparse3Tensoroperator= (const LTBSparse3Tensor &b)
 

Related Symbols

(Note that these are not member symbols.)

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 57 of file Stokhos_LTBSparse3Tensor.hpp.

Constructor & Destructor Documentation

◆ LTBSparse3Tensor() [1/2]

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

Constructor.

Definition at line 73 of file Stokhos_LTBSparse3Tensor.hpp.

◆ ~LTBSparse3Tensor()

template<typename ordinal_type , typename value_type >
Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::~LTBSparse3Tensor ( )
inline

Destructor.

Definition at line 76 of file Stokhos_LTBSparse3Tensor.hpp.

◆ LTBSparse3Tensor() [2/2]

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

Member Function Documentation

◆ setHeadNode()

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 79 of file Stokhos_LTBSparse3Tensor.hpp.

◆ getHeadNode()

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 82 of file Stokhos_LTBSparse3Tensor.hpp.

◆ print()

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 85 of file Stokhos_LTBSparse3Tensor.hpp.

◆ getValue()

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 88 of file Stokhos_LTBSparse3Tensor.hpp.

◆ num_entries()

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 92 of file Stokhos_LTBSparse3Tensor.hpp.

◆ num_leafs()

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 99 of file Stokhos_LTBSparse3Tensor.hpp.

◆ symmetric()

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

Return if symmetric.

Definition at line 106 of file Stokhos_LTBSparse3Tensor.hpp.

◆ operator=()

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 Symbol Documentation

◆ operator<<()

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 127 of file Stokhos_LTBSparse3Tensor.hpp.

Member Data Documentation

◆ head

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

Definition at line 118 of file Stokhos_LTBSparse3Tensor.hpp.

◆ is_symmetric

template<typename ordinal_type , typename value_type >
bool Stokhos::LTBSparse3Tensor< ordinal_type, value_type >::is_symmetric
protected

Definition at line 119 of file Stokhos_LTBSparse3Tensor.hpp.


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