final class RichDouble extends AnyVal with FractionalProxy[Double]
- Source
- RichDouble.scala
- Alphabetic
- By Inheritance
- RichDouble
- FractionalProxy
- RangedProxy
- ScalaNumberProxy
- OrderedProxy
- Ordered
- Comparable
- Typed
- Proxy
- ScalaNumericAnyConversions
- AnyVal
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
type
ResultWithoutStep = Partial[Double, NumericRange[Double]]
In order to supply predictable ranges, we require an Integral[T] which provides us with discrete operations on the (otherwise fractional) T.
In order to supply predictable ranges, we require an Integral[T] which provides us with discrete operations on the (otherwise fractional) T. See Numeric.DoubleAsIfIntegral for an example.
- Definition Classes
- FractionalProxy → RangedProxy
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
trueif !(this == that), false otherwise.
- Definition Classes
- Any
-
final
def
##(): Int
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept for boxed numeric types andnull. 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
a hash value consistent with ==
- Definition Classes
- Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from RichDouble to any2stringadd[RichDouble] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (RichDouble, B)
- Implicit
- This member is added by an implicit conversion from RichDouble to ArrowAssoc[RichDouble] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
<(that: Double): Boolean
Returns true if
thisis less thanthatReturns true if
thisis less thanthat- Definition Classes
- Ordered
-
def
<=(that: Double): Boolean
Returns true if
thisis less than or equal tothat.Returns true if
thisis less than or equal tothat.- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
Test two objects for equality.
Test two objects for equality. The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
- Any
-
def
>(that: Double): Boolean
Returns true if
thisis greater thanthat.Returns true if
thisis greater thanthat.- Definition Classes
- Ordered
-
def
>=(that: Double): Boolean
Returns true if
thisis greater than or equal tothat.Returns true if
thisis greater than or equal tothat.- Definition Classes
- Ordered
-
def
abs: Double
Returns the absolute value of
this.Returns the absolute value of
this.- Definition Classes
- RichDouble → ScalaNumberProxy
-
final
def
asInstanceOf[T0]: T0
Cast the receiver object to be of type
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 aClassCastExceptionat runtime, while the expressionList(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
ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
-
def
byteValue(): Byte
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
- def ceil: Double
-
def
compare(y: Double): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.Implement this method to determine how instances of A will be sorted.
Returns
xwhere:x < 0whenthis < thatx == 0whenthis == thatx > 0whenthis > that
- Definition Classes
- OrderedProxy → Ordered
-
def
compareTo(that: Double): Int
Result of comparing
thiswith operandthat.Result of comparing
thiswith operandthat.- Definition Classes
- Ordered → Comparable
-
def
doubleValue(): Double
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
ensuring(cond: (RichDouble) ⇒ Boolean, msg: ⇒ Any): RichDouble
- Implicit
- This member is added by an implicit conversion from RichDouble to Ensuring[RichDouble] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (RichDouble) ⇒ Boolean): RichDouble
- Implicit
- This member is added by an implicit conversion from RichDouble to Ensuring[RichDouble] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): RichDouble
- Implicit
- This member is added by an implicit conversion from RichDouble to Ensuring[RichDouble] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): RichDouble
- Implicit
- This member is added by an implicit conversion from RichDouble to Ensuring[RichDouble] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
floatValue(): Float
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
- def floor: Double
-
def
formatted(fmtstr: String): String
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from RichDouble to Predef.StringFormat[RichDouble] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
def
getClass(): Class[_ <: AnyVal]
Returns the runtime class representation of the object.
-
def
intValue(): Int
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
integralNum: DoubleAsIfIntegral.type
- Attributes
- protected
- Definition Classes
- RichDouble → FractionalProxy
- def isInfinity: Boolean
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0.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 returnfalse, while the expressionList(1).isInstanceOf[List[String]]will returntrue. 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
trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
- Any
- def isNaN: Boolean
- def isNegInfinity: Boolean
- def isPosInfinity: Boolean
-
def
isValidByte: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- RichDouble → ScalaNumericAnyConversions
-
def
isValidChar: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- RichDouble → ScalaNumericAnyConversions
-
def
isValidInt: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- RichDouble → ScalaNumericAnyConversions
-
def
isValidShort: Boolean
Returns
trueiff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse.Returns
trueiff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse.- Definition Classes
- RichDouble → ScalaNumericAnyConversions
-
def
isWhole(): Boolean
- returns
trueif this number has no decimal component,falseotherwise.
- Definition Classes
- RichDouble → FractionalProxy → ScalaNumericAnyConversions
-
def
longValue(): Long
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
max(that: Double): Double
Returns
thisifthis > thatorthatotherwise.Returns
thisifthis > thatorthatotherwise.- Definition Classes
- RichDouble → ScalaNumberProxy
-
def
min(that: Double): Double
Returns
thisifthis < thatorthatotherwise.Returns
thisifthis < thatorthatotherwise.- Definition Classes
- RichDouble → ScalaNumberProxy
-
def
num: DoubleIsFractional.type
- Attributes
- protected
- Definition Classes
- RichDouble → FractionalProxy → ScalaNumberProxy
-
def
ord: math.Ordering.Double.type
- Attributes
- protected
- Definition Classes
- RichDouble → OrderedProxy
- def round: Long
-
val
self: Double
- Definition Classes
- RichDouble → Typed → Proxy
-
def
shortValue(): Short
- Definition Classes
- RichDouble → ScalaNumberProxy → ScalaNumericAnyConversions
-
def
signum: Int
Returns the signum of
this.Returns the signum of
this.- Definition Classes
- RichDouble → ScalaNumberProxy
-
def
toByte: Byte
Returns the value of this as a scala.Byte.
Returns the value of this as a scala.Byte. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toChar: Char
Returns the value of this as a scala.Char.
Returns the value of this as a scala.Char. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toDegrees: Double
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
- returns
the measurement of the angle x in degrees.
-
def
toDouble: Double
Returns the value of this as a scala.Double.
Returns the value of this as a scala.Double. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toFloat: Float
Returns the value of this as a scala.Float.
Returns the value of this as a scala.Float. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toInt: Int
Returns the value of this as an scala.Int.
Returns the value of this as an scala.Int. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toLong: Long
Returns the value of this as a scala.Long.
Returns the value of this as a scala.Long. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toRadians: Double
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
- returns
the measurement of the angle x in radians.
-
def
toShort: Short
Returns the value of this as a scala.Short.
Returns the value of this as a scala.Short. This may involve rounding or truncation.
- Definition Classes
- ScalaNumericAnyConversions
-
def
toString(): String
Returns a string representation of the object.
-
def
underlying(): AnyRef
- Definition Classes
- ScalaNumberProxy → ScalaNumericAnyConversions
-
def
unifiedPrimitiveEquals(x: Any): Boolean
Should only be called after all known non-primitive types have been excluded.
Should only be called after all known non-primitive types have been excluded. This method won't dispatch anywhere else after checking against the primitives to avoid infinite recursion between equals and this on unknown "Number" variants.
Additionally, this should only be called if the numeric type is happy to be converted to Long, Float, and Double. If for instance a BigInt much larger than the Long range is sent here, it will claim equality with whatever Long is left in its lower 64 bits. Or a BigDecimal with more precision than Double can hold: same thing. There's no way given the interface available here to prevent this error.
- Attributes
- protected
- Definition Classes
- ScalaNumericAnyConversions
-
def
unifiedPrimitiveHashcode(): Int
- Attributes
- protected
- Definition Classes
- ScalaNumericAnyConversions
-
def
→[B](y: B): (RichDouble, B)
- Implicit
- This member is added by an implicit conversion from RichDouble to ArrowAssoc[RichDouble] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Deprecated Value Members
-
def
to(end: Double, step: Double): Inclusive[Double]
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
to(end: Double): ResultWithoutStep
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
until(end: Double, step: Double): Exclusive[Double]
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
-
def
until(end: Double): ResultWithoutStep
- Definition Classes
- FractionalProxy → RangedProxy
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.6) use BigDecimal range instead
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.collection.parallel.immutable- Immutable, parallel data-structures such asParVector,ParRange,ParHashMaporParHashSetscala.collection.parallel.mutable- Mutable, parallel data-structures such asParArray,ParHashMap,ParTrieMaporParHashSetscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.sys- Interaction with other processes and the operating systemscala.util.matching- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect- Scala's reflection API (scala-reflect.jar)scala.xml- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.