org.eth.cyril.graphdrawing.graph.algorithms.cycles

Class KeepHierarchyConstraint

java.lang.Object

org.eth.cyril.graphdrawing.graph.algorithms.cycles.KeepHierarchyConstraint

All Implemented Interfaces:

EdgeWeightConstraint, ConcreteConstraint, JsonSerializable

public class KeepHierarchyConstraint
extends java.lang.Object
implements EdgeWeightConstraint, JsonSerializable

A constraint which aims to keep the hierarchy intact. If an edge from a to b is given and a was previously in a higher level than b, then a weight is added to the edge to make it less likely for the edge to be broken and therefore the relationship between a and b in the graph being inverted.

Constructor Summary

Constructors

Constructor and Description
KeepHierarchyConstraint(double modifier)

Method Summary

Modifier and Type	Method and Description
double	weight(Edge edge) Assign a weight to the given edge.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eth.cyril.util.serialization.JsonSerializable

fromJson, toJson

Constructor Detail

KeepHierarchyConstraint

public KeepHierarchyConstraint(double modifier)

Method Detail

weight

public double weight(Edge edge)

Description copied from interface: EdgeWeightConstraint

Assign a weight to the given edge. The weights assigned to an edge by all edge weight constraints are summed up. An edge with a higher weight is less likely to be inverted during the cycle removal phase at the beginning of the ConstrainedSugiyamaLayoutAlgorithm algorithm.

Specified by:

weight in interface EdgeWeightConstraint

Parameters:

edge - The edge to assign a weight to.

Returns:

The weight to assign to the edge. If no weight should be assigned, return 0.0.