Double

class Double : Number, Comparable<Double> (source)

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.

Functions

compareTo

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

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.

dec

operator fun dec(): Double

Decrements this value.

div

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

Divides this value by the other value.

inc

operator fun inc(): Double

Increments this value.

minus

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

Subtracts the other value from this value.

mod

operator fun mod(other: Byte): Double
operator fun mod(other: Short): Double
operator fun mod(other: Int): Double
operator fun mod(other: Long): Double
operator fun mod(other: Float): Double
operator fun mod(other: Double): Double

Calculates the remainder of dividing this value by the other value.

plus

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

Adds the other value to this value.

rem

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

Calculates the remainder of dividing this value by the other value.

times

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

Multiplies this value by the other value.

toByte

fun toByte(): Byte

Returns the value of this number as a Byte, which may involve rounding or truncation.

toChar

fun toChar(): Char

Returns the Char with the numeric value equal to this number, truncated to 16 bits if appropriate.

toDouble

fun toDouble(): Double

Returns the value of this number as a Double, which may involve rounding.

toFloat

fun toFloat(): Float

Returns the value of this number as a Float, which may involve rounding.

toInt

fun toInt(): Int

Returns the value of this number as an Int, which may involve rounding or truncation.

toLong

fun toLong(): Long

Returns the value of this number as a Long, which may involve rounding or truncation.

toShort

fun toShort(): Short

Returns the value of this number as a Short, which may involve rounding or truncation.

unaryMinus

operator fun unaryMinus(): Double

Returns the negative of this value.

unaryPlus

operator fun unaryPlus(): Double

Returns this value.

Companion Object Properties

MAX_VALUE

val MAX_VALUE: Double

A constant holding the largest positive finite value of Double.

MIN_VALUE

val MIN_VALUE: Double

A constant holding the smallest positive nonzero value of Double.

NEGATIVE_INFINITY

val NEGATIVE_INFINITY: Double

A constant holding the negative infinity value of Double.

NaN

val NaN: Double

A constant holding the "not a number" value of Double.

POSITIVE_INFINITY

val POSITIVE_INFINITY: Double

A constant holding the positive infinity value of Double.

Extension Properties

absoluteValue

actual val Double.absoluteValue: Double

Returns the absolute value of this value.

sign

actual val Double.sign: Double

Returns the sign of this value:

ulp

actual val Double.ulp: Double

Returns the ulp (unit in the last place) of this value.

Extension Functions

IEEErem

fun Double.IEEErem(divisor: Double): Double

Computes the remainder of division of this value by the divisor value according to the IEEE 754 standard.

coerceAtLeast

fun Double.coerceAtLeast(minimumValue: Double): Double

Ensures that this value is not less than the specified minimumValue.

coerceAtMost

fun Double.coerceAtMost(maximumValue: Double): Double

Ensures that this value is not greater than the specified maximumValue.

coerceIn

fun Double.coerceIn(
    minimumValue: Double,
    maximumValue: Double
): Double

Ensures that this value lies in the specified range minimumValue..maximumValue.

isFinite

actual fun Double.isFinite(): Boolean

Returns true if the argument is a finite floating-point value; returns false otherwise (for NaN and infinity arguments).

isInfinite

actual fun Double.isInfinite(): Boolean

Returns true if this value is infinitely large in magnitude.

isNaN

actual fun Double.isNaN(): Boolean

Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

nextDown

actual fun Double.nextDown(): Double

Returns the Double value nearest to this value in direction of negative infinity.

nextTowards

actual fun Double.nextTowards(to: Double): Double

Returns the Double value nearest to this value in direction from this value towards the value to.

nextUp

actual fun Double.nextUp(): Double

Returns the Double value nearest to this value in direction of positive infinity.

pow

actual fun Double.pow(x: Double): Double

Raises this value to the power x.

actual fun Double.pow(n: Int): Double

Raises this value to the integer power n.

rangeTo

operator fun Double.rangeTo(
    that: Double
): ClosedFloatingPointRange<Double>

Creates a range from this Double value to the specified that value.

roundToInt

actual fun Double.roundToInt(): Int

Rounds this Double value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

roundToLong

actual fun Double.roundToLong(): Long

Rounds this Double value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

toBigDecimal

fun Double.toBigDecimal(): BigDecimal
fun Double.toBigDecimal(mathContext: MathContext): BigDecimal

Returns the value of this Double number as a BigDecimal.

toBits

actual fun Double.toBits(): Long

Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout.

toRawBits

actual fun Double.toRawBits(): Long

Returns a bit representation of the specified floating-point value as Long according to the IEEE 754 floating-point "double format" bit layout, preserving NaN values exact layout.

withSign

actual fun Double.withSign(sign: Double): Double
actual fun Double.withSign(sign: Int): Double

Returns this value with the sign bit same as of the sign value.

Companion Object Extension Functions

fromBits

actual fun Double.Companion.fromBits(bits: Long): Double

Returns the Double value corresponding to a given bit representation.