IterativeLayoutAlgorithm (JunGrapht Visualization 1.1 API)

Type Parameters:

V - the Vertex type

All Superinterfaces:

AfterRunnable, ExecutorConsumer, IterativeContext, LayoutAlgorithm<V>

All Known Implementing Classes:

AbstractIterativeLayoutAlgorithm, AnimationLayoutAlgorithm, DAGLayoutAlgorithm, ForceAtlas2LayoutAlgorithm, FRLayoutAlgorithm, GEMLayoutAlgorithm, ISOMLayoutAlgorithm, KKLayoutAlgorithm, SpringLayoutAlgorithm
```
public interface IterativeLayoutAlgorithm<V>
extends LayoutAlgorithm<V>, IterativeContext, ExecutorConsumer
```
A LayoutAlgorithm that may utilize a pre-relax phase, which is a loop of calls to step that occurr in the current thread instead of in a new Thread. The purpose of preRelax() is to rapidly reach an initial state before spawning a new Thread to perform a more lengthy relax operation.

- Nested Class Summary
  - Nested classes/interfaces inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm
    LayoutAlgorithm.Builder<V,T extends LayoutAlgorithm<V>,B extends LayoutAlgorithm.Builder<V,T,B>>, LayoutAlgorithm.NoOp<V>
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  boolean preRelax()
  may be a no-op depending on how the algorithm instance is created
  - Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.AfterRunnable
    runAfter, setAfter
  - Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.ExecutorConsumer
    getExecutor, setExecutor
  - Methods inherited from interface org.jungrapht.visualization.layout.algorithms.util.IterativeContext
    done, step
  - Methods inherited from interface org.jungrapht.visualization.layout.algorithms.LayoutAlgorithm
    cancel, constrained, visit

- Method Detail
  - preRelax
```
boolean preRelax()
```
    may be a no-op depending on how the algorithm instance is created
    
    Returns:
    
    true if a prerelax was done, false otherwise