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

Node centrality index which ranks nodes by their degree. More...

#include <DegreeCentrality.h>

Public Member Functions

 DegreeCentrality (const Graph &G, bool normalized=false, bool outDeg=true, bool ignoreSelfLoops=true)
 Constructs the DegreeCentrality class for the given Graph G. More...
void run () override
 Computes degree centraity on the graph passed in constructor. More...
double maximum () override
- 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...

Detailed Description

Node centrality index which ranks nodes by their degree.

Optional normalization by maximum degree.

Constructor & Destructor Documentation

NetworKit::DegreeCentrality::DegreeCentrality ( const Graph G,
bool  normalized = false,
bool  outDeg = true,
bool  ignoreSelfLoops = true 

Constructs the DegreeCentrality class for the given Graph G.

If the centrality scores should be normalized, then set normalized to true. The run() method runs in O(m) time, where m is the number of edges in the graph.

GThe graph.
normalizedSet this parameter to true if scores should be normalized in the interval [0,1].
outDegIf set to true, computes the centrality based on the out-degrees, otherwise based on the in-degrees.
ignoreSelfLoopsIf set to true, self loops will not be taken into account.

Member Function Documentation

double NetworKit::DegreeCentrality::maximum ( )
the theoretical maximum degree centrality, which is $n$ (including the possibility of a self-loop)

Reimplemented from NetworKit::Centrality.

void NetworKit::DegreeCentrality::run ( )

Computes degree centraity on the graph passed in constructor.

Implements NetworKit::Centrality.

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