Teuchos::MatrixMarket::SymmetrizingAdder< AdderType > Class Template Reference

Adds entries with optional symmetry to a sparse matrix. More...

#include <Teuchos_MatrixMarket_SymmetrizingAdder.hpp>

Public Types
typedef AdderType::index_type	index_type
	The type of indices of the sparse matrix. More...
typedef AdderType::value_type	value_type
	The type of entries of the sparse matrix. More...

Public Member Functions
	SymmetrizingAdder (const Teuchos::RCP< AdderType > &adder, const std::string &symmType)
	Constructor. More...
void	operator() (const index_type i, const index_type j, const value_type &Aij)
	Add value A_ij to entry (i,j), and optionally symmetrize. More...
Teuchos::RCP< AdderType >	getAdder () const
	Persisting non-const view of the underlying adder object. More...

Private Attributes
Teuchos::RCP< AdderType >	adder_
	The wrapped AdderType instance. More...
bool	symmetrize_
	Whether to do symmetrization at all. More...
bool	conjugate_
	Whether to conjugate when symmetrizing. More...
bool	skew_
	Whether to negate when symmetrizing. More...

Detailed Description

template<class AdderType>
class Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >

Adds entries with optional symmetry to a sparse matrix.

Author

Mark Hoemmen This class wraps any existing class (AdderType) with the interface shown below. Given the Matrix Market symmetry type, this class' corresponding operator() may invoke AdderType's operator() twice, in order to add entry (j,i) if entry (i,j) is to be added.

Template Parameters

AdderType

A class with at least the following interface: class AdderType { public: typedef ... index_type; // Ellipsis represents the actual type typedef ... value_type; // Ellipsis represents the actual type void operator() (const index_type, const index_type, const value_type&); };

Definition at line 80 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

Member Typedef Documentation

template<class AdderType >

typedef AdderType::index_type Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::index_type

The type of indices of the sparse matrix.

Definition at line 83 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

template<class AdderType >

typedef AdderType::value_type Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::value_type

The type of entries of the sparse matrix.

Definition at line 85 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

Constructor & Destructor Documentation

template<class AdderType >

Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::SymmetrizingAdder ( const Teuchos::RCP< AdderType > &  adder, const std::string &  symmType  )

inline

Constructor.

Parameters

adder	[in/out] The wrapped AdderType instance
symmType	[in] Canonical Matrix Market string representing the symmetry storage type of the matrix data.

Definition at line 93 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

Member Function Documentation

template<class AdderType >

void Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::operator() ( const index_type  i, const index_type  j, const value_type &  Aij  )

inline

Add value A_ij to entry (i,j), and optionally symmetrize.

Definition at line 103 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

template<class AdderType >

Teuchos::RCP<AdderType> Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::getAdder ( ) const

inline

Persisting non-const view of the underlying adder object.

This violates encapsulation, so please be careful with this.

Definition at line 130 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

Member Data Documentation

template<class AdderType >

Teuchos::RCP<AdderType> Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::adder_

private

The wrapped AdderType instance.

Definition at line 136 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

template<class AdderType >

bool Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::symmetrize_

private

Whether to do symmetrization at all.

Definition at line 138 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

template<class AdderType >

bool Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::conjugate_

private

Whether to conjugate when symmetrizing.

Definition at line 140 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

template<class AdderType >

bool Teuchos::MatrixMarket::SymmetrizingAdder< AdderType >::skew_

private

Whether to negate when symmetrizing.

Definition at line 142 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.

---

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

• Teuchos_MatrixMarket_SymmetrizingAdder.hpp