Scala 3
3.3.1
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
API
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL
Scala 3/scala/scala.math/Integral

Integral

scala.math.Integral
See theIntegral companion object
trait Integral[T] extends Numeric[T]

Attributes

Companion
object
Source
Integral.scala
Graph
Supertypes
trait Numeric[T]
trait Ordering[T]
trait PartialOrdering[T]
trait Equiv[T]
trait Serializable
trait Comparator[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
object IntIsIntegral
Show all

Members list

Type members

Classlikes

class IntegralOps(lhs: T) extends NumericOps

Attributes

Source
Integral.scala
Supertypes
class NumericOps
class Object
trait Matchable
class Any

Inherited classlikes

class NumericOps(lhs: T)

Attributes

Inherited from:
Numeric
Source
Numeric.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class IntegralOps
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.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
Supertypes
class Object
trait Matchable
class Any

Value members

Abstract methods

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

Attributes

Source
Integral.scala
def rem(x: T, y: T): T

Attributes

Source
Integral.scala

Inherited methods

def abs(x: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
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)

Attributes

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

Return true if x == y in the ordering.

Return true if x == y in the ordering.

Attributes

Definition Classes
Inherited from:
Ordering
Source
Ordering.scala
def fromInt(x: Int): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
override def gt(x: T, y: T): Boolean

Return true if x > y in the ordering.

Return true if x > y in the ordering.

Attributes

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

Return true if x >= y in the ordering.

Return true if x >= y in the ordering.

Attributes

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

Attributes

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

Return true if x < y in the ordering.

Return true if x < y in the ordering.

Attributes

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

Return true if x <= y in the ordering.

Return true if x <= y in the ordering.

Attributes

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

Return x if x >= y, otherwise y.

Return x if x >= y, otherwise y.

Attributes

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

Return x if x <= y, otherwise y.

Return x if x <= y, otherwise y.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
def minus(x: T, y: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def negate(x: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
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))

Attributes

Inherited from:
Ordering
Source
Ordering.scala
def one: T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
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 parameters

other

an Ordering to use if this Ordering returns zero

Attributes

Example 

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElse(Ordering.by[Pair, Int](_.b))
Inherited from:
Ordering
Source
Ordering.scala
def orElseBy[S](f: T => S)(implicit 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.

Attributes

Example 

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElseBy[Int](_.b)
Inherited from:
Ordering
Source
Ordering.scala
def parseString(str: String): Option[T]

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def plus(x: T, y: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
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).

Attributes

Definition Classes
Inherited from:
Ordering
Source
Ordering.scala
def reversed(): Comparator[T]

Attributes

Inherited from:
Comparator
def sign(x: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x$0: Function[_ >: T <: <FromJavaObject>, _ <: U]): Comparator[T]

Attributes

Inherited from:
Comparator
def thenComparing[U <: <FromJavaObject>](x$0: Function[_ >: T <: <FromJavaObject>, _ <: U], x$1: Comparator[_ >: U <: <FromJavaObject>]): Comparator[T]

Attributes

Inherited from:
Comparator
def thenComparing(x$0: Comparator[_ >: T <: <FromJavaObject>]): Comparator[T]

Attributes

Inherited from:
Comparator
def thenComparingDouble(x$0: ToDoubleFunction[_ >: T <: <FromJavaObject>]): Comparator[T]

Attributes

Inherited from:
Comparator
def thenComparingInt(x$0: ToIntFunction[_ >: T <: <FromJavaObject>]): Comparator[T]

Attributes

Inherited from:
Comparator
def thenComparingLong(x$0: ToLongFunction[_ >: T <: <FromJavaObject>]): Comparator[T]

Attributes

Inherited from:
Comparator
def times(x: T, y: T): T

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def toDouble(x: T): Double

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def toFloat(x: T): Float

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def toInt(x: T): Int

Attributes

Inherited from:
Numeric
Source
Numeric.scala
def toLong(x: T): Long

Attributes

Inherited from:
Numeric
Source
Numeric.scala
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).

Attributes

Inherited from:
Ordering
Source
Ordering.scala
def zero: T

Attributes

Inherited from:
Numeric
Source
Numeric.scala

Deprecated and Inherited methods

def signum(x: T): Int

Attributes

Deprecated
[Since version 2.13.0]
Inherited from:
Numeric
Source
Numeric.scala

Implicits

Implicits

implicit override def mkNumericOps(lhs: T): IntegralOps

Attributes

Definition Classes
Source
Integral.scala

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.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL