AnyLogic AnyLogic
Expand
Font size
All Implemented Interfaces:
java.io.Serializable

public class HistogramSimpleData
extends HistogramData
Data of a histogram with a fixed minimum, maximum and number of intervals. The outlaying samples are registered in special "too low" and "too high" intervals.
Author:
AnyLogic North America, LLC https://anylogic.com
See Also:
Serialized Form

Constructor Summary

Constructors 
HistogramSimpleData​(int nIntervals, double min, double max, boolean calcCDF, boolean calcPercentiles, double lowPercent, double highPercent)
Constructs a simple histogram data object with the given number of intervals and range.
HistogramSimpleData​(int nIntervals, double min, double max, boolean calcCDF, boolean calcPercentiles, double lowPercent, double highPercent, DataUpdater_xjal updater)
Constructs a simple histogram data object with the given number of intervals and range.
Constructor Description

Method Summary

All Methods Instance Methods Concrete Methods 
void add​(double val)
Adds a sample data item to the histogram data object, updates PDF, CDF and statistics.
double getPDFOutsideHigh()
Returns the percent of samples (0..1) higher than the specified maximum.
double getPDFOutsideLow()
Returns the percent of samples (0..1) lower than the specified minimum.
double getXMax()
Returns the upper bound of the range covered by intervals.
double getXMin()
Returns the lower bound of the range covered by intervals.
void reset()
Fully resets the histogram data: discards all PDF/CDF data and statistics.
void setMinMax​(double min, double max)
Fully resets the histogram data and sets the new range covered by intervals.
Modifier and Type Method Description

Methods inherited from class com.anylogic.engine.analysis.HistogramData

arePercentilesEnabled, count, destroyUpdater_xjal, deviation, getCDF, getIntervalWidth, getMaxPDF, getNumberOfIntervals, getPDF, getPercentHigh, getPercentLow, getPlainDataTable, getStatistics, isCDFEnabled, max, mean, meanConfidence, min, setCDFEnabled, setPercentilesEnabled, setPercents, toString, update

Methods inherited from class com.anylogic.engine.analysis.ChartItem

getVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramSimpleData

public HistogramSimpleData​(int nIntervals,
                           double min,
                           double max,
                           boolean calcCDF,
                           boolean calcPercentiles,
                           double lowPercent,
                           double highPercent)
Constructs a simple histogram data object with the given number of intervals and range.
Parameters:
nIntervals - the number of intervals
min - the lower bound of the range covered by the histogram intervals
max - the upper bound of the range covered by the histogram intervals
calcCDF - if true, CDF is calculated
calcPercentiles - if true and calcCDF is true, percentiles are calculated
lowPercent - the low percent bound, between 0 and 1
highPercent - the high percent bound, between 0 and 1

HistogramSimpleData

public HistogramSimpleData​(int nIntervals,
                           double min,
                           double max,
                           boolean calcCDF,
                           boolean calcPercentiles,
                           double lowPercent,
                           double highPercent,
                           DataUpdater_xjal updater)
Constructs a simple histogram data object with the given number of intervals and range.
Parameters:
nIntervals - the number of intervals
min - the lower bound of the range covered by the histogram intervals
max - the upper bound of the range covered by the histogram intervals
calcCDF - if true, CDF is calculated
calcPercentiles - if true and calcCDF is true, percentiles are calculated
lowPercent - the low percent bound, between 0 and 1
highPercent - the high percent bound, between 0 and 1
updater - updater which may be used instead of overriding HistogramData.update() method

Method Detail

setMinMax

public void setMinMax​(double min,
                      double max)
Fully resets the histogram data and sets the new range covered by intervals.
Parameters:
min - the lower bound of the range
max - the upper bound of the range

reset

public void reset()
Fully resets the histogram data: discards all PDF/CDF data and statistics.
Overrides:
reset in class HistogramData

add

public void add​(double val)
Adds a sample data item to the histogram data object, updates PDF, CDF and statistics.
Specified by:
add in class HistogramData
Parameters:
val - the sample value

getPDFOutsideLow

public double getPDFOutsideLow()
Returns the percent of samples (0..1) lower than the specified minimum. It equals the CDF at the point of minimum.
Returns:
the percent of samples lower than the specified minimum

getPDFOutsideHigh

public double getPDFOutsideHigh()
Returns the percent of samples (0..1) higher than the specified maximum.
Returns:
the percent of samples higher than the specified maximum

getXMin

public double getXMin()
Returns the lower bound of the range covered by intervals.
Specified by:
getXMin in class HistogramData
Returns:
the lower bound of the range covered by intervals

getXMax

public double getXMax()
Returns the upper bound of the range covered by intervals.
Specified by:
getXMax in class HistogramData
Returns:
the upper bound of the range covered by intervals
How can we improve this article?