ogdf::ClustererModule Class Reference

Interface for algorithms that compute a clustering for a given graph. More...

#include <ogdf/graphalg/ClustererModule.h>

Inheritance diagram for ogdf::ClustererModule:

Public Member Functions
	ClustererModule ()
	Default constructor, initializes a clustering module.
	ClustererModule (const Graph &G)
virtual double	averageCIndex ()
	compute the average clustering index for the given graph
virtual double	averageCIndex (const Graph &G)
virtual double	computeCIndex (const Graph &G, node v)=0
	compute a clustering index for each vertex
virtual double	computeCIndex (node v)=0
	compute a clustering index for each vertex
virtual void	computeClustering (SList< SimpleCluster * > &sl)=0
	compute some kind of clustering on the graph m_pGraph
virtual void	createClusterGraph (ClusterGraph &C)=0
	translate computed clustering into cluster hierarchy in cluster graph C
const Graph &	getGraph () const
	Returns the graph to be clustered.
void	setGraph (const Graph &G)
	Sets the graph to be clustered.

Protected Attributes
const Graph *	m_pGraph

Detailed Description

Interface for algorithms that compute a clustering for a given graph.

The class ClustererModule is the base class for clustering classes that allow to compute some hierarchical clustering

Definition at line 85 of file ClustererModule.h.

Constructor & Destructor Documentation

ClustererModule() [1/2]

ogdf::ClustererModule::ClustererModule ( const Graph &  G )

inlineexplicit

Definition at line 88 of file ClustererModule.h.

ClustererModule() [2/2]

ogdf::ClustererModule::ClustererModule ( )

inline

Default constructor, initializes a clustering module.

Definition at line 93 of file ClustererModule.h.

Member Function Documentation

averageCIndex() [1/2]

virtual double ogdf::ClustererModule::averageCIndex ( )

inlinevirtual

compute the average clustering index for the given graph

Definition at line 128 of file ClustererModule.h.

averageCIndex() [2/2]

virtual double ogdf::ClustererModule::averageCIndex ( const Graph &  G )

inlinevirtual

Definition at line 130 of file ClustererModule.h.

computeCIndex() [1/2]

virtual double ogdf::ClustererModule::computeCIndex ( const Graph &  G, node  v  )

pure virtual

compute a clustering index for each vertex

Implemented in ogdf::Clusterer.

computeCIndex() [2/2]

virtual double ogdf::ClustererModule::computeCIndex ( node  v )

pure virtual

compute a clustering index for each vertex

Implemented in ogdf::Clusterer.

computeClustering()

virtual void ogdf::ClustererModule::computeClustering ( SList< SimpleCluster * > &  sl )

pure virtual

compute some kind of clustering on the graph m_pGraph

This is the algorithm call that has to be implemented by derived classes

Parameters

sl	is the resulting list of clusters

Implemented in ogdf::Clusterer.

createClusterGraph()

virtual void ogdf::ClustererModule::createClusterGraph ( ClusterGraph &  C )

pure virtual

translate computed clustering into cluster hierarchy in cluster graph C

Implemented in ogdf::Clusterer.

getGraph()

const Graph & ogdf::ClustererModule::getGraph ( ) const

inline

Returns the graph to be clustered.

Definition at line 107 of file ClustererModule.h.

setGraph()

void ogdf::ClustererModule::setGraph ( const Graph &  G )

inline

Sets the graph to be clustered.

Parameters

G	is the input graph

Definition at line 101 of file ClustererModule.h.

Member Data Documentation

m_pGraph

const Graph* ogdf::ClustererModule::m_pGraph

protected

Definition at line 139 of file ClustererModule.h.

---

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

• include/ogdf/graphalg/ClustererModule.h