org.graphstream.ui.layout.springbox
Class Energies

java.lang.Object
  extended by org.graphstream.ui.layout.springbox.Energies

public class Energies
extends Object

Represent the history of energy values for a layout algorithm.


Constructor Summary
Energies()
           
 
Method Summary
 void accumulateEnergy(double value)
          Accumulate some energy in the current energy.
 double getAverageEnergy()
          The average energy in the whole buffer.
 int getBufferSize()
          The number of energy values remembered.
 double getEnergy()
          The last computed energy value.
 double getPreviousEnergyValue(int stepsBack)
          A previous energy value.
 double getStabilization()
          A number in [0..1] with 1 meaning fully stabilised.
 void storeEnergy()
          Add a the current accumulated energy value in the set.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Energies

public Energies()
Method Detail

getEnergy

public double getEnergy()
The last computed energy value.

Returns:
The actual level of energy.

getBufferSize

public int getBufferSize()
The number of energy values remembered.


getStabilization

public double getStabilization()
A number in [0..1] with 1 meaning fully stabilised.

Returns:
A value that indicates the level of stabilisation in [0-1].

getAverageEnergy

public double getAverageEnergy()
The average energy in the whole buffer.

Returns:
The average energy.

getPreviousEnergyValue

public double getPreviousEnergyValue(int stepsBack)
A previous energy value.

Parameters:
stepsBack - The number of steps back in history.
Returns:
The energy value at stepsBack in time.

accumulateEnergy

public void accumulateEnergy(double value)
Accumulate some energy in the current energy.

Parameters:
value - The value to accumulate.

storeEnergy

public void storeEnergy()
Add a the current accumulated energy value in the set.



Copyright © 2011. All Rights Reserved.