Package com.anylogic.engine.analysis
- java.lang.Object
-
- com.anylogic.engine.analysis.ChartItem
-
- com.anylogic.engine.analysis.HistogramData
-
- com.anylogic.engine.analysis.HistogramSimpleData
- 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
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 |
---|
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 |
---|
arePercentilesEnabled, count, destroyUpdater_xjal, deviation, getCDF, getIntervalWidth, getMaxPDF, getNumberOfIntervals, getPDF, getPercentHigh, getPercentLow, getPlainDataTable, getStatistics, isCDFEnabled, max, mean, meanConfidence, min, setCDFEnabled, setPercentilesEnabled, setPercents, toString, update
getVersion
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
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 intervalsmin
- the lower bound of the range covered by the histogram intervalsmax
- the upper bound of the range covered by the histogram intervalscalcCDF
- iftrue
, CDF is calculatedcalcPercentiles
- iftrue
and calcCDF istrue
, percentiles are calculatedlowPercent
- the low percent bound, between 0 and 1highPercent
- the high percent bound, between 0 and 1
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 intervalsmin
- the lower bound of the range covered by the histogram intervalsmax
- the upper bound of the range covered by the histogram intervalscalcCDF
- iftrue
, CDF is calculatedcalcPercentiles
- iftrue
and calcCDF istrue
, percentiles are calculatedlowPercent
- the low percent bound, between 0 and 1highPercent
- the high percent bound, between 0 and 1updater
- updater which may be used instead of overridingHistogramData.update()
method
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 rangemax
- the upper bound of the range
public void reset()
Fully resets the histogram data: discards all PDF/CDF data and statistics.
- Overrides:
reset
in classHistogramData
public void add(double val)
Adds a sample data item to the histogram data object, updates PDF, CDF and
statistics.
- Specified by:
add
in classHistogramData
- Parameters:
val
- the sample value
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
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
public double getXMin()
Returns the lower bound of the range covered by intervals.
- Specified by:
getXMin
in classHistogramData
- Returns:
- the lower bound of the range covered by intervals
public double getXMax()
Returns the upper bound of the range covered by intervals.
- Specified by:
getXMax
in classHistogramData
- Returns:
- the upper bound of the range covered by intervals
-
How can we improve this article?
-