commonMain.io.kotest.matchers.doubles.NaN.kt Maven / Gradle / Ivy

Go to download
package io.kotest.matchers.doubles

import io.kotest.matchers.Matcher
import io.kotest.matchers.MatcherResult
import io.kotest.matchers.should
import io.kotest.matchers.shouldNot

/**
 * Asserts that this [Double] is [Double.NaN]
 *
 * Verifies that this [Double] is the Not-a-Number constant [Double.NaN]
 *
 * Opposite of [shouldNotBeNaN]
 *
 * ```
 * Double.NaN.shouldBeNaN()   // Assertion passes
 * 1.0.shouldBeNaN()          // Assertion fails
 * ```
 * @see [beNaN]
 */
fun Double.shouldBeNaN(): Double {
   this should beNaN()
   return this
}

/**
 * Assert that this [Double] is not [Double.NaN]
 *
 * Verifies that this [Double] is NOT the Not-a-Number constant [Double.NaN]
 *
 * Opposite of [shouldBeNaN]
 *
 * ```
 * 1.0.shouldNotBeNaN()         // Assertion passes
 * Double.NaN.shouldNotBeNaN()  // Assertion fails
 * ```
 * @see [beNaN]
 */
fun Double.shouldNotBeNaN(): Double {
   this shouldNot beNaN()
   return this
}

/**
 * Matcher that matches [Double.NaN]
 *
 * Verifies that a specific [Double] is the Not-a-Number constant [Double.NaN]
 *
 * ```
 *  0.5 should beNaN()            // Assertion fails
 *  Double.NaN should beNaN()     // Assertion passes
 * ```
 *
 * @see [Double.shouldBeNaN]
 * @see [Double.shouldNotBeNaN]
 */
fun beNaN() = object : Matcher {
   override fun test(value: Double) = MatcherResult(
      value.isNaN(),
      { "$value should be NaN" },
      {
         "$value should not be NaN"
      })
}