Packages

implicit object BigDecimalIsFractional extends BigDecimalIsFractional with BigDecimalOrdering

Source
Numeric.scala
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigDecimalIsFractional
  2. BigDecimalOrdering
  3. BigDecimalIsFractional
  4. Fractional
  5. BigDecimalIsConflicted
  6. Numeric
  7. Ordering
  8. PartialOrdering
  9. Equiv
  10. Serializable
  11. Comparator
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class FractionalOps extends NumericOps
    Definition Classes
    Fractional
  2. class NumericOps extends AnyRef
    Definition Classes
    Numeric
  3. class OrderingOps extends AnyRef

    This inner class defines comparison operators available for T.

    This inner class defines comparison operators available for T.

    It can't extend AnyVal because it is not a top-level class or a member of a statically accessible object.

    Definition Classes
    Ordering

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. 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
  4. def abs(x: BigDecimal): BigDecimal
    Definition Classes
    Numeric
  5. 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.

  6. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  7. 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
    BigDecimalOrderingOrdering → Comparator
  8. def div(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
    BigDecimalIsFractionalFractional
  9. 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
  10. def equals(arg0: AnyRef): 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
  11. 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
    OrderingPartialOrderingEquiv
  12. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
    Note

    not specified by SLS as a member of AnyRef

  13. def fromInt(x: Int): BigDecimal
    Definition Classes
    BigDecimalIsConflictedNumeric
  14. final def getClass(): Class[_ <: AnyRef]

    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
    Annotations
    @native()
  15. 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
    OrderingPartialOrdering
  16. 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
    OrderingPartialOrdering
  17. 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
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

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

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  19. def isReverseOf(other: Ordering[_]): Boolean

    Returns whether or not the other ordering is the opposite ordering of this one.

    Returns whether or not the other ordering is the opposite ordering of this one.

    Equivalent to other == this.reverse.

    Implementations should only override this method if they are overriding reverse as well.

    Definition Classes
    Ordering
  20. 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
    OrderingPartialOrdering
  21. 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
    OrderingPartialOrdering
  22. def max[U <: BigDecimal](x: U, y: U): U

    Return x if x >= y, otherwise y.

    Return x if x >= y, otherwise y.

    Definition Classes
    Ordering
  23. def min[U <: BigDecimal](x: U, y: U): U

    Return x if x <= y, otherwise y.

    Return x if x <= y, otherwise y.

    Definition Classes
    Ordering
  24. def minus(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
    BigDecimalIsConflictedNumeric
  25. implicit def mkNumericOps(lhs: BigDecimal): FractionalOps
    Definition Classes
    FractionalNumeric
  26. implicit def mkOrderingOps(lhs: BigDecimal): OrderingOps

    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
  27. 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
  28. def negate(x: BigDecimal): BigDecimal
    Definition Classes
    BigDecimalIsConflictedNumeric
  29. 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
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  30. 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
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  31. 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
  32. def one: BigDecimal
    Definition Classes
    Numeric
  33. def orElse(other: Ordering[BigDecimal]): Ordering[BigDecimal]

    Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.

    Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.

    other

    an Ordering to use if this Ordering returns zero

    Definition Classes
    Ordering
    Example:
    1. case class Pair(a: Int, b: Int)
      
      val pairOrdering = Ordering.by[Pair, Int](_.a)
                                 .orElse(Ordering.by[Pair, Int](_.b))
  34. def orElseBy[S](f: (BigDecimal) => S)(implicit ord: Ordering[S]): Ordering[BigDecimal]

    Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:

    Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:

    Ordering[S].compare(f(x), f(y))

    This function is equivalent to passing the result of Ordering.by(f) to orElse.

    Definition Classes
    Ordering
    Example:
    1. case class Pair(a: Int, b: Int)
      
      val pairOrdering = Ordering.by[Pair, Int](_.a)
                                 .orElseBy[Int](_.b)
  35. def parseString(str: String): Option[BigDecimal]
    Definition Classes
    BigDecimalIsConflictedNumeric
  36. def plus(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
    BigDecimalIsConflictedNumeric
  37. def reverse: Ordering[BigDecimal]

    Return the opposite ordering of this one.

    Return the opposite ordering of this one.

    Implementations overriding this method MUST override isReverseOf as well if they change the behavior at all (for example, caching does not require overriding it).

    Definition Classes
    OrderingPartialOrdering
  38. def reversed(): Comparator[BigDecimal]
    Definition Classes
    Comparator
  39. def sign(x: BigDecimal): BigDecimal
    Definition Classes
    Numeric
  40. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  41. def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: BigDecimal <: AnyRef, _ <: U]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  42. def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: BigDecimal <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  43. def thenComparing(arg0: Comparator[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  44. def thenComparingDouble(arg0: ToDoubleFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  45. def thenComparingInt(arg0: ToIntFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  46. def thenComparingLong(arg0: ToLongFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  47. def times(x: BigDecimal, y: BigDecimal): BigDecimal
    Definition Classes
    BigDecimalIsConflictedNumeric
  48. def toDouble(x: BigDecimal): Double
    Definition Classes
    BigDecimalIsConflictedNumeric
  49. def toFloat(x: BigDecimal): Float
    Definition Classes
    BigDecimalIsConflictedNumeric
  50. def toInt(x: BigDecimal): Int
    Definition Classes
    BigDecimalIsConflictedNumeric
  51. def toLong(x: BigDecimal): Long
    Definition Classes
    BigDecimalIsConflictedNumeric
  52. 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
  53. 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
    OrderingPartialOrdering
  54. final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  55. final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  56. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  57. def zero: BigDecimal
    Definition Classes
    Numeric

Deprecated Value Members

  1. def signum(x: BigDecimal): Int
    Definition Classes
    Numeric
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) use sign method instead

Inherited from BigDecimalOrdering

Inherited from BigDecimalIsFractional

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 java.io.Serializable

Inherited from Comparator[BigDecimal]

Inherited from AnyRef

Inherited from Any

Ungrouped