SSJ
V. 1.2.5.

umontreal.iro.lecuyer.simevents
Class Accumulate

java.lang.Object
  extended by java.util.Observable
      extended by umontreal.iro.lecuyer.stat.StatProbe
          extended by umontreal.iro.lecuyer.simevents.Accumulate
All Implemented Interfaces:
Cloneable

public class Accumulate
extends StatProbe
implements Cloneable

A subclass of StatProbe, for collecting statistics on a variable that evolves in simulation time, with a piecewise-constant trajectory. Each time the variable changes its value, the method update must be called to inform the probe of the new value. The probe can be reinitialized by init.


Constructor Summary
Accumulate()
          Constructs a new Accumulate statistical probe and initializes it by invoking init().
Accumulate(String name)
          Construct and initializes a new Accumulate statistical probe with name name and initial time 0.
 
Method Summary
 double average()
          Returns the time-average since the last initialization to the last call to update.
 Object clone()
          Clone this object.
 double getInitTime()
          Returns the initialization time for this object.
 double getLastTime()
          Returns the last update time for this object.
 double getLastValue()
          Returns the value passed to this probe by the last call to its update method (or the initial value if update was never called after init).
 void init()
          Initializes the statistical collector and puts the current value of the corresponding variable to 0.
 void init(double x)
          Same as init followed by update(x).
 String report()
          Returns a string containing a report for this statistical collector.
 double sum()
          Returns the sum cumulated so far for this probe.
 void update()
          Updates the accumulator using the last value passed to update.
 void update(double x)
          Gives a new observation x to the statistical collector.
 
Methods inherited from class umontreal.iro.lecuyer.stat.StatProbe
getName, max, min, setBroadcasting, setCollecting, setName
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Accumulate

public Accumulate()
Constructs a new Accumulate statistical probe and initializes it by invoking init().


Accumulate

public Accumulate(String name)
Construct and initializes a new Accumulate statistical probe with name name and initial time 0.

Parameters:
name - descriptive name for the probe
Method Detail

init

public void init()
Initializes the statistical collector and puts the current value of the corresponding variable to 0. A call to init should normally be followed immediately by a call to update to give the value of the variable at the initialization time.

Specified by:
init in class StatProbe

init

public void init(double x)
Same as init followed by update(x).

Parameters:
x - initial value of the probe

update

public void update()
Updates the accumulator using the last value passed to update.


update

public void update(double x)
Gives a new observation x to the statistical collector. If broadcasting to observers is activated for this object, this method will also transmit the new information to the registered observers by invoking the methods setChanged and notifyObservers (new Double (x)) inherited from Observable.

Parameters:
x - new observation given to the probe

sum

public double sum()
Description copied from class: StatProbe
Returns the sum cumulated so far for this probe. The meaning of this sum depends on the subclass (e.g., Tally or Accumulate).

Overrides:
sum in class StatProbe
Returns:
the sum for this probe

average

public double average()
Returns the time-average since the last initialization to the last call to update.

Specified by:
average in class StatProbe
Returns:
the average value of the collected observations

report

public String report()
Description copied from class: StatProbe
Returns a string containing a report for this statistical collector.

Specified by:
report in class StatProbe
Returns:
a report for this probe, represented as a string

getInitTime

public double getInitTime()
Returns the initialization time for this object. This is the simulation time when init was called for the last time.

Returns:
the initialization time for this object

getLastTime

public double getLastTime()
Returns the last update time for this object. This is the simulation time of the last call to update or the initialization time if update was never called after init.

Returns:
the last update time of this object

getLastValue

public double getLastValue()
Returns the value passed to this probe by the last call to its update method (or the initial value if update was never called after init).

Returns:
the last update value for this object

clone

public Object clone()
Clone this object.

Overrides:
clone in class StatProbe

SSJ
V. 1.2.5.

To submit a bug or ask questions, send an e-mail to Pierre L'Ecuyer.