Double

kotlin-stdlib / kotlin / Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.3) 
class Double : Number, Comparable<Double>
For Common, JVM, JS

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 Native

Represents a double-precision 64-bit IEEE 754 floating point number.

Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

dec

Returns this value decremented by one.

operator fun dec(): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: Native (1.3)

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
Platform and version requirements: Native (1.3)

hashCode

Returns a hash code value for the object. The general contract of hashCode is:

fun hashCode(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

inc

Returns this value incremented by one.

operator fun inc(): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

rem

Calculates the remainder of truncating division of this value by the other value.

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toByte

Converts this Double value to Byte.

fun toByte(): Byte
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toChar

Converts this Double value to Char.

fun toChar(): Char
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toDouble

Returns this value.

fun toDouble(): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toFloat

Converts this Double value to Float.

fun toFloat(): Float
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toInt

Converts this Double value to Int.

fun toInt(): Int
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toLong

Converts this Double value to Long.

fun toLong(): Long
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

toShort

Converts this Double value to Short.

fun toShort(): Short
Platform and version requirements: Native (1.3)

toString

Returns a string representation of the object.

fun toString(): String
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

unaryMinus

Returns the negative of this value.

operator fun unaryMinus(): Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

unaryPlus

Returns this value.

operator fun unaryPlus(): Double

Companion Object Properties

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

MAX_VALUE

A constant holding the largest positive finite value of Double.

const val MAX_VALUE: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

MIN_VALUE

A constant holding the smallest positive nonzero value of Double.

const val MIN_VALUE: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

NaN

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

const val NaN: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

NEGATIVE_INFINITY

A constant holding the negative infinity value of Double.

const val NEGATIVE_INFINITY: Double
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

POSITIVE_INFINITY

A constant holding the positive infinity value of Double.

const val POSITIVE_INFINITY: Double
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

SIZE_BITS

The number of bits used to represent an instance of Double in a binary form.

const val SIZE_BITS: Int
Platform and version requirements: JVM (1.4), JS (1.4), Native (1.4)

SIZE_BYTES

The number of bytes used to represent an instance of Double in a binary form.

const val SIZE_BYTES: Int

Extension Properties

Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

days

Returns a Duration equal to this Double number of days.

val Double.days: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

hours

Returns a Duration equal to this Double number of hours.

val Double.hours: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

microseconds

Returns a Duration equal to this Double number of microseconds.

val Double.microseconds: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

milliseconds

Returns a Duration equal to this Double number of milliseconds.

val Double.milliseconds: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

minutes

Returns a Duration equal to this Double number of minutes.

val Double.minutes: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

nanoseconds

Returns a Duration equal to this Double number of nanoseconds.

val Double.nanoseconds: Duration
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

seconds

Returns a Duration equal to this Double number of seconds.

val Double.seconds: Duration

Extension Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)

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
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

mod

Calculates the remainder of flooring division of this value by the other value.

fun Double.mod(other: Float): Double
fun Double.mod(other: Double): Double
Platform and version requirements: Native (1.3)

narrow

fun <R : Number> Number.narrow(): R
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

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>
Platform and version requirements: Native (1.3)

signExtend

fun <R : Number> Number.signExtend(): R
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)

times

Returns a duration whose value is the specified duration value multiplied by this number.

operator fun Double.times(duration: Duration): Duration
Platform and version requirements: JVM (1.2)

toBigDecimal

Returns the value of this Double number as a BigDecimal.

fun Double.toBigDecimal(): BigDecimal
fun Double.toBigDecimal(mathContext: MathContext): BigDecimal
Platform and version requirements: JVM (1.6), JS (1.6), Native (1.6)

toDuration

Returns a Duration equal to this Double number of the specified unit.

fun Double.toDuration(unit: DurationUnit): Duration
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toUInt

Converts this Double value to UInt.

fun Double.toUInt(): UInt
Platform and version requirements: JVM (1.5), JS (1.5), Native (1.5)

toULong

Converts this Double value to ULong.

fun Double.toULong(): ULong

© 2010–2021 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html