BatchStatisticIfc

Properties

Link copied to clipboard
Link copied to clipboard

Fills up an array with the statistics defined by this interface statistics0 = getCount() statistics1 = getAverage() statistics2 = getStandardDeviation() statistics3 = getStandardError() statistics4 = getHalfWidth() statistics5 = getConfidenceLevel() statistics6 = getMin() statistics7 = getMax() statistics8 = getSum() statistics9 = getVariance() statistics10 = getDeviationSumOfSquares() statistics11 = getLastValue() statistics12 = getKurtosis() statistics13 = getSkewness() statistics14 = getLag1Covariance() statistics15 = getLag1Correlation() statistics16 = getVonNeumannLag1TestStatistic() statistics17 = getNumberMissing()

Link copied to clipboard
open val asStrings: List<String>

Returns the values of all the statistics as a list of strings The name is the first string

Link copied to clipboard
abstract val average: Double

Gets the unweighted average of the observations.

Link copied to clipboard
abstract val batchMeans: DoubleArray

Returns a copy of the batch means array. Zero index is the first batch mean

Link copied to clipboard

A confidence interval for the mean based on the confidence level

Link copied to clipboard
abstract val confidenceLevel: Double

Gets the confidence level. The default is given by Statistic.DEFAULT_CONFIDENCE_LEVEL = 0.95, which is a 95% confidence level

Link copied to clipboard
abstract val count: Double

Gets the count of the number of the observations.

Link copied to clipboard
open val csvHeader: List<String>

Gets the CSV header values as a list of strings

Link copied to clipboard
open override val csvStatistic: String
Link copied to clipboard
open override val csvStatisticHeader: String

The header string for the CVS representation

Link copied to clipboard
abstract val currentBatchSize: Int

the size of the current batch

Link copied to clipboard

Returns a copy of the StatisticIfc that is tabulating the current batch

Link copied to clipboard

Gets the sum of squares of the deviations from the average This is the numerator in the classic sample variance formula

Link copied to clipboard
open val halfWidth: Double

Gets the confidence interval half-width. Simply the standard error times the confidence coefficient

Link copied to clipboard
abstract val kurtosis: Double

Gets the kurtosis of the data

Link copied to clipboard
abstract val lag1Correlation: Double

Gets the lag-1 generate correlation of the unweighted observations. Note: See Box, Jenkins, Reinsel, Time Series Analysis, 3rd edition, Prentice-Hall, pg 31

Link copied to clipboard
abstract val lag1Covariance: Double

Gets the lag-1 generate covariance of the unweighted observations. Note: See Box, Jenkins, Reinsel, Time Series Analysis, 3rd edition, Prentice-Hall, pg 31

Link copied to clipboard
abstract val lastValue: Double
Link copied to clipboard
abstract val max: Double

Gets the maximum of the observations.

Link copied to clipboard
abstract val maxNumBatches: Int

The maximum number of batches as determined by the max num batches multiple

Link copied to clipboard
abstract val min: Double

Gets the minimum of the observations.

Link copied to clipboard
abstract val minBatchSize: Int

The minimum number of observations per batch

Link copied to clipboard
abstract val minNumBatches: Int

The minimum number of batches required

Link copied to clipboard

The multiple of the minimum number of batches that determines the maximum number of batches e.g. if the min. number of batches is 20 and the max number batches multiple is 2, then we can have at most 40 batches

Link copied to clipboard
abstract override val name: String

Gets the name of the Statistic

Link copied to clipboard
abstract val negativeCount: Double

Counts the number of observations that were negative, strictly less than zero.

Link copied to clipboard
abstract val numBatches: Int

the number of batches

Link copied to clipboard
abstract val numberMissing: Double

When a data point having the value of (Double.NaN, Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY) are presented it is excluded from the summary statistics and the number of missing points is noted. This method reports the number of missing points that occurred during the collection

Link copied to clipboard
abstract val numRebatches: Int

the number of times re-batching has occurred

Link copied to clipboard

Counts the number of observations that were positive, strictly greater than zero.

Link copied to clipboard

Returns the relative error: getStandardError() / getAverage()

Link copied to clipboard

Returns the relative width of the default confidence interval: 2.0 * getHalfWidth() / getAverage()

Link copied to clipboard
abstract val skewness: Double

Gets the skewness of the data

Link copied to clipboard

Gets the sample standard deviation of the observations. Simply the square root of variance

Link copied to clipboard
abstract val standardError: Double

Gets the standard error of the observations. Simply the generate standard deviation divided by the square root of the number of observations

Link copied to clipboard

Fills the map with the values of the statistics. Key is statistic label and value is the value of the statistic. The keys are: "Count" "Average" "Standard Deviation" "Standard Error" "Half-width" "Confidence Level" "Lower Limit" "Upper Limit" "Minimum" "Maximum" "Sum" "Variance" "Deviation Sum of Squares" "Kurtosis" "Skewness" "Lag 1 Covariance" "Lag 1 Correlation" "Von Neumann Lag 1 Test Statistic" "Number of missing observations"

Link copied to clipboard
abstract val sum: Double

Gets the sum of the observations.

Link copied to clipboard

Gets the total number of observations observed

Link copied to clipboard
abstract val value: Double
Link copied to clipboard
abstract val variance: Double

Gets the sample variance of the observations.

Link copied to clipboard

Gets the Von Neumann Lag 1 test statistic for checking the hypothesis that the data are uncorrelated Note: See Handbook of Simulation, Jerry Banks editor, McGraw-Hill, pg 253.

Link copied to clipboard

Returns the asymptotic p-value for the Von Nueumann Lag-1 Test Statistic:

Link copied to clipboard
open val width: Double
Link copied to clipboard
abstract val zeroCount: Double

Counts the number of observations that were exactly zero.

Functions

Link copied to clipboard
abstract fun checkMean(mean: Double): Boolean

Checks if the supplied value falls within getAverage() +/- getHalfWidth()

Link copied to clipboard

A confidence interval for the mean based on the confidence level

Link copied to clipboard

Return a copy of the information as an instance of a statistic

Link copied to clipboard
open override fun estimate(): Double
Link copied to clipboard
open fun halfWidth(level: Double): Double

Gets the confidence interval half-width. Simply the standard error times the confidence coefficient as determined by an appropriate sampling distribution

Link copied to clipboard
abstract fun instance(): BatchStatistic

Returns a copy of the BatchStatistic

Link copied to clipboard
open fun leadingDigitRule(multiplier: Double): Int

Computes the right most meaningful digit according to (int)Math.floor(Math.log10(a*getStandardError())) See doi 10.1287.opre.1080.0529 by Song and Schmeiser

Link copied to clipboard
abstract fun reformBatches(numBatches: Int): DoubleArray

Takes the current batch means and batches them into the specified number of batches. This does not change the current batch means

Link copied to clipboard
open fun relativeWidth(level: Double): Double

Returns the relative width of the level of the confidence interval: 2.0 * getHalfWidth(level) / getAverage()

Link copied to clipboard
open fun statisticData(level: Double = 0.95): StatisticData

Returns a data class holding the statistical data with the confidence interval specified by the given level.

Link copied to clipboard
open fun statisticDataDb(level: Double = 0.95, context: String? = null, subject: String? = null, tableName: String = "tblStatistic"): StatisticDataDb

Returns a data class holding the statistical data with the confidence interval specified by the given level. The class is suitable for inserting into a database table.

Link copied to clipboard
fun StatisticIfc.toStatDataFrame(valueLabel: String = "Value"): DataFrame<StatSchema>

Converts a statistic to a data frame with two columns. The first column holds the names of the statistics and the second column holds the values. The valueLabel can be used to provide a column name for the value columns. By default, it is "Value".

Link copied to clipboard
abstract override fun toString(): String

Returns a String representation of the Statistic

Link copied to clipboard
open fun width(level: Double): Double