kumulant

kumulant/com.eignex.kumulant.stat.forecast/SeasonalSmoothingResult

SeasonalSmoothingResult

@Serializable

@SerialName(value = "SeasonalSmoothingResult")

data class SeasonalSmoothingResult(val level: Double, val trend: Double, val seasons: List<Double>, val currentSlot: Int, val phi: Double, val mode: SeasonalMode) : Result(source)

Snapshot from a SeasonalSmoothingStat: level, trend, seasonal factors, and forecast machinery.

Constructors

SeasonalSmoothingResult

constructor(level: Double, trend: Double, seasons: List<Double>, currentSlot: Int, phi: Double, mode: SeasonalMode)

Properties

val currentSlot: Int

Index 0..period-1 of the next seasonal slot to consume.

val level: Double

Smoothed level.

val mode: SeasonalMode

Seasonal coupling.

val period: Int

Length of the seasonal cycle.

val phi: Double

Trend damping factor in (0, 1].

val seasons: List<Double>

Seasonal factors; length equals the configured period and wraps around at horizon h.

val trend: Double

Smoothed trend.

Functions

fun forecast(steps: Int): Double

Project steps updates ahead using the same recurrence shape as the stat: trend contribution is geometrically damped by phi, seasonal contribution wraps around the seasons vector.

SeasonalSmoothingResult

constructor(level: Double, trend: Double, seasons: List<Double>, currentSlot: Int, phi: Double, mode: SeasonalMode)(source)

currentSlot

val currentSlot: Int(source)

Index 0..period-1 of the next seasonal slot to consume.

forecast

fun forecast(steps: Int): Double(source)

Project steps updates ahead using the same recurrence shape as the stat: trend contribution is geometrically damped by phi, seasonal contribution wraps around the seasons vector.

level

val level: Double(source)

Smoothed level.

mode

val mode: SeasonalMode(source)

Seasonal coupling.

period

val period: Int(source)

Length of the seasonal cycle.

phi

val phi: Double(source)

Trend damping factor in (0, 1].

seasons

val seasons: List<Double>(source)

Seasonal factors; length equals the configured period and wraps around at horizon h.

trend

val trend: Double(source)

Smoothed trend.