kotest-assertions-core / io.kotest.matchers.stats / kotlin.collections.Collection / shouldHaveStandardDeviation

shouldHaveStandardDeviation

fun <T : Number> Collection<T>.shouldHaveStandardDeviation(value: BigDecimal, precision: Int = 4): Unit

Asserts that standard deviation of the Collection elements equals to value with default or specific precision. Default precision equals 4 digits after decimal point.

Opposite of shouldNotHaveStandardDeviation

Example:

val collection = listOf(1, 2, 3)

collection.shouldHaveStandardDeviation(BigDecimal("0.82"), 2)      // Assertion passes
collection.shouldHaveStandardDeviation(BigDecimal("0.8165"))       // Assertion passes

collection.shouldHaveStandardDeviation(BigDecimal("0.82"))         // Assertion fails
collection.shouldHaveStandardDeviation(BigDecimal("0.8165"), 5)    // Assertion fails

Parameters

value -

precision -

fun <T : Number> Collection<T>.shouldHaveStandardDeviation(value: Double, precision: Int = 4): Unit

Asserts that standard deviation of the Collection elements equals to value with default or specific precision. Default precision equals 4 digits after decimal point.

Opposite of shouldNotHaveStandardDeviation

Example:

val collection = listOf(1, 2, 3)

collection.shouldHaveStandardDeviation(0.82, 2)      // Assertion passes
collection.shouldHaveStandardDeviation(0.8165)       // Assertion passes

collection.shouldHaveStandardDeviation(0.82)         // Assertion fails
collection.shouldHaveStandardDeviation(0.8165, 5)    // Assertion fails

Parameters

value -

precision -