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

#include <Algorithm.h>

Public Member Functions

 Algorithm ()
 Constructor to the algorithm base class. More...
 
virtual ~Algorithm ()=default
 Virtual default destructor. More...
 
virtual void run ()=0
 The generic run method which calls runImpl() and takes care of setting to the appropriate value. 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

bool hasRun
 A boolean variable indicating whether an algorithm has finished its computation or not. More...
 

Constructor & Destructor Documentation

NetworKit::Algorithm::Algorithm ( )

Constructor to the algorithm base class.

virtual NetworKit::Algorithm::~Algorithm ( )
virtualdefault

Virtual default destructor.

Member Function Documentation

void NetworKit::Algorithm::assureFinished ( ) const
inline

Assure that the algorithm has been run, throws a std::runtime_error otherwise.

bool NetworKit::Algorithm::hasFinished ( ) const
inline

Indicates whether an algorithm has completed computation or not.

Returns
The Value of .
bool NetworKit::Algorithm::isParallel ( ) const
virtual
virtual void NetworKit::Algorithm::run ( )
pure virtual

The generic run method which calls runImpl() and takes care of setting to the appropriate value.

Implemented in NetworKit::LFRGenerator, NetworKit::MaximalCliques, NetworKit::PLP, NetworKit::LocalSimilarityScore, NetworKit::AlgebraicPageRank< Matrix >, NetworKit::PLM, NetworKit::Matcher, NetworKit::Assortativity, NetworKit::CoreDecomposition, NetworKit::DynApproxBetweenness, NetworKit::KPathCentrality, NetworKit::SpanningEdgeCentrality, NetworKit::DynBetweenness, NetworKit::ApproxBetweenness, NetworKit::ApproxCloseness, NetworKit::LocalClusteringCoefficient, NetworKit::CommuteTimeDistance, NetworKit::KatzCentrality, NetworKit::CommunityDetectionAlgorithm, NetworKit::ParallelConnectedComponents, NetworKit::EstimateBetweenness, NetworKit::Dijkstra, NetworKit::BFS, NetworKit::SSSP, NetworKit::PageRank, NetworKit::TopCloseness, NetworKit::PathGrowingMatcher, NetworKit::AlgebraicBellmanFord< Matrix >, NetworKit::HopPlotApproximation, NetworKit::RandomMaximumSpanningForest, NetworKit::LocalFilterScore< InType >, NetworKit::AlgebraicMatchingCoarsening< Matrix >, NetworKit::Centrality, NetworKit::LPDegreeOrdered, NetworKit::UnionMaximumSpanningForest, NetworKit::Closeness, NetworKit::DegreeCentrality, NetworKit::EigenvectorCentrality, NetworKit::NeighborhoodFunctionHeuristic, NetworKit::AlgebraicSpanningEdgeCentrality< Matrix >, NetworKit::Betweenness, NetworKit::DynConnectedComponents, NetworKit::EffectiveDiameterApproximation, NetworKit::NeighborhoodFunctionApproximation, NetworKit::AlgebraicBFS< Matrix >, NetworKit::MatchingCoarsening, NetworKit::ConnectedComponents, NetworKit::TriangleEdgeScore, NetworKit::APSP, NetworKit::WeaklyConnectedComponents, NetworKit::DynBFS, NetworKit::DynDijkstra, NetworKit::AlgebraicTriangleCounting< Matrix >, NetworKit::Sfigality, NetworKit::ParallelAgglomerativeClusterer, NetworKit::DynAPSP, NetworKit::NeighborhoodFunction, NetworKit::CutClustering, NetworKit::EpidemicSimulationSEIR, NetworKit::IsolatedInterpartitionConductance, NetworKit::IsolatedInterpartitionExpansion, NetworKit::EffectiveDiameter, NetworKit::LocalMaxMatcher, NetworKit::MultiscaleScore, NetworKit::RandomEdgeScore, NetworKit::GraphCoarsening, NetworKit::CoverHubDominance, NetworKit::Diameter, NetworKit::ChibaNishizekiTriangleEdgeScore, NetworKit::SimmelianOverlapScore, NetworKit::PartitionHubDominance, NetworKit::EdgeScore< T >, NetworKit::EdgeScore< double >, NetworKit::EdgeScore< count >, NetworKit::LocalPartitionCoverage, NetworKit::EdgeScoreLinearizer, NetworKit::ForestFireScore, NetworKit::ParallelPartitionCoarsening, NetworKit::EdgeScoreBlender, NetworKit::EdgeScoreNormalizer< A >, NetworKit::GeometricMeanScore, NetworKit::LocalDegreeScore, NetworKit::StablePartitionNodes, NetworKit::ChibaNishizekiQuadrangleEdgeScore, NetworKit::ChanceCorrectedTriangleScore, NetworKit::IntrapartitionDensity, NetworKit::PartitionFragmentation, NetworKit::RandomNodeEdgeScore, NetworKit::PrefixJaccardScore< AttributeT >, NetworKit::PermanenceCentrality, and NetworKit::SCANStructuralSimilarityScore.

std::string NetworKit::Algorithm::toString ( ) const
virtual

Member Data Documentation

bool NetworKit::Algorithm::hasRun
protected

A boolean variable indicating whether an algorithm has finished its computation or not.


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