Open
Graph Drawing
Framework

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

Public Member Functions | Protected Attributes | List of all members
ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase > Class Template Reference

Base class for ogdf::SpringEmbedderGridVariant::Master. More...

#include <ogdf/energybased/spring_embedder/MasterBase.h>

Public Member Functions

 MasterBase (const SpringEmbedderBase &spring, const GraphCopy &gc, GraphAttributes &ga, DPoint &boundingBox)
 
 ~MasterBase ()
 
Array< int > & adjLists ()
 
double avgDisplacement () const
 
void coolDown ()
 
double coolingFactor () const
 
Array< DPoint > & disp ()
 
const ForceModelBase & forceModel () const
 
const ForceModelBase & forceModelImprove () const
 
GraphAttributes & getAttributes ()
 
const GraphCopy & getGraph () const
 
bool hasConverged () const
 
double idealEdgeLength () const
 
const NodeArray< int > & index () const
 
void initImprovementPhase ()
 
void initUnfoldPhase ()
 
double maxDisplacement () const
 
double maxForceLength () const
 
bool noise () const
 
int numberOfIterations () const
 
int numberOfIterationsImprove () const
 
int numberOfNodes () const
 
double scaleFactor () const
 
void syncThreads ()
 
Array< NodeInfo > & vInfo ()
 

Protected Attributes

Array< int > m_adjLists
 
double m_avgDisplacement
 
Barrier * m_barrier
 
DPoint & m_boundingBox
 
double m_cF
 
double m_coolingFactor
 
Array< DPoint > m_disp
 
ForceModelBase * m_forceModel
 
ForceModelBase * m_forceModelImprove
 
GraphAttributes & m_ga
 
const GraphCopy & m_gc
 
double m_idealEdgeLength
 
NodeArray< int > m_index
 
double m_maxDisplacement
 
double m_scaleFactor
 
const SpringEmbedderBase & m_spring
 
double m_t
 
double m_tNull
 
Array< NodeInfo > m_vInfo
 

Detailed Description

template<typename NodeInfo, typename ForceModelBase>
class ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >

Base class for ogdf::SpringEmbedderGridVariant::Master.

Definition at line 51 of file MasterBase.h.

Constructor & Destructor Documentation

◆ MasterBase()

template<typename NodeInfo , typename ForceModelBase >
ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::MasterBase ( const SpringEmbedderBase &  spring,
const GraphCopy &  gc,
GraphAttributes &  ga,
DPoint &  boundingBox 
)
inline

Definition at line 80 of file MasterBase.h.

◆ ~MasterBase()

template<typename NodeInfo , typename ForceModelBase >
ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::~MasterBase ( )
inline

Definition at line 96 of file MasterBase.h.

Member Function Documentation

◆ adjLists()

template<typename NodeInfo , typename ForceModelBase >
Array<int>& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::adjLists ( )
inline

Definition at line 155 of file MasterBase.h.

◆ avgDisplacement()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::avgDisplacement ( ) const
inline

Definition at line 174 of file MasterBase.h.

◆ coolDown()

template<typename NodeInfo , typename ForceModelBase >
void ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::coolDown ( )
inline

Definition at line 130 of file MasterBase.h.

◆ coolingFactor()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::coolingFactor ( ) const
inline

Definition at line 139 of file MasterBase.h.

◆ disp()

template<typename NodeInfo , typename ForceModelBase >
Array<DPoint>& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::disp ( )
inline

Definition at line 153 of file MasterBase.h.

◆ forceModel()

template<typename NodeInfo , typename ForceModelBase >
const ForceModelBase& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::forceModel ( ) const
inline

Definition at line 157 of file MasterBase.h.

◆ forceModelImprove()

template<typename NodeInfo , typename ForceModelBase >
const ForceModelBase& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::forceModelImprove ( ) const
inline

Definition at line 159 of file MasterBase.h.

◆ getAttributes()

template<typename NodeInfo , typename ForceModelBase >
GraphAttributes& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::getAttributes ( )
inline

Definition at line 147 of file MasterBase.h.

◆ getGraph()

template<typename NodeInfo , typename ForceModelBase >
const GraphCopy& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::getGraph ( ) const
inline

Definition at line 145 of file MasterBase.h.

◆ hasConverged()

template<typename NodeInfo , typename ForceModelBase >
bool ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::hasConverged ( ) const
inline

Definition at line 169 of file MasterBase.h.

◆ idealEdgeLength()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::idealEdgeLength ( ) const
inline

Definition at line 141 of file MasterBase.h.

◆ index()

template<typename NodeInfo , typename ForceModelBase >
const NodeArray<int>& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::index ( ) const
inline

Definition at line 149 of file MasterBase.h.

◆ initImprovementPhase()

template<typename NodeInfo , typename ForceModelBase >
void ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::initImprovementPhase ( )
inline

Definition at line 119 of file MasterBase.h.

◆ initUnfoldPhase()

template<typename NodeInfo , typename ForceModelBase >
void ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::initUnfoldPhase ( )
inline

Definition at line 108 of file MasterBase.h.

◆ maxDisplacement()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::maxDisplacement ( ) const
inline

Definition at line 176 of file MasterBase.h.

◆ maxForceLength()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::maxForceLength ( ) const
inline

Definition at line 137 of file MasterBase.h.

◆ noise()

template<typename NodeInfo , typename ForceModelBase >
bool ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::noise ( ) const
inline

Definition at line 143 of file MasterBase.h.

◆ numberOfIterations()

template<typename NodeInfo , typename ForceModelBase >
int ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::numberOfIterations ( ) const
inline

Definition at line 104 of file MasterBase.h.

◆ numberOfIterationsImprove()

template<typename NodeInfo , typename ForceModelBase >
int ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::numberOfIterationsImprove ( ) const
inline

Definition at line 106 of file MasterBase.h.

◆ numberOfNodes()

template<typename NodeInfo , typename ForceModelBase >
int ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::numberOfNodes ( ) const
inline

Definition at line 102 of file MasterBase.h.

◆ scaleFactor()

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::scaleFactor ( ) const
inline

Definition at line 167 of file MasterBase.h.

◆ syncThreads()

template<typename NodeInfo , typename ForceModelBase >
void ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::syncThreads ( )
inline

Definition at line 161 of file MasterBase.h.

◆ vInfo()

template<typename NodeInfo , typename ForceModelBase >
Array<NodeInfo>& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::vInfo ( )
inline

Definition at line 151 of file MasterBase.h.

Member Data Documentation

◆ m_adjLists

template<typename NodeInfo , typename ForceModelBase >
Array<int> ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_adjLists
protected

Definition at line 61 of file MasterBase.h.

◆ m_avgDisplacement

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_avgDisplacement
protected

Definition at line 75 of file MasterBase.h.

◆ m_barrier

template<typename NodeInfo , typename ForceModelBase >
Barrier* ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_barrier
protected

Definition at line 66 of file MasterBase.h.

◆ m_boundingBox

template<typename NodeInfo , typename ForceModelBase >
DPoint& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_boundingBox
protected

Definition at line 56 of file MasterBase.h.

◆ m_cF

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_cF
protected

Definition at line 71 of file MasterBase.h.

◆ m_coolingFactor

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_coolingFactor
protected

Definition at line 73 of file MasterBase.h.

◆ m_disp

template<typename NodeInfo , typename ForceModelBase >
Array<DPoint> ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_disp
protected

Definition at line 60 of file MasterBase.h.

◆ m_forceModel

template<typename NodeInfo , typename ForceModelBase >
ForceModelBase* ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_forceModel
protected

Definition at line 63 of file MasterBase.h.

◆ m_forceModelImprove

template<typename NodeInfo , typename ForceModelBase >
ForceModelBase* ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_forceModelImprove
protected

Definition at line 64 of file MasterBase.h.

◆ m_ga

template<typename NodeInfo , typename ForceModelBase >
GraphAttributes& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_ga
protected

Definition at line 55 of file MasterBase.h.

◆ m_gc

template<typename NodeInfo , typename ForceModelBase >
const GraphCopy& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_gc
protected

Definition at line 54 of file MasterBase.h.

◆ m_idealEdgeLength

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_idealEdgeLength
protected

Definition at line 68 of file MasterBase.h.

◆ m_index

template<typename NodeInfo , typename ForceModelBase >
NodeArray<int> ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_index
protected

Definition at line 58 of file MasterBase.h.

◆ m_maxDisplacement

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_maxDisplacement
protected

Definition at line 76 of file MasterBase.h.

◆ m_scaleFactor

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_scaleFactor
protected

Definition at line 77 of file MasterBase.h.

◆ m_spring

template<typename NodeInfo , typename ForceModelBase >
const SpringEmbedderBase& ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_spring
protected

Definition at line 53 of file MasterBase.h.

◆ m_t

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_t
protected

Definition at line 72 of file MasterBase.h.

◆ m_tNull

template<typename NodeInfo , typename ForceModelBase >
double ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_tNull
protected

Definition at line 70 of file MasterBase.h.

◆ m_vInfo

template<typename NodeInfo , typename ForceModelBase >
Array<NodeInfo> ogdf::spring_embedder::MasterBase< NodeInfo, ForceModelBase >::m_vInfo
protected

Definition at line 59 of file MasterBase.h.

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