|
SSJ V. 2.6.2. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object umontreal.iro.lecuyer.stat.StatProbe umontreal.iro.lecuyer.simevents.Accumulate
public class Accumulate
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 using the default simulator and initializes it by invoking init(). |
|
Accumulate(Simulator inSim)
Constructs a new Accumulate statistical probe linked to the given simulator, and initializes it by invoking init(). |
|
Accumulate(Simulator inSim,
String name)
Constructs-initializes a new Accumulate statistical probe with name name and initial time 0. |
|
Accumulate(String name)
Constructs and initializes a new Accumulate statistical probe with name name and initial time 0, using the default simulator. |
Method Summary | |
---|---|
double |
average()
Returns the time-average since the last initialization to the last call to update. |
Accumulate |
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. |
void |
setSimulator(Simulator sim)
Sets the simulator associated with this probe to sim. |
String |
shortReport()
Formats and returns a short, one-line report about this statistical probe. |
String |
shortReportHeader()
Returns a string containing the name of the values returned in the report strings. |
Simulator |
simulator()
Returns the simulator associated with this statistical probe. |
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 |
---|
addObservationListener, clearObservationListeners, getName, isBroadcasting, isCollecting, max, min, notifyListeners, removeObservationListener, report, report, setBroadcasting, setCollecting, setName |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Accumulate()
public Accumulate(Simulator inSim)
inSim
- the simulator of the current variablepublic Accumulate(String name)
public Accumulate(Simulator inSim, String name)
name
- descriptive name for the probeinSim
- the simulator of the current variableMethod Detail |
---|
public void init()
init
in class StatProbe
public void init(double x)
init
followed by update
(x).
x
- initial value of the probepublic void update()
update
.
public void update(double x)
notifyListeners
.
x
- new observation given to the probepublic double sum()
StatProbe
Tally
or
Accumulate
).
This returns 0
if the probe was not updated since the last initialization.
sum
in class StatProbe
public double average()
average
in class StatProbe
public String shortReportHeader()
StatProbe
System.out.println (probe1.shortReportHeader()); System.out.println (probe1.getName() + " " + probe1.shortReport()); System.out.println (probe2.getName() + " " + probe2.shortReport()); ...Alternatively, one can use
report
(String,StatProbe[])
to get a report with aligned probe names.
shortReportHeader
in class StatProbe
public String shortReport()
StatProbe
shortReportHeader
().
This report should not contain any end-of-line character, and does not
include the name of the probe.
Its contents depends on the statistical probe as well as on the
parameters set by the user through probe-specific methods.
shortReport
in class StatProbe
public String report()
StatProbe
report
in class StatProbe
public double getInitTime()
init
was called for
the last time.
public double getLastTime()
update
or
the initialization time if update
was never called after
init
.
public double getLastValue()
update
method (or the initial value if
update
was never called after init
).
public Simulator simulator()
public void setSimulator(Simulator sim)
init
after this method to reset the statistical probe.
sim
- the simulator of this probepublic Accumulate clone()
clone
in class StatProbe
|
SSJ V. 2.6.2. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |