Package org.jungrapht.visualization.layout.algorithms

Class ISOMLayoutAlgorithm<V>

java.lang.Object

org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm<V>

org.jungrapht.visualization.layout.algorithms.ISOMLayoutAlgorithm<V>

All Implemented Interfaces:

IterativeLayoutAlgorithm<V>, LayoutAlgorithm<V>, AfterRunnable, ExecutorConsumer, IterativeContext, Threaded

public class ISOMLayoutAlgorithm<V>
extends AbstractIterativeLayoutAlgorithm<V>
implements IterativeContext

Implements a self-organizing map layout algorithm, based on Meyer's self-organizing graph methods.

Author:

Yan Biao Boey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ISOMLayoutAlgorithm.Builder<V,T extends ISOMLayoutAlgorithm<V>,B extends ISOMLayoutAlgorithm.Builder<V,T,B>>

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

LayoutAlgorithm.NoOp<V>

Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.util.Threaded

Threaded.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
protected double	adaption
protected double	coolingFactor
protected int	epoch
protected double	initialAdaption
protected int	maxEpoch
protected double	minAdaption
protected int	minRadius
protected List<V>	queue
protected int	radius
protected int	radiusConstantTime
protected String	status

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm

afterRunnable, cancelled, executor, layoutModel, preRelaxDurationMs, random, shouldPreRelax, threaded

Fields inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

after

Constructor Summary

Constructors

Modifier	Constructor	Description
	ISOMLayoutAlgorithm()
protected	ISOMLayoutAlgorithm(ISOMLayoutAlgorithm.Builder<V,?,?> builder)

Method Summary

Modifier and Type	Method	Description
static <V> ISOMLayoutAlgorithm.Builder<V,?,?>	builder()
boolean	done()	Returns true if the vertex positions are no longer being updated.
String	getStatus()
void	initialize()
void	reset()	Resets the layout iteration count to 0, which allows the layout algorithm to continue updating vertex positions.
void	step()	Advances the current positions of the graph elements.
void	visit(LayoutModel<V> layoutModel)	because the IterativeLayoutAlgorithms use multithreading to continuously update vertex positions, the layoutModel state is saved (during the visit method) so that it can be used continuously

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractIterativeLayoutAlgorithm

cancel, getExecutor, isThreaded, preRelax, setExecutor, setRandomSeed, setThreaded

Methods inherited from class org.jungrapht.visualization.layout.algorithms.AbstractLayoutAlgorithm

computeAverageVertexDimension, computeLayoutExtent, expandToFill, runAfter, setAfter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.AfterRunnable

runAfter, setAfter

Methods inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm

constrained

Field Detail

maxEpoch

protected int maxEpoch

epoch

protected int epoch

radiusConstantTime

protected int radiusConstantTime

radius

protected int radius

minRadius

protected int minRadius

adaption

protected double adaption

initialAdaption

protected double initialAdaption

minAdaption

protected double minAdaption

coolingFactor

protected double coolingFactor

queue

protected List<V> queue

status

protected String status

Constructor Detail

ISOMLayoutAlgorithm

public ISOMLayoutAlgorithm()

ISOMLayoutAlgorithm

protected ISOMLayoutAlgorithm(ISOMLayoutAlgorithm.Builder<V,?,?> builder)

Method Detail

builder

public static <V> ISOMLayoutAlgorithm.Builder<V,?,?> builder()

getStatus

public String getStatus()

Returns:

the current number of epochs and execution status, as a string.

visit

public void visit(LayoutModel<V> layoutModel)

Description copied from class: AbstractIterativeLayoutAlgorithm

because the IterativeLayoutAlgorithms use multithreading to continuously update vertex positions, the layoutModel state is saved (during the visit method) so that it can be used continuously

Specified by:

visit in interface LayoutAlgorithm<V>

Overrides:

visit in class AbstractIterativeLayoutAlgorithm<V>

Parameters:

layoutModel - the mediator between the container for vertices (the Graph) and the mapping from Vertex to Point

initialize

public void initialize()

step

public void step()

Advances the current positions of the graph elements.

Specified by:

step in interface IterativeContext

done

public boolean done()

Returns true if the vertex positions are no longer being updated. Currently ISOMLayout stops updating vertex positions after a certain number of iterations have taken place.

Specified by:

done in interface IterativeContext

Returns:

true if the vertex position updates have stopped, false otherwise

reset

public void reset()

Resets the layout iteration count to 0, which allows the layout algorithm to continue updating vertex positions.