kumulant
kumulant/com.eignex.kumulant.stat.summary/SummaryResult

SummaryResult

@Serializable
@SerialName(value = "SummaryResult")
data class SummaryResult(val totalWeights: Double, val mean: Double, val variance: Double, val min: Double, val max: Double) : Result, HasSampleVariance, HasCenterScale, HasMinMax(source)

Snapshot exposing running mean, variance, min, and max simultaneously.

Constructors

Link copied to clipboard
constructor(totalWeights: Double, mean: Double, variance: Double, min: Double, max: Double)

Properties

Link copied to clipboard
open override val center: Double

Center of the distribution; typically a mean, median, or smoothed level.

Link copied to clipboard
open override val max: Double

Running maximum value.

Link copied to clipboard
val mean: Double

Weighted running mean.

Link copied to clipboard
open override val min: Double

Running minimum value.

Link copied to clipboard
open val sampleStdDev: Double

Unbiased sample standard deviation: sqrt([sampleVariance]).

Link copied to clipboard
open val sampleVariance: Double

Unbiased sample variance: [sst] / ([totalWeights] - 1). Zero when totalWeights <= 1.

Link copied to clipboard
open override val scale: Double

Scale of the distribution; typically a standard deviation, MAD, or span.

Link copied to clipboard
open val sst: Double

Sum of squared deviations from the running mean: Sum (x - mean)^2 * weight.

Link copied to clipboard
open val stdDev: Double

Population standard deviation: sqrt([variance]).

Link copied to clipboard
open override val totalWeights: Double

Cumulative observation weight folded in.

Link copied to clipboard
open override val variance: Double

Population variance: sst / totalWeights.

SummaryResult

constructor(totalWeights: Double, mean: Double, variance: Double, min: Double, max: Double)(source)

center

open override val center: Double(source)

Center of the distribution; typically a mean, median, or smoothed level.

max

open override val max: Double(source)

Running maximum value.

mean

val mean: Double(source)

Weighted running mean.

min

open override val min: Double(source)

Running minimum value.

scale

open override val scale: Double(source)

Scale of the distribution; typically a standard deviation, MAD, or span.

totalWeights

open override val totalWeights: Double(source)

Cumulative observation weight folded in.

variance

open override val variance: Double(source)

Population variance: sst / totalWeights.