All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
NetworKit::Closeness Class Reference

#include <Closeness.h>

Public Member Functions

 Closeness (const Graph &G, bool normalized=true, bool checkConnectedness=true)
 Constructs the Closeness class for the given Graph G. More...
void run () override
 Computes closeness cetrality on the graph passed in constructor. More...
double maximum () override
 Get the theoretical maximum of centrality score in the given graph. More...
- Public Member Functions inherited from NetworKit::Centrality
 Centrality (const Graph &G, bool normalized=false, bool computeEdgeCentrality=false)
 Constructs the Centrality class for the given Graph G. More...
virtual ~Centrality ()=default
 Default destructor. More...
virtual std::vector< double > scores (bool moveOut=false)
 Get a vector containing the centrality score for each node in the graph. More...
virtual std::vector< double > edgeScores ()
 Get a vector containing the edge centrality score for each edge in the graph (where applicable). More...
virtual std::vector< std::pair
< node, double > > 
ranking ()
 Get a vector of pairs sorted into descending order. More...
virtual double score (node v)
 Get the centrality score of node v calculated by run(). More...
virtual double centralization ()
 Compute the centralization of a network with respect to some centrality measure. More...
- 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

Additional Inherited Members

- Protected Attributes inherited from NetworKit::Centrality
const GraphG
std::vector< double > scoreData
std::vector< double > edgeScoreData
bool normalized
bool computeEdgeCentrality
- Protected Attributes inherited from NetworKit::Algorithm
bool hasRun
 A boolean variable indicating whether an algorithm has finished its computation or not. More...

Constructor & Destructor Documentation

NetworKit::Closeness::Closeness ( const Graph G,
bool  normalized = true,
bool  checkConnectedness = true 

Constructs the Closeness class for the given Graph G.

If the closeness scores should be normalized, then set normalized to true. The run() method takes O(nm) time, where n is the number of nodes and m is the number of edges of the graph. NOTICE: the graph has to be connected.

GThe graph.
normalizedSet this parameter to false if scores should not be normalized into an interval of [0, 1]. Normalization only for unweighted graphs.
checkConnectednessturn this off if you know the graph is connected

Member Function Documentation

double NetworKit::Closeness::maximum ( )

Get the theoretical maximum of centrality score in the given graph.

The maximum centrality score.

Reimplemented from NetworKit::Centrality.

void NetworKit::Closeness::run ( )

Computes closeness cetrality on the graph passed in constructor.

Implements NetworKit::Centrality.

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