Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
boost::bc_clustering_threshold< T > Struct Template Reference

Threshold termination function for the betweenness centrality clustering algorithm. More...

#include <bc_clustering.hpp>

Collaboration diagram for boost::bc_clustering_threshold< T >:
Collaboration graph
[legend]

Public Types

typedef T centrality_type
 

Public Member Functions

 bc_clustering_threshold (T threshold)
 Terminate clustering when maximum absolute edge centrality is below the given threshold. More...
 
template<typename Graph >
 bc_clustering_threshold (T threshold, const Graph &g, bool normalize=true)
 Terminate clustering when the maximum edge centrality is below the given threshold. More...
 
template<typename Graph , typename Edge >
bool operator() (T max_centrality, Edge, const Graph &)
 Returns true when the given maximum edge centrality (potentially normalized) falls below the threshold. More...
 

Protected Attributes

T threshold
 
T dividend
 

Detailed Description

template<typename T>
struct boost::bc_clustering_threshold< T >

Threshold termination function for the betweenness centrality clustering algorithm.

Member Typedef Documentation

template<typename T >
typedef T boost::bc_clustering_threshold< T >::centrality_type

Constructor & Destructor Documentation

template<typename T >
boost::bc_clustering_threshold< T >::bc_clustering_threshold ( T  threshold)
inlineexplicit

Terminate clustering when maximum absolute edge centrality is below the given threshold.

template<typename T >
template<typename Graph >
boost::bc_clustering_threshold< T >::bc_clustering_threshold ( T  threshold,
const Graph &  g,
bool  normalize = true 
)
inline

Terminate clustering when the maximum edge centrality is below the given threshold.

Parameters
thresholdthe threshold value
gthe graph on which the threshold will be calculated
normalizewhen true, the threshold is compared against the normalized edge centrality based on the input graph; otherwise, the threshold is compared against the absolute edge centrality.

References boost::bc_clustering_threshold< T >::dividend, boost::n, boost::locale::normalize(), boost::num_vertices(), and T.

Member Function Documentation

template<typename T >
template<typename Graph , typename Edge >
bool boost::bc_clustering_threshold< T >::operator() ( T  max_centrality,
Edge  ,
const Graph &   
)
inline

Returns true when the given maximum edge centrality (potentially normalized) falls below the threshold.

References boost::bc_clustering_threshold< T >::dividend, and boost::bc_clustering_threshold< T >::threshold.

Member Data Documentation

template<typename T >
T boost::bc_clustering_threshold< T >::dividend
protected

Referenced by boost::bc_clustering_threshold< T >::bc_clustering_threshold(), and boost::bc_clustering_threshold< T >::operator()().

template<typename T >
T boost::bc_clustering_threshold< T >::threshold
protected

Referenced by boost::bc_clustering_threshold< T >::operator()().

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