utils

Class StatKeeper

java.lang.Object

utils.StatKeeper

All Implemented Interfaces:

java.lang.Comparable<StatKeeper>

public class StatKeeper
extends java.lang.Object
implements java.lang.Comparable<StatKeeper>

A class representing a collection of statistic data.

Constructor Summary

Constructors

Constructor and Description
StatKeeper()
StatKeeper(boolean recordValues, java.lang.String statName, java.lang.String valuename, boolean isDisplayed) Creates a new StatKeeper object.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double x)
void	clear() Removes all data from this StatKeeper
int	compareTo(StatKeeper o)
int	elementNumber() Returns the number of elements
double	getElement(int e) Returns the given element from the series
double	getMax()
double	getMin()
java.lang.String	getStatName()
java.util.ArrayList<java.lang.Double>	getValues()
java.lang.String	getValuesName()
boolean	isDisplayed() Returns true if this statistics should be displayed.
double	mean() Returns the mean value of the contained data.
java.lang.String	result(boolean wHitrate)
static void	saveNotableStats(java.lang.String filename, java.util.ArrayList<StatKeeper> statList)
static void	saveNotableStats(java.lang.String filename, java.util.ArrayList<StatKeeper> statList, boolean addStatColumns)
static void	saveRboxFile(java.lang.String filename, java.util.ArrayList<StatKeeper> statList, int step) Creates a text file in a format to be read by the statistical program R the stat with the generation count is omitted
void	saveResults(java.lang.String intendedFilename) Saves the current statistic into a file
double	sdev() Returns the standard deviation of the contained data.
static void	showValuation() Calculates the valuation of a simulation (which may consist of more than one run) and outputs it on the console.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatKeeper

public StatKeeper()

StatKeeper

public StatKeeper(boolean recordValues,
          java.lang.String statName,
          java.lang.String valuename,
          boolean isDisplayed)

Creates a new StatKeeper object.

Parameters:

recordValues - defines if values should be recorded, otherwise just a statistic of min, max, mean, sdev is kept

statName - gives the value a name which is used for labeling the columns in the exported csv

isDisplayed - if true, this stat is added to a list of notable stats which can be exported to a csv together

Method Detail

elementNumber

public int elementNumber()

Returns the number of elements

getElement

public double getElement(int e)

Returns the given element from the series

add

public void add(double x)

mean

public double mean()

Returns the mean value of the contained data.

sdev

public double sdev()

Returns the standard deviation of the contained data.

clear

public void clear()

Removes all data from this StatKeeper

result

public java.lang.String result(boolean wHitrate)

saveResults

public void saveResults(java.lang.String intendedFilename)

Saves the current statistic into a file

Parameters:

intendedFilename - , the filename might be changed if the file is busy

saveNotableStats

public static void saveNotableStats(java.lang.String filename,
                    java.util.ArrayList<StatKeeper> statList)

saveNotableStats

public static void saveNotableStats(java.lang.String filename,
                    java.util.ArrayList<StatKeeper> statList,
                    boolean addStatColumns)

saveRboxFile

public static void saveRboxFile(java.lang.String filename,
                java.util.ArrayList<StatKeeper> statList,
                int step)

Creates a text file in a format to be read by the statistical program R the stat with the generation count is omitted

Parameters:

filename - filename and path of the file to be created

statList - an ArrayList of statkeeper objects

step - only every step-th generation is saved, this is useful to keep a comprehensible boxplot

showValuation

public static void showValuation()

Calculates the valuation of a simulation (which may consist of more than one run) and outputs it on the console.

compareTo

public int compareTo(StatKeeper o)

Specified by:

compareTo in interface java.lang.Comparable<StatKeeper>

getStatName

public java.lang.String getStatName()

getValuesName

public java.lang.String getValuesName()

getMin

public double getMin()

Returns:

the minimum of the series

getMax

public double getMax()

Returns:

the maximum of the series

isDisplayed

public boolean isDisplayed()

Returns true if this statistics should be displayed.

getValues

public java.util.ArrayList<java.lang.Double> getValues()