Teuchos - Trilinos Tools Package Version of the Day
Public Types | Public Member Functions
Teuchos::MatrixMarket::SymmetrizingAdder< AdderType > Class Template Reference

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

#include <Teuchos_MatrixMarket_SymmetrizingAdder.hpp>

List of all members.

Public Types

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

Public Member Functions

 SymmetrizingAdder (const Teuchos::RCP< AdderType > &adder, const std::string &symmType)
 Constructor.
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.
Teuchos::RCP< AdderType > getAdder () const
 Persisting non-const view of the underlying adder object.

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:
AdderTypeA 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 112 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 115 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 117 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 125 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 135 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 162 of file Teuchos_MatrixMarket_SymmetrizingAdder.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines