Packages

t

scala.math.Ordering

BigDecimalOrdering

trait BigDecimalOrdering extends Ordering[BigDecimal]

Source
Ordering.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigDecimalOrdering
  2. Ordering
  3. PartialOrdering
  4. Equiv
  5. Serializable
  6. Comparator
  7. AnyRef
  8. 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. Protected

Type Members

  1. 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. def <(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] is in scope.
    Definition Classes
    Ordered
  2. def <=(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] is in scope.
    Definition Classes
    Ordered
  3. def >(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] is in scope.
    Definition Classes
    Ordered
  4. def >=(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] is in scope.
    Definition Classes
    Ordered
  5. 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
  6. def compareTo(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] is in scope.
    Definition Classes
    Ordered → Comparable
  7. 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
  8. 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
  9. 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
  10. 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
  11. 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
  12. 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
  13. 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
  14. 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
  15. 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
  16. 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
  17. 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))
  18. 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)
  19. 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
  20. def reversed(): Comparator[BigDecimal]
    Definition Classes
    Comparator
  21. def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: BigDecimal <: AnyRef, _ <: U]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  22. def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: BigDecimal <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  23. def thenComparing(arg0: Comparator[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  24. def thenComparingDouble(arg0: ToDoubleFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  25. def thenComparingInt(arg0: ToIntFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  26. def thenComparingLong(arg0: ToLongFunction[_ >: BigDecimal <: AnyRef]): Comparator[BigDecimal]
    Definition Classes
    Comparator
  27. 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

Shadowed Implicit Value Members

  1. def compare(that: BigDecimalOrdering): 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 BigDecimalOrdering toOrdered[BigDecimalOrdering] performed by method orderingToOrdered in scala.math.Ordered.This conversion will take place only if an implicit value of type Ordering[BigDecimalOrdering] 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:
    (bigDecimalOrdering: Ordered[BigDecimalOrdering]).compare(that)
    Definition Classes
    Ordered