Open
Graph Drawing
Framework

 v.2012.05
 

ogdf::SpringEmbedderFRExact Class Reference

#include <ogdf/energybased/SpringEmbedderFRExact.h>

Inheritance diagram for ogdf::SpringEmbedderFRExact:
ogdf::ForceLayoutModule ogdf::LayoutModule

List of all members.

Classes

class  ArrayGraph

Public Types

enum  CoolingFunction { cfFactor, cfLogarithmic }

Public Member Functions

 SpringEmbedderFRExact ()
 Creates an instance of Fruchterman/Reingold (exact) layout.
 ~SpringEmbedderFRExact ()
void call (GraphAttributes &GA)
 Calls the layout algorithm for graph attributes GA.
int iterations () const
 Returns the current setting of iterations.
void iterations (int i)
 Sets the number of iterations to i.
bool noise () const
 Returns the current setting of nodes.
void noise (bool on)
 Sets the parameter noise to on.
void nodeWeights (bool on)
 Switches use of node weights given in GraphAttributtes.
CoolingFunction coolingFunction () const
 Returns the current setting for the cooling function.
void coolingFunction (CoolingFunction f)
 Sets the parameter coolingFunction to f.
double idealEdgeLength () const
 Returns the ideal edge length.
void idealEdgeLength (double len)
 Sets the ideal edge length to len.
double minDistCC () const
 Returns the minimum distance between connected components.
void minDistCC (double x)
 Sets the minimum distance between connected components to x.
double pageRatio ()
 Returns the page ratio.
void pageRatio (double x)
 Sets the page ration to x.
void checkConvergence (bool b)
bool checkConvergence ()
void convTolerance (double tol)

Private Member Functions

double log2 (double x)
double mylog2 (int x)
void initialize (ArrayGraph &component)
void mainStep (ArrayGraph &component)
void mainStep_sse3 (ArrayGraph &component)
void cool (double &tx, double &ty, int &cF)

Private Attributes

int m_iterations
 The number of iterations.
bool m_noise
 Perform random perturbations?
CoolingFunction m_coolingFunction
 The selected cooling function.
double m_coolFactor_x
double m_coolFactor_y
double m_idealEdgeLength
 The ideal edge length.
double m_minDistCC
 The minimal distance between connected components.
double m_pageRatio
 The page ratio.
double m_txNull
double m_tyNull
bool m_useNodeWeight
bool m_checkConvergence
double m_convTolerance

Detailed Description

Definition at line 61 of file SpringEmbedderFRExact.h.


Member Enumeration Documentation

Enumerator:
cfFactor 
cfLogarithmic 

Definition at line 64 of file SpringEmbedderFRExact.h.


Constructor & Destructor Documentation

Creates an instance of Fruchterman/Reingold (exact) layout.


Member Function Documentation

Calls the layout algorithm for graph attributes GA.

Implements ogdf::ForceLayoutModule.

Definition at line 130 of file SpringEmbedderFRExact.h.

Definition at line 131 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::convTolerance ( double  tol) [inline]

Definition at line 132 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::cool ( double &  tx,
double &  ty,
int &  cF 
) [private]

Returns the current setting for the cooling function.

Definition at line 103 of file SpringEmbedderFRExact.h.

Sets the parameter coolingFunction to f.

Definition at line 108 of file SpringEmbedderFRExact.h.

Returns the ideal edge length.

Definition at line 113 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::idealEdgeLength ( double  len) [inline]

Sets the ideal edge length to len.

Definition at line 116 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::initialize ( ArrayGraph component) [private]

Returns the current setting of iterations.

Definition at line 78 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::iterations ( int  i) [inline]

Sets the number of iterations to i.

Definition at line 83 of file SpringEmbedderFRExact.h.

double ogdf::SpringEmbedderFRExact::log2 ( double  x) [inline, private]

Definition at line 168 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::mainStep ( ArrayGraph component) [private]
void ogdf::SpringEmbedderFRExact::mainStep_sse3 ( ArrayGraph component) [private]
double ogdf::SpringEmbedderFRExact::minDistCC ( ) const [inline]

Returns the minimum distance between connected components.

Definition at line 119 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::minDistCC ( double  x) [inline]

Sets the minimum distance between connected components to x.

Definition at line 122 of file SpringEmbedderFRExact.h.

double ogdf::SpringEmbedderFRExact::mylog2 ( int  x) [inline, private]

Definition at line 169 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::nodeWeights ( bool  on) [inline]

Switches use of node weights given in GraphAttributtes.

Definition at line 99 of file SpringEmbedderFRExact.h.

bool ogdf::SpringEmbedderFRExact::noise ( ) const [inline]

Returns the current setting of nodes.

Definition at line 89 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::noise ( bool  on) [inline]

Sets the parameter noise to on.

Definition at line 94 of file SpringEmbedderFRExact.h.

Returns the page ratio.

Definition at line 125 of file SpringEmbedderFRExact.h.

void ogdf::SpringEmbedderFRExact::pageRatio ( double  x) [inline]

Sets the page ration to x.

Definition at line 128 of file SpringEmbedderFRExact.h.


Member Data Documentation

Definition at line 214 of file SpringEmbedderFRExact.h.

Definition at line 201 of file SpringEmbedderFRExact.h.

Definition at line 202 of file SpringEmbedderFRExact.h.

The selected cooling function.

Definition at line 195 of file SpringEmbedderFRExact.h.

The ideal edge length.

Definition at line 204 of file SpringEmbedderFRExact.h.

The number of iterations.

Definition at line 193 of file SpringEmbedderFRExact.h.

The minimal distance between connected components.

Definition at line 205 of file SpringEmbedderFRExact.h.

Perform random perturbations?

Definition at line 194 of file SpringEmbedderFRExact.h.

The page ratio.

Definition at line 206 of file SpringEmbedderFRExact.h.

Definition at line 209 of file SpringEmbedderFRExact.h.

Definition at line 210 of file SpringEmbedderFRExact.h.

Definition at line 212 of file SpringEmbedderFRExact.h.


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