Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
Teuchos::MatrixMarket::SymmetrizingGraphAdder< AdderType > Class Template Reference

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

#include <Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp>

Public Types

typedef AdderType::index_type index_type
 The type of indices of the sparse graph. More...

Public Member Functions

 SymmetrizingGraphAdder (const Teuchos::RCP< AdderType > &adder, const std::string &symmType)
 Constructor. More...
void operator() (const index_type i, const index_type j)
 Add entry (i,j), and optionally symmetrize. More...
Teuchos::RCP< AdderType > getAdder () const
 Persisting non-const view of the underlying adder object. More...

Detailed Description

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

Adds entries with optional symmetry to a sparse graph.

Alicia Klinvex 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 {
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 63 of file Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp.

Member Typedef Documentation

template<class AdderType >
typedef AdderType::index_type Teuchos::MatrixMarket::SymmetrizingGraphAdder< AdderType >::index_type

The type of indices of the sparse graph.

Definition at line 66 of file Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp.

Constructor & Destructor Documentation

template<class AdderType >
Teuchos::MatrixMarket::SymmetrizingGraphAdder< AdderType >::SymmetrizingGraphAdder ( const Teuchos::RCP< AdderType > &  adder,
const std::string &  symmType 


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 74 of file Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp.

Member Function Documentation

template<class AdderType >
void Teuchos::MatrixMarket::SymmetrizingGraphAdder< AdderType >::operator() ( const index_type  i,
const index_type  j 

Add entry (i,j), and optionally symmetrize.

Definition at line 83 of file Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp.

template<class AdderType >
Teuchos::RCP<AdderType> Teuchos::MatrixMarket::SymmetrizingGraphAdder< AdderType >::getAdder ( ) const

Persisting non-const view of the underlying adder object.

This violates encapsulation, so please be careful with this.

Definition at line 105 of file Teuchos_MatrixMarket_SymmetrizingGraphAdder.hpp.

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