types/kotools.types.number/StrictlyNegativeDouble

StrictlyNegativeDouble

@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)

@Serializable(with = StrictlyNegativeDoubleSerializer::class)

Represents a floating-point number of type Double that is less than zero.

You can use the StrictlyNegativeDouble.Companion.create or the StrictlyNegativeDouble.Companion.createOrNull functions for creating an instance of this type.

Serialization and deserialization

The serialization and the deserialization processes of this type should behave like for the Double type.

Here's an example of Kotlin code that encodes and decodes this type using the JavaScript Object Notation (JSON) format from kotlinx.serialization:

val number: StrictlyNegativeDouble = StrictlyNegativeDouble.create(-4.2)
val encoded: String = Json.encodeToString(number)
assertEquals(expected = "-4.2", actual = encoded)
val decoded: StrictlyNegativeDouble = Json.decodeFromString(encoded)
assertEquals(expected = number, actual = decoded)

Types

Companion

object Companion

Contains static declarations for the StrictlyNegativeDouble type.

Functions

equals

operator override fun equals(other: Any?): Boolean

Returns true if the other object is a StrictlyNegativeDouble having the same value as this floating-point number, or returns false otherwise.

hashCode

override fun hashCode(): Int

Returns a hash code value for this floating-point number.

toDouble

fun toDouble(): Double

Returns this floating-point number as Double.

toString

override fun toString(): String

Returns the string representation of this floating-point number.