Open
Graph Drawing
Framework

  v. 2023.09 (Elderberry)
 
Overview Class Hierarchy Class Index Class List Members Namespaces Source Files

Public Member Functions | Public Attributes | Friends | List of all members
ogdf::RandomClusterConfig Struct Reference
Graphs and Embeddings » Graph Generators

Parameters for the randomPlanarClustering() method. More...

#include <ogdf/basic/graph_generators/clustering.h>

Public Member Functions

double expected_nodes () const
 Get the expected number of nodes per cluster, i.e., 1.0 / prob_no_further_node. More...
 
void expected_nodes (double n)
 Set the expected number of nodes per cluster, i.e., prob_no_further_node = 1.0 / n. More...
 

Public Attributes

bool cconnected = false
 Whether the resulting clustering must be c-connected. More...
 
int max_clusters = 0
 The hard limit of clusters to create. More...
 
int max_nodes_in_cluster = 0
 The hard limit of nodes that can be direct children of a single cluster. More...
 
int min_root_nodes = 0
 The hard minimum of nodes that must remain directly within the root cluster. More...
 
double prob_no_further_cluster = 0.0
 The probability of not creating a further cluster. More...
 
double prob_no_further_node = 0.1
 The probability of not adding another node to the current cluster. More...
 
int timeout = 0
 Timeout for the generation in seconds. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const RandomClusterConfig &config)
 

Detailed Description

Parameters for the randomPlanarClustering() method.

Definition at line 89 of file clustering.h.

Member Function Documentation

◆ expected_nodes() [1/2]

double ogdf::RandomClusterConfig::expected_nodes ( ) const
inline

Get the expected number of nodes per cluster, i.e., 1.0 / prob_no_further_node.

Definition at line 106 of file clustering.h.

◆ expected_nodes() [2/2]

void ogdf::RandomClusterConfig::expected_nodes ( double  n)
inline

Set the expected number of nodes per cluster, i.e., prob_no_further_node = 1.0 / n.

Definition at line 109 of file clustering.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const RandomClusterConfig &  config 
)
friend

Member Data Documentation

◆ cconnected

bool ogdf::RandomClusterConfig::cconnected = false

Whether the resulting clustering must be c-connected.

Definition at line 101 of file clustering.h.

◆ max_clusters

int ogdf::RandomClusterConfig::max_clusters = 0

The hard limit of clusters to create.

Definition at line 97 of file clustering.h.

◆ max_nodes_in_cluster

int ogdf::RandomClusterConfig::max_nodes_in_cluster = 0

The hard limit of nodes that can be direct children of a single cluster.

Definition at line 91 of file clustering.h.

◆ min_root_nodes

int ogdf::RandomClusterConfig::min_root_nodes = 0

The hard minimum of nodes that must remain directly within the root cluster.

Definition at line 99 of file clustering.h.

◆ prob_no_further_cluster

double ogdf::RandomClusterConfig::prob_no_further_cluster = 0.0

The probability of not creating a further cluster.

Definition at line 95 of file clustering.h.

◆ prob_no_further_node

double ogdf::RandomClusterConfig::prob_no_further_node = 0.1

The probability of not adding another node to the current cluster.

Definition at line 93 of file clustering.h.

◆ timeout

int ogdf::RandomClusterConfig::timeout = 0

Timeout for the generation in seconds.

Definition at line 103 of file clustering.h.

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