W3cubDocs

/Scala 2.13 Library

Class scala.Double

Companion object Double

abstract final class Double extends AnyVal

Double, a 64-bit IEEE-754 floating point number (equivalent to Java's double primitive type) is a subtype of scala.AnyVal. Instances of Double are not represented by an object in the underlying runtime system.

There is an implicit conversion from scala.Double => scala.runtime.RichDouble which provides useful non-primitive operations.

Source
Double.scala
Linear Supertypes
AnyVal, Any

Abstract Value Members

abstract def !=(x: Double): Boolean

abstract def !=(x: Float): Boolean

abstract def !=(x: Long): Boolean

abstract def !=(x: Int): Boolean

abstract def !=(x: Char): Boolean

abstract def !=(x: Short): Boolean

abstract def !=(x: Byte): Boolean

abstract def %(x: Double): Double

abstract def %(x: Float): Double

abstract def %(x: Long): Double

abstract def %(x: Int): Double

abstract def %(x: Char): Double

abstract def %(x: Short): Double

abstract def %(x: Byte): Double

abstract def *(x: Double): Double

abstract def *(x: Float): Double

abstract def *(x: Long): Double

abstract def *(x: Int): Double

abstract def *(x: Char): Double

abstract def *(x: Short): Double

abstract def *(x: Byte): Double

abstract def +(x: Double): Double

abstract def +(x: Float): Double

abstract def +(x: Long): Double

abstract def +(x: Int): Double

abstract def +(x: Char): Double

abstract def +(x: Short): Double

abstract def +(x: Byte): Double

abstract def -(x: Double): Double

abstract def -(x: Float): Double

abstract def -(x: Long): Double

abstract def -(x: Int): Double

abstract def -(x: Char): Double

abstract def -(x: Short): Double

abstract def -(x: Byte): Double

abstract def /(x: Double): Double

abstract def /(x: Float): Double

abstract def /(x: Long): Double

abstract def /(x: Int): Double

abstract def /(x: Char): Double

abstract def /(x: Short): Double

abstract def /(x: Byte): Double

abstract def <(x: Double): Boolean

abstract def <(x: Float): Boolean

abstract def <(x: Long): Boolean

abstract def <(x: Int): Boolean

abstract def <(x: Char): Boolean

abstract def <(x: Short): Boolean

abstract def <(x: Byte): Boolean

abstract def <=(x: Double): Boolean

abstract def <=(x: Float): Boolean

abstract def <=(x: Long): Boolean

abstract def <=(x: Int): Boolean

abstract def <=(x: Char): Boolean

abstract def <=(x: Short): Boolean

abstract def <=(x: Byte): Boolean

abstract def ==(x: Double): Boolean

abstract def ==(x: Float): Boolean

abstract def ==(x: Long): Boolean

abstract def ==(x: Int): Boolean

abstract def ==(x: Char): Boolean

abstract def ==(x: Short): Boolean

abstract def ==(x: Byte): Boolean

abstract def >(x: Double): Boolean

abstract def >(x: Float): Boolean

abstract def >(x: Long): Boolean

abstract def >(x: Int): Boolean

abstract def >(x: Char): Boolean

abstract def >(x: Short): Boolean

abstract def >(x: Byte): Boolean

abstract def >=(x: Double): Boolean

abstract def >=(x: Float): Boolean

abstract def >=(x: Long): Boolean

abstract def >=(x: Int): Boolean

abstract def >=(x: Char): Boolean

abstract def >=(x: Short): Boolean

abstract def >=(x: Byte): Boolean

abstract def toByte: Byte

abstract def toChar: Char

abstract def toDouble: Double

abstract def toFloat: Float

abstract def toInt: Int

abstract def toLong: Long

abstract def toShort: Short

abstract def unary_+: Double

abstract def unary_-: Double

abstract def +(x: String): String

Annotations
@deprecated
Deprecated

(Since version 2.13.0) Adding a number and a String is deprecated. Use the string interpolation s"$num$str"

Concrete Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

true if !(this == that), false otherwise.

Definition Classes
Any

final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

returns

a hash value consistent with ==

Definition Classes
Any

def ->[B](y: B): (Double, B)

Implicit
This member is added by an implicit conversion from Double toArrowAssoc[Double] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any

def abs: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy

final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

ClassCastException if the receiver object is not an instance of the erasure of type T0.

def byteValue(): Byte

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def byteValue: Byte

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def ceil: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def compare(y: Double): Int

Result of comparing this with operand that.

Implement this method to determine how instances of A will be sorted.

Returns x where:

    x < 0 when this < that x == 0 when this == that x > 0 when this > that
Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
OrderedProxy → Ordered

def compareTo(arg0: java.lang.Double): Int

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Comparable

def compareTo(that: Double): Int

Result of comparing this with operand that.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
Ordered → Comparable

def doubleValue(): Double

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def doubleValue: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def ensuring(cond: (Double) => Boolean, msg: => Any): Double

Implicit
This member is added by an implicit conversion from Double toEnsuring[Double] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (Double) => Boolean): Double

Implicit
This member is added by an implicit conversion from Double toEnsuring[Double] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): Double

Implicit
This member is added by an implicit conversion from Double toEnsuring[Double] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): Double

Implicit
This member is added by an implicit conversion from Double toEnsuring[Double] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def equals(arg0: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

    It is reflexive: for any instance x of type Any, x.equals(x) should return true.It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any

def floatValue(): Float

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def floatValue: Float

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def floor: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def formatted(fmtstr: String): String

Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit
This member is added by an implicit conversion from Double toStringFormat[Double] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def getClass(): Class[Double]

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
DoubleAnyValAny

def hashCode(): Int

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

returns

the hash code value for this object.

Definition Classes
Any

def intValue(): Int

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def intValue: Int

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def isFinite: Boolean

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def isInfinite(): Boolean

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double

def isInfinity: Boolean

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is T0.

Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

returns

true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any

def isNaN(): Boolean

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double

def isNaN: Boolean

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def isNegInfinity: Boolean

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def isPosInfinity: Boolean

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def isValidByte: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns false.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumericAnyConversions

def isValidChar: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns false.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumericAnyConversions

def isValidInt: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns false.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumericAnyConversions

def isValidShort: Boolean

Returns true iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns false.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumericAnyConversions

def isWhole: Boolean

returns

true if this number has no decimal component, false otherwise.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → FractionalProxy → ScalaNumericAnyConversions

def longValue(): Long

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def longValue: Long

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def max(that: Double): Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy

def min(that: Double): Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy

def round: Long

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

val self: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → TypedProxy

def shortValue(): Short

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Definition Classes
Double → Number

def shortValue: Short

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions

def sign: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
ScalaNumberProxy

def toDegrees: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def toRadians: Double

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Definition Classes
RichDouble

def toString(): String

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
Any

Shadowed Implicit Value Members

def +(other: String): String

Implicit
This member is added by an implicit conversion from Double toany2stringadd[Double] performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: any2stringadd[Double]).+(other)
Definition Classes
any2stringadd

def <(that: Double): Boolean

Returns true if this is less than that

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).<(that)
Definition Classes
Ordered

def <=(that: Double): Boolean

Returns true if this is less than or equal to that.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).<=(that)
Definition Classes
Ordered

def >(that: Double): Boolean

Returns true if this is greater than that.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).>(that)
Definition Classes
Ordered

def >=(that: Double): Boolean

Returns true if this is greater than or equal to that.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).>=(that)
Definition Classes
Ordered

def equals(arg0: AnyRef): Boolean

The equality method for reference types. Default implementation delegates to eq.

See also equals in scala.Any.

returns

true if the receiver object is equivalent to the argument; false otherwise.

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: java.lang.Double).equals(arg0)
Definition Classes
Double → AnyRef → Any

def hashCode(): Int

The hashCode method for reference types. See hashCode in scala.Any.

returns

the hash code value for this object.

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: java.lang.Double).hashCode()
Definition Classes
Double → AnyRef → Any

def toByte: Byte

Returns the value of this as a scala.Byte. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toByte
Definition Classes
ScalaNumericAnyConversions

def toChar: Char

Returns the value of this as a scala.Char. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toChar
Definition Classes
ScalaNumericAnyConversions

def toDouble: Double

Returns the value of this as a scala.Double. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toDouble
Definition Classes
ScalaNumericAnyConversions

def toFloat: Float

Returns the value of this as a scala.Float. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toFloat
Definition Classes
ScalaNumericAnyConversions

def toInt: Int

Returns the value of this as an scala.Int. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toInt
Definition Classes
ScalaNumericAnyConversions

def toLong: Long

Returns the value of this as a scala.Long. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toLong
Definition Classes
ScalaNumericAnyConversions

def toShort: Short

Returns the value of this as a scala.Short. This may involve rounding or truncation.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toShort
Definition Classes
ScalaNumericAnyConversions

def toString(): String

Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

returns

a String representation of the object.

Implicit
This member is added by an implicit conversion from Double tojava.lang.Double performed by method double2Double in scala.Predef.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: java.lang.Double).toString()
Definition Classes
Double → AnyRef → Any

def toString(): String

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Implicit
This member is added by an implicit conversion from Double toRichDouble performed by method doubleWrapper in scala.LowPriorityImplicits.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(double: RichDouble).toString()
Definition Classes
ProxyAny

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/Double.html