Double
For Common, JVM
Represents a double-precision 64-bit IEEE 754 floating point number.
On the JVM, non-nullable values of this type are represented as values of the primitive type double
.
For JS, Native
Represents a double-precision 64-bit IEEE 754 floating point number.
Functions
compareTo
Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.
operator fun compareTo(other: Byte): Int
operator fun compareTo(other: Short): Int
operator fun compareTo(other: Int): Int
operator fun compareTo(other: Long): Int
operator fun compareTo(other: Float): Int
operator fun compareTo(other: Double): Int
dec
Returns this value decremented by one.
operator fun dec(): Double
div
Divides this value by the other value.
operator fun div(other: Byte): Double
operator fun div(other: Short): Double
operator fun div(other: Int): Double
operator fun div(other: Long): Double
operator fun div(other: Float): Double
operator fun div(other: Double): Double
equals
fun equals(other: Double): Boolean
Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:
fun equals(other: Any?): Boolean
hashCode
Returns a hash code value for the object. The general contract of hashCode
is:
fun hashCode(): Int
inc
Returns this value incremented by one.
operator fun inc(): Double
minus
Subtracts the other value from this value.
operator fun minus(other: Byte): Double
operator fun minus(other: Short): Double
operator fun minus(other: Int): Double
operator fun minus(other: Long): Double
operator fun minus(other: Float): Double
operator fun minus(other: Double): Double
plus
Adds the other value to this value.
operator fun plus(other: Byte): Double
operator fun plus(other: Short): Double
operator fun plus(other: Int): Double
operator fun plus(other: Long): Double
operator fun plus(other: Float): Double
operator fun plus(other: Double): Double
rem
Calculates the remainder of truncating division of this value (dividend) by the other value (divisor).
operator fun rem(other: Byte): Double
operator fun rem(other: Short): Double
operator fun rem(other: Int): Double
operator fun rem(other: Long): Double
operator fun rem(other: Float): Double
operator fun rem(other: Double): Double
times
Multiplies this value by the other value.
operator fun times(other: Byte): Double
operator fun times(other: Short): Double
operator fun times(other: Int): Double
operator fun times(other: Long): Double
operator fun times(other: Float): Double
operator fun times(other: Double): Double
toDouble
Returns this value.
fun toDouble(): Double
toString
Returns a string representation of the object.
fun toString(): String
unaryMinus
Returns the negative of this value.
operator fun unaryMinus(): Double
unaryPlus
Returns this value.
operator fun unaryPlus(): Double
Companion Object Properties
MAX_VALUE
A constant holding the largest positive finite value of Double.
const val MAX_VALUE: Double
MIN_VALUE
A constant holding the smallest positive nonzero value of Double.
const val MIN_VALUE: Double
NaN
A constant holding the "not a number" value of Double.
const val NaN: Double
NEGATIVE_INFINITY
A constant holding the negative infinity value of Double.
const val NEGATIVE_INFINITY: Double
POSITIVE_INFINITY
A constant holding the positive infinity value of Double.
const val POSITIVE_INFINITY: Double
SIZE_BITS
The number of bits used to represent an instance of Double in a binary form.
const val SIZE_BITS: Int
SIZE_BYTES
The number of bytes used to represent an instance of Double in a binary form.
const val SIZE_BYTES: Int
Extension Properties
Extension Functions
coerceAtLeast
Ensures that this value is not less than the specified minimumValue.
fun Double.coerceAtLeast(minimumValue: Double): Double
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
coerceAtMost
Ensures that this value is not greater than the specified maximumValue.
fun Double.coerceAtMost(maximumValue: Double): Double
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
coerceIn
Ensures that this value lies in the specified range minimumValue..maximumValue.
fun Double.coerceIn(
minimumValue: Double,
maximumValue: Double
): Double
fun <T : Comparable<T>> T.coerceIn(
minimumValue: T?,
maximumValue: T?
): T
Ensures that this value lies in the specified range.
fun <T : Comparable<T>> T.coerceIn(
range: ClosedFloatingPointRange<T>
): T
fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T
compareTo
Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.
infix fun <T> Comparable<T>.compareTo(other: T): Int
mod
Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).
fun Double.mod(other: Float): Double
fun Double.mod(other: Double): Double
rangeTo
Creates a range from this Double value to the specified that value.
operator fun Double.rangeTo(
that: Double
): ClosedFloatingPointRange<Double>
Creates a range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeTo(
that: T
): ClosedRange<T>
rangeUntil
Creates an open-ended range from this Double value to the specified that value.
operator fun Double.rangeUntil(
that: Double
): OpenEndRange<Double>
Creates an open-ended range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeUntil(
that: T
): OpenEndRange<T>
toBigDecimal
Returns the value of this Double number as a BigDecimal.
fun Double.toBigDecimal(): BigDecimal
fun Double.toBigDecimal(mathContext: MathContext): BigDecimal
toDuration
Returns a Duration equal to this Double number of the specified unit.
fun Double.toDuration(unit: DurationUnit): Duration