Scala 3
3.9.0-RC1-bin-20260423-5d6b9a4-NIGHTLY
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
DocsAPI
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL
Scala 3/scala/scala.math/Numeric/BigDecimalAsIfIntegral

BigDecimalAsIfIntegral

scala.math.Numeric.BigDecimalAsIfIntegral
See theBigDecimalAsIfIntegral companion object
trait BigDecimalAsIfIntegral extends BigDecimalIsConflicted, Integral[BigDecimal]

Attributes

Companion
object
Source
Numeric.scala
Graph
Supertypes
trait Equiv[BigDecimal]
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited classlikes

class IntegralOps(lhs: Integral.this.T) extends NumericOps

Attributes

Inherited from:
Integral
Source
Integral.scala
Supertypes
class Integral.this.NumericOps
class Object
trait Matchable
class Any
class NumericOps(lhs: Numeric.this.T)

Attributes

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

Value parameters

lhs

the left-hand side value for infix comparison operations

Attributes

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

Value members

Concrete methods

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

Attributes

Source
Numeric.scala
def rem(x: BigDecimal, y: BigDecimal): BigDecimal

Attributes

Source
Numeric.scala

Inherited methods

def abs(x: BigDecimal): BigDecimal

Attributes

Inherited from:
Numeric
Source
Numeric.scala
override def equiv(x: BigDecimal, y: BigDecimal): Boolean

Returns true if x == y in the ordering.

Returns true if x == y in the ordering.

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

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

Attributes

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

Returns true if x > y in the ordering.

Returns true if x > y in the ordering.

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

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

Returns true if x >= y in the ordering.

Returns true if x >= y in the ordering.

Value parameters

x

the first value to compare

y

the second value to compare

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.

Value parameters

other

the ordering to check

Attributes

Returns

true if other is the reverse of this ordering, false otherwise

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

Returns true if x < y in the ordering.

Returns true if x < y in the ordering.

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

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

Returns true if x <= y in the ordering.

Returns true if x <= y in the ordering.

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

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

Returns x if x >= y, otherwise y.

Returns x if x >= y, otherwise y.

Type parameters

U

a subtype of T, used to preserve the specific type in the return value

Value parameters

x

the first candidate value

y

the second candidate value

Attributes

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

Returns x if x <= y, otherwise y.

Returns x if x <= y, otherwise y.

Type parameters

U

a subtype of T, used to preserve the specific type in the return value

Value parameters

x

the first candidate value

y

the second candidate value

Attributes

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

Attributes

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

Attributes

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

Type parameters

U

the type of the values to be ordered

Value parameters

f

the function to extract a T value from a U value

Attributes

Returns

an Ordering[U] that orders values by applying f and comparing the results using this ordering

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

Attributes

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

Value parameters

other

an Ordering to use if this Ordering returns zero

Attributes

Returns

an Ordering[T] that uses this ordering first, falling back to other when values are equal

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: 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.

Type parameters

S

the type returned by the extraction function f

Value parameters

f

the function to extract a comparison key from a T value

ord

the implicit ordering for the extracted key type S

Attributes

Returns

an Ordering[T] that uses this ordering first, falling back to comparing by f when values are equal

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[BigDecimal]

Attributes

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

Attributes

Inherited from:
BigDecimalIsConflicted
Source
Numeric.scala
override def reverse: Ordering[BigDecimal]

Returns the opposite ordering of this one.

Returns 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

Returns

an Ordering[T] that compares elements in the reverse order of this ordering

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

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

Attributes

Inherited from:
Numeric
Source
Numeric.scala

Inherited and Abstract methods

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)

Value parameters

x

the first value to compare

y

the second value to compare

Attributes

Returns

a negative integer, zero, or a positive integer as x is less than, equal to, or greater than y

Inherited from:
Ordering
Source
Ordering.scala

Deprecated and Inherited methods

def signum(x: BigDecimal): Int

Attributes

Deprecated
[Since version 2.13.0] use `sign` method instead
Inherited from:
Numeric
Source
Numeric.scala

Implicits

Inherited implicits

implicit override def mkNumericOps(lhs: BigDecimal): IntegralOps

Attributes

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

Value parameters

lhs

the value to enrich with ordering operators

Attributes

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