Scala Standard Library2.12.2-20170504-135222-21d12e9 < Back
 

# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
    - `scala.collection.parallel.immutable` - Immutable, parallel data-structures such as `ParVector`, `ParRange`, `ParHashMap` or `ParHashSet`
    - `scala.collection.parallel.mutable` - Mutable, parallel data-structures such as `ParArray`, `ParHashMap`, `ParTrieMap` or `ParHashSet`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other 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.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package math

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  All methods forward to java.lang.Math unless otherwise noted.

  Definition Classes
    scala
  See also

    java.lang.Math

-  object Numeric extends Serializable

  Definition Classes
    math
  Since

    2.8

- BigDecimalAsIfIntegral
- BigDecimalIsConflicted
- BigDecimalIsFractional
- BigIntIsIntegral
- ByteIsIntegral
- CharIsIntegral
- DoubleAsIfIntegral
- DoubleIsConflicted
- DoubleIsFractional
- ExtraImplicits
- FloatAsIfIntegral
- FloatIsConflicted
- FloatIsFractional
- Implicits
- IntIsIntegral
- LongIsIntegral
- ShortIsIntegral

t

scala.math.Numeric

# BigDecimalIsFractional 

###
Companion object BigDecimalIsFractional

#### trait BigDecimalIsFractional extends BigDecimalIsConflicted with Fractional[BigDecimal]

Source
  Numeric.scala

Linear Supertypes
Fractional[BigDecimal], BigDecimalIsConflicted, Numeric[BigDecimal], Ordering[BigDecimal], PartialOrdering[BigDecimal], Equiv[BigDecimal], Serializable, java.io.Serializable, Comparator[BigDecimal], AnyRef, Any
Known Subclasses
BigDecimalIsFractional
Type Hierarchy
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BigDecimalIsFractional
2. Fractional
3. BigDecimalIsConflicted
4. Numeric
5. Ordering
6. PartialOrdering
7. Equiv
8. Serializable
9. Serializable
10. Comparator
11. AnyRef
12. Any

Implicitly

1. by orderingToOrdered
2. by any2stringadd
3. by StringFormat
4. by Ensuring
5. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Type Members

1.  class FractionalOps extends Ops
   Definition Classes
     Fractional
2.  class Ops extends AnyRef
   Definition Classes
     Numeric

### Abstract Value Members

1.  abstract def compare(x: BigDecimal, y: BigDecimal): Int

   Returns an integer whose sign communicates how x compares to y.

   Returns an integer whose sign communicates how x compares to y.

   The result sign has the following meaning:

   - negative if x < y
   - positive if x > y
   - zero otherwise (if x == y)
   Definition Classes
     Ordering → Comparator

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Definition Classes
     AnyRef → Any
2.  final def ##(): Int

   Equivalent to `x.hashCode` except for boxed numeric types and `null`.

   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
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to any2stringadd[BigDecimalIsFractional] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (BigDecimalIsFractional, B)
   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to ArrowAssoc[BigDecimalIsFractional] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  def <(that: BigDecimalIsFractional): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
   Definition Classes
     Ordered
6.  def <=(that: BigDecimalIsFractional): Boolean

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

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

   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
   Definition Classes
     Ordered
7.  final def ==(arg0: Any): Boolean

   The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

   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
     AnyRef → Any
8.  def >(that: BigDecimalIsFractional): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
   Definition Classes
     Ordered
9.  def >=(that: BigDecimalIsFractional): Boolean

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

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

   Implicit
     This member is added by an implicit conversion from BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
   Definition Classes
     Ordered
10.  def abs(x: BigDecimal): BigDecimal
    Definition Classes
      Numeric
11.  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 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`.

12.  def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
    Note

      not specified by SLS as a member of AnyRef

13.  def compareTo(that: BigDecimalIsFractional): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
    Definition Classes
      Ordered → Comparable
14.  def div(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
      BigDecimalIsFractional → Fractional
15.  def ensuring(cond: (BigDecimalIsFractional) ⇒ Boolean, msg: ⇒ Any): BigDecimalIsFractional
    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to Ensuring[BigDecimalIsFractional] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  def ensuring(cond: (BigDecimalIsFractional) ⇒ Boolean): BigDecimalIsFractional
    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to Ensuring[BigDecimalIsFractional] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
17.  def ensuring(cond: Boolean, msg: ⇒ Any): BigDecimalIsFractional
    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to Ensuring[BigDecimalIsFractional] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
18.  def ensuring(cond: Boolean): BigDecimalIsFractional
    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to Ensuring[BigDecimalIsFractional] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
19.  final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (`that`) is a reference to the receiver object (`this`).

    Tests whether the argument (`that`) is a reference to the receiver object (`this`).

    The `eq` method implements an equivalence relation on non-null instances of `AnyRef`, and has three additional properties:

    - It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`.
    - For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`.
    - `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    Definition Classes
      AnyRef
20.  def equals(arg0: Any): Boolean

    The equality method for reference types.

    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.

    Definition Classes
      AnyRef → Any
21.  def equiv(x: BigDecimal, y: BigDecimal): Boolean

    Return true if `x` == `y` in the ordering.

    Return true if `x` == `y` in the ordering.

    Definition Classes
      Ordering → PartialOrdering → Equiv
22.  def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the `finalize` method is invoked, as well as the interaction between `finalize` and non-local returns and exceptions, are all platform dependent.

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
    Note

      not specified by SLS as a member of AnyRef

23.  def formatted(fmtstr: String): String

    Returns string formatted according to given `format` 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 BigDecimalIsFractional to StringFormat[BigDecimalIsFractional] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
24.  def fromInt(x: Int): BigDecimal
    Definition Classes
      BigDecimalIsConflicted → Numeric
25.  final def getClass(): Class[_]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

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

    Definition Classes
      AnyRef → Any
26.  def gt(x: BigDecimal, y: BigDecimal): Boolean

    Return true if `x` > `y` in the ordering.

    Return true if `x` > `y` in the ordering.

    Definition Classes
      Ordering → PartialOrdering
27.  def gteq(x: BigDecimal, y: BigDecimal): Boolean

    Return true if `x` >= `y` in the ordering.

    Return true if `x` >= `y` in the ordering.

    Definition Classes
      Ordering → PartialOrdering
28.  def hashCode(): Int

    The hashCode method for reference types.

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

    returns

      the hash code value for this object.

    Definition Classes
      AnyRef → Any
29.  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 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
30.  def lt(x: BigDecimal, y: BigDecimal): Boolean

    Return true if `x` < `y` in the ordering.

    Return true if `x` < `y` in the ordering.

    Definition Classes
      Ordering → PartialOrdering
31.  def lteq(x: BigDecimal, y: BigDecimal): Boolean

    Return true if `x` <= `y` in the ordering.

    Return true if `x` <= `y` in the ordering.

    Definition Classes
      Ordering → PartialOrdering
32.  def max(x: BigDecimal, y: BigDecimal): BigDecimal

    Return `x` if `x` >= `y`, otherwise `y`.

    Return `x` if `x` >= `y`, otherwise `y`.

    Definition Classes
      Ordering
33.  def min(x: BigDecimal, y: BigDecimal): BigDecimal

    Return `x` if `x` <= `y`, otherwise `y`.

    Return `x` if `x` <= `y`, otherwise `y`.

    Definition Classes
      Ordering
34.  def minus(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
      BigDecimalIsConflicted → Numeric
35.  implicit def mkNumericOps(lhs: BigDecimal): FractionalOps
    Definition Classes
      Fractional → Numeric
36.  implicit def mkOrderingOps(lhs: BigDecimal): BigDecimalIsFractional.Ops

    This implicit method augments `T` with the comparison operators defined in `scala.math.Ordering.Ops`.

    This implicit method augments `T` with the comparison operators defined in `scala.math.Ordering.Ops`.

    Definition Classes
      Ordering
37.  final def ne(arg0: AnyRef): Boolean

    Equivalent to `!(this eq that)`.

    Equivalent to `!(this eq that)`.

    returns

      `true` if the argument is not a reference to the receiver object; `false` otherwise.

    Definition Classes
      AnyRef
38.  def negate(x: BigDecimal): BigDecimal
    Definition Classes
      BigDecimalIsConflicted → Numeric
39.  final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
      AnyRef
    Note

      not specified by SLS as a member of AnyRef

40.  final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
      AnyRef
    Note

      not specified by SLS as a member of AnyRef

41.  def on[U](f: (U) ⇒ BigDecimal): Ordering[U]

    Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

    Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

        def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))

    Definition Classes
      Ordering
42.  def one: BigDecimal
    Definition Classes
      Numeric
43.  def plus(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
      BigDecimalIsConflicted → Numeric
44.  def reverse: Ordering[BigDecimal]

    Return the opposite ordering of this one.

    Return the opposite ordering of this one.

    Definition Classes
      Ordering → PartialOrdering
45.  def reversed(): Comparator[BigDecimal]
    Definition Classes
      Comparator
46.  def signum(x: BigDecimal): Int
    Definition Classes
      Numeric
47.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
48.  def thenComparing[U <: Comparable[_ >: U]](arg0: java.util.function.Function[_ >: BigDecimal, _ <: U]): Comparator[BigDecimal]
    Definition Classes
      Comparator
49.  def thenComparing[U](arg0: java.util.function.Function[_ >: BigDecimal, _ <: U], arg1: Comparator[_ >: U]): Comparator[BigDecimal]
    Definition Classes
      Comparator
50.  def thenComparing(arg0: Comparator[_ >: BigDecimal]): Comparator[BigDecimal]
    Definition Classes
      Comparator
51.  def thenComparingDouble(arg0: ToDoubleFunction[_ >: BigDecimal]): Comparator[BigDecimal]
    Definition Classes
      Comparator
52.  def thenComparingInt(arg0: ToIntFunction[_ >: BigDecimal]): Comparator[BigDecimal]
    Definition Classes
      Comparator
53.  def thenComparingLong(arg0: ToLongFunction[_ >: BigDecimal]): Comparator[BigDecimal]
    Definition Classes
      Comparator
54.  def times(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
      BigDecimalIsConflicted → Numeric
55.  def toDouble(x: BigDecimal): Double
    Definition Classes
      BigDecimalIsConflicted → Numeric
56.  def toFloat(x: BigDecimal): Float
    Definition Classes
      BigDecimalIsConflicted → Numeric
57.  def toInt(x: BigDecimal): Int
    Definition Classes
      BigDecimalIsConflicted → Numeric
58.  def toLong(x: BigDecimal): Long
    Definition Classes
      BigDecimalIsConflicted → Numeric
59.  def toString(): String

    Creates a String representation of this object.

    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.

    Definition Classes
      AnyRef → Any
60.  def tryCompare(x: BigDecimal, y: BigDecimal): Some[Int]

    Returns whether a comparison between `x` and `y` is defined, and if so the result of `compare(x, y)`.

    Returns whether a comparison between `x` and `y` is defined, and if so the result of `compare(x, y)`.

    Definition Classes
      Ordering → PartialOrdering
61.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
62.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
63.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
64.  def zero: BigDecimal
    Definition Classes
      Numeric
65.  def →[B](y: B): (BigDecimalIsFractional, B)
    Implicit
      This member is added by an implicit conversion from BigDecimalIsFractional to ArrowAssoc[BigDecimalIsFractional] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1.  def compare(that: BigDecimalIsFractional): Int

   Result of comparing `this` with operand `that`.

   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 BigDecimalIsFractional to Ordered[BigDecimalIsFractional] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[BigDecimalIsFractional] is in scope.
   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:

         (bigDecimalIsFractional: Ordered[BigDecimalIsFractional]).compare(that)

   Definition Classes
     Ordered

### Inherited from Fractional[BigDecimal]

### Inherited from BigDecimalIsConflicted

### Inherited from Numeric[BigDecimal]

### Inherited from Ordering[BigDecimal]

### Inherited from PartialOrdering[BigDecimal]

### Inherited from Equiv[BigDecimal]

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from Comparator[BigDecimal]

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered from BigDecimalIsFractional to Ordered[BigDecimalIsFractional]

### Inherited by implicit conversion any2stringadd from BigDecimalIsFractional to any2stringadd[BigDecimalIsFractional]

### Inherited by implicit conversion StringFormat from BigDecimalIsFractional to StringFormat[BigDecimalIsFractional]

### Inherited by implicit conversion Ensuring from BigDecimalIsFractional to Ensuring[BigDecimalIsFractional]

### Inherited by implicit conversion ArrowAssoc from BigDecimalIsFractional to ArrowAssoc[BigDecimalIsFractional]

### Ungrouped