kgal-core/kgal.statistics.note

Package-level declarations

Types

Link copied to clipboard
data class MultiStatisticNote(val statistics: List<Statistic<Any?>>, val ownerName: String, val iteration: Int) : StatisticNote<Any?>

MultiStatisticNote - multi record statistics.

Link copied to clipboard
data class SingleStatisticNote<V>(val statistic: Statistic<V>, val ownerName: String, val iteration: Int) : StatisticNote<V>

SingleStatisticNote - single record statistics

Link copied to clipboard
interface Statistic<out V>

Base interface for Statistic. Used as field of StatisticNote.

Link copied to clipboard
sealed interface StatisticNote<V>

StatisticNote - general abstraction for a statistical record that includes:

Functions

Link copied to clipboard
suspend fun EvolveScope<*, *>.stat(statistic: Statistic<Any?>)
@JvmName(name = "statValue")
suspend fun EvolveScope<*, *>.stat(pair: Pair<String, Any?>)
@JvmName(name = "statRegister")
suspend fun EvolveScope<*, *>.stat(pair: Pair<String, () -> Any?>)
suspend fun EvolveScope<*, *>.stat(name: String, value: Any?)

Creates SingleStatisticNote and send it to GA.statisticsProvider

suspend fun EvolveScope<*, *>.stat(vararg statistics: Statistic<Any?>)
@JvmName(name = "statValue")
suspend fun EvolveScope<*, *>.stat(vararg pairs: Pair<String, Any?>)
@JvmName(name = "statRegister")
suspend fun EvolveScope<*, *>.stat(vararg pairs: Pair<String, () -> Any?>)

Creates MultiStatisticNote and send it to GA.statisticsProvider

inline suspend fun EvolveScope<*, *>.stat(name: String, registrar: () -> Any?)

Creates SingleStatisticNote and send it to GA.statisticsProvider Use registrar function

Link copied to clipboard
fun <V> Statistic(name: String, value: V): Statistic<V>

Creates Statistic using StatisticInstance.

Link copied to clipboard
inline fun <V> Flow<StatisticNote<V>>.withName(name: String): Flow<SingleStatisticNote<V>>
Link copied to clipboard
fun Flow<StatisticNote<Any?>>.withNames(vararg names: String): Flow<StatisticNote<Any?>>