Scala 3/API/scala.math/Integral

Integral

trait Integral[T] extends Numeric[T]
Companion
object
trait Numeric[T]
trait Ordering[T]
trait Equiv[T]
trait Comparator[T]
class Object
trait Matchable
class Any

Type members

Classlikes

class IntegralOps(lhs: T) extends NumericOps

Inherited classlikes

class NumericOps(lhs: T)
Inherited from
Numeric
class OrderingOps(lhs: T)

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.

Inherited from
Ordering

Value members

Abstract methods

def quot(x: T, y: T): T
def rem(x: T, y: T): T

Inherited methods

def abs(x: T): T
Inherited from
Numeric
def compare(x: T, y: T): 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)

Inherited from
Ordering
override def equiv(x: T, y: T): Boolean

Return true if x == y in the ordering.

Return true if x == y in the ordering.

Definition Classes
Inherited from
Ordering
def fromInt(x: Int): T
Inherited from
Numeric
override def gt(x: T, y: T): Boolean

Return true if x > y in the ordering.

Return true if x > y in the ordering.

Definition Classes
Inherited from
Ordering
override def gteq(x: T, y: T): Boolean

Return true if x >= y in the ordering.

Return true if x >= y in the ordering.

Definition Classes
Inherited from
Ordering
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.

Inherited from
Ordering
override def lt(x: T, y: T): Boolean

Return true if x < y in the ordering.

Return true if x < y in the ordering.

Definition Classes
Inherited from
Ordering
override def lteq(x: T, y: T): Boolean

Return true if x <= y in the ordering.

Return true if x <= y in the ordering.

Definition Classes
Inherited from
Ordering
def max[U <: T](x: U, y: U): U

Return x if x >= y, otherwise y.

Return x if x >= y, otherwise y.

Inherited from
Ordering
def min[U <: T](x: U, y: U): U

Return x if x <= y, otherwise y.

Return x if x <= y, otherwise y.

Inherited from
Ordering
def minus(x: T, y: T): T
Inherited from
Numeric
def negate(x: T): T
Inherited from
Numeric
def on[U](f: U => T): 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))
Inherited from
Ordering
def one: T
Inherited from
Numeric
def orElse(other: Ordering[T]): Ordering[T]

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.

Value Params
other

an Ordering to use if this Ordering returns zero

Example

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElse(Ordering.by[Pair, Int](_.b))
Inherited from
Ordering
def orElseBy[S](f: T => S)(ord: Ordering[S]): Ordering[T]

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.

Example

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElseBy[Int](_.b)
Inherited from
Ordering
def parseString(str: String): Option[T]
Inherited from
Numeric
def plus(x: T, y: T): T
Inherited from
Numeric
override def reverse: Ordering[T]

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
Inherited from
Ordering
def reversed(): Comparator[T]
Inherited from
Comparator
def sign(x: T): T
Inherited from
Numeric
def thenComparing[U <: Comparable[_ >: U <: `<FromJavaObject>`]](`x$0`: Function[_ >: T <: `<FromJavaObject>`, _ <: U]): Comparator[T]
Inherited from
Comparator
def thenComparing[U <: `<FromJavaObject>`](`x$0`: Function[_ >: T <: `<FromJavaObject>`, _ <: U], `x$1`: Comparator[_ >: U <: `<FromJavaObject>`]): Comparator[T]
Inherited from
Comparator
def thenComparing(`x$0`: Comparator[_ >: T <: `<FromJavaObject>`]): Comparator[T]
Inherited from
Comparator
def thenComparingDouble(`x$0`: ToDoubleFunction[_ >: T <: `<FromJavaObject>`]): Comparator[T]
Inherited from
Comparator
def thenComparingInt(`x$0`: ToIntFunction[_ >: T <: `<FromJavaObject>`]): Comparator[T]
Inherited from
Comparator
def thenComparingLong(`x$0`: ToLongFunction[_ >: T <: `<FromJavaObject>`]): Comparator[T]
Inherited from
Comparator
def times(x: T, y: T): T
Inherited from
Numeric
def toDouble(x: T): Double
Inherited from
Numeric
def toFloat(x: T): Float
Inherited from
Numeric
def toInt(x: T): Int
Inherited from
Numeric
def toLong(x: T): Long
Inherited from
Numeric
def tryCompare(x: T, y: T): Option[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).

Inherited from
Ordering
def zero: T
Inherited from
Numeric

Deprecated and Inherited methods

@deprecated("use `sign` method instead", since = "2.13.0")
def signum(x: T): Int
Deprecated
[Since version 2.13.0]
Inherited from
Numeric

Implicits

Implicits

implicit override def mkNumericOps(lhs: T): IntegralOps
Definition Classes

Inherited implicits

implicit def mkOrderingOps(lhs: T): 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.

Inherited from
Ordering