All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
NetworKit::Matcher Class Referenceabstract

Abstract base class for matching algorithms. More...

#include <Matcher.h>

Public Member Functions

 Matcher (const Graph &G)
 Constructor. More...
 
 Matcher (const Graph &G, const std::vector< double > &edgeScores)
 Constructor. More...
 
virtual ~Matcher ()=default
 Default destructor. More...
 
virtual void run ()=0
 Run the matching algorithm on the stored graph and return a matching. More...
 
Matching getMatching () const
 
- Public Member Functions inherited from NetworKit::Algorithm
 Algorithm ()
 Constructor to the algorithm base class. More...
 
virtual ~Algorithm ()=default
 Virtual default destructor. More...
 
bool hasFinished () const
 Indicates whether an algorithm has completed computation or not. More...
 
void assureFinished () const
 Assure that the algorithm has been run, throws a std::runtime_error otherwise. More...
 
virtual std::string toString () const
 Returns a string with the algorithm's name and its parameters, if there are any. More...
 
virtual bool isParallel () const
 

Protected Attributes

const GraphG
 
Matching M
 
bool edgeScoresAsWeights
 
const std::vector< double > edgeScores
 
- Protected Attributes inherited from NetworKit::Algorithm
bool hasRun
 A boolean variable indicating whether an algorithm has finished its computation or not. More...
 

Detailed Description

Abstract base class for matching algorithms.

Constructor & Destructor Documentation

NetworKit::Matcher::Matcher ( const Graph G)

Constructor.

Parameters
[in]GGraph for which matching is to be computed.
NetworKit::Matcher::Matcher ( const Graph G,
const std::vector< double > &  edgeScores 
)

Constructor.

Parameters
[in]GGraph for which matching is to be computed.
edgeScores(optional) to be used instead of weights
virtual NetworKit::Matcher::~Matcher ( )
virtualdefault

Default destructor.

Member Function Documentation

Matching NetworKit::Matcher::getMatching ( ) const
virtual void NetworKit::Matcher::run ( )
pure virtual

Run the matching algorithm on the stored graph and return a matching.

Returns
A matching of the stored graph.

Implements NetworKit::Algorithm.

Implemented in NetworKit::PathGrowingMatcher, and NetworKit::LocalMaxMatcher.

Member Data Documentation

const std::vector<double> NetworKit::Matcher::edgeScores
protected
bool NetworKit::Matcher::edgeScoresAsWeights
protected
const Graph& NetworKit::Matcher::G
protected
Matching NetworKit::Matcher::M
protected

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