given_ArchimedeanField_BigDecimal
Attributes
- Graph
-
- Supertypes
-
trait ArchimedeanField[BigDecimal]trait OrderedField[BigDecimal]trait Field[BigDecimal]trait ArchimedeanDifferenceSemifield[BigDecimal]trait OrderedDifferenceSemifield[BigDecimal]trait DifferenceSemifield[BigDecimal]trait ArchimedeanSemifield[BigDecimal]trait OrderedSemifield[BigDecimal]trait Semifield[BigDecimal]trait ArchimedeanMultiplicativeGroup[BigDecimal]trait OrderedMultiplicativeGroup[BigDecimal]trait MultiplicativeGroup[BigDecimal]trait ArchimedeanMultiplicativeInverse[BigDecimal]trait OrderedMultiplicativeInverse[BigDecimal]trait MultiplicativeInverse[BigDecimal]trait ArchimedeanQuotientRing[BigDecimal]trait OrderedQuotientRing[BigDecimal]trait QuotientRing[BigDecimal]trait ArchimedeanQuotientDifferenceSemiring[BigDecimal]trait OrderedQuotientDifferenceSemiring[BigDecimal]trait QuotientDifferenceSemiring[BigDecimal]trait ArchimedeanQuotientSemiring[BigDecimal]trait OrderedQuotientSemiring[BigDecimal]trait QuotientSemiring[BigDecimal]trait ArchimedeanQuotientMonoid[BigDecimal]trait OrderedQuotientMonoid[BigDecimal]trait QuotientMonoid[BigDecimal]trait ArchimedeanQuotientSemigroup[BigDecimal]trait OrderedQuotientSemigroup[BigDecimal]trait QuotientSemigroup[BigDecimal]trait ArchimedeanQuotient[BigDecimal]trait OrderedQuotient[BigDecimal]trait Quotient[BigDecimal]trait ArchimedeanRing[BigDecimal]trait OrderedRing[BigDecimal]trait Ring[BigDecimal]trait ArchimedeanDifferenceSemiring[BigDecimal]trait OrderedDifferenceSemiring[BigDecimal]trait DifferenceSemiring[BigDecimal]trait ArchimedeanSemiring[BigDecimal]trait OrderedSemiring[BigDecimal]trait Semiring[BigDecimal]trait ArchimedeanMultiplicativeMonoid[BigDecimal]trait OrderedMultiplicativeMonoid[BigDecimal]trait MultiplicativeMonoid[BigDecimal]trait ArchimedeanMultiplicativeIdentity[BigDecimal]trait OrderedMultiplicativeIdentity[BigDecimal]trait MultiplicativeIdentity[BigDecimal]trait ArchimedeanPseudoring[BigDecimal]trait OrderedPseudoring[BigDecimal]trait Pseudoring[BigDecimal]trait ArchimedeanMultiplicativeSemigroup[BigDecimal]trait OrderedMultiplicativeSemigroup[BigDecimal]trait MultiplicativeSemigroup[BigDecimal]trait ArchimedeanMultiplicativeMagma[BigDecimal]trait OrderedMultiplicativeMagma[BigDecimal]trait MultiplicativeMagma[BigDecimal]trait ArchimedeanAdditiveGroup[BigDecimal]trait OrderedAdditiveGroup[BigDecimal]trait AdditiveGroup[BigDecimal]trait ArchimedeanAdditiveInverse[BigDecimal]trait OrderedAdditiveInverse[BigDecimal]trait AdditiveInverse[BigDecimal]trait ArchimedeanDifferenceMonoid[BigDecimal]trait OrderedDifferenceMonoid[BigDecimal]trait DifferenceMonoid[BigDecimal]trait ArchimedeanAdditiveMonoid[BigDecimal]trait OrderedAdditiveMonoid[BigDecimal]trait AdditiveMonoid[BigDecimal]trait ArchimedeanAdditiveIdentity[BigDecimal]trait OrderedAdditiveIdentity[BigDecimal]trait AdditiveIdentity[BigDecimal]trait ArchimedeanDifferenceSemigroup[BigDecimal]trait OrderedDifferenceSemigroup[BigDecimal]trait DifferenceSemigroup[BigDecimal]trait ArchimedeanAdditiveSemigroup[BigDecimal]trait OrderedAdditiveSemigroup[BigDecimal]trait AdditiveSemigroup[BigDecimal]trait ArchimedeanAdditiveMagma[BigDecimal]trait OrderedAdditiveMagma[BigDecimal]trait AdditiveMagma[BigDecimal]trait ArchimedeanDifference[BigDecimal]trait OrderedDifference[BigDecimal]trait Difference[BigDecimal]trait Archimedean[BigDecimal]trait Ordered[BigDecimal]trait Algebra[BigDecimal]trait Ordering[BigDecimal]trait PartialOrdering[BigDecimal]trait Equiv[BigDecimal]trait Serializabletrait Comparator[BigDecimal]class Objecttrait Matchableclass AnyShow all
- Self type
Members list
Type members
Inherited classlikes
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
- Supertypes
-
class Objecttrait Matchableclass Any
Value members
Concrete methods
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
- Definition Classes
-
Ordering -> Comparator
The unique multiplicative identity in this algebra. Typically given by values such as 1 or 1.0F.
The unique multiplicative identity in this algebra. Typically given by values such as 1 or 1.0F.
Attributes
- Definition Classes
The unique additive identity in this algebra. Typically given by values such as 0, 0.0F, or Seq.empty.
The unique additive identity in this algebra. Typically given by values such as 0, 0.0F, or Seq.empty.
Attributes
- Definition Classes
Inherited methods
Returns true if x == y in the ordering.
Returns true if x == y in the ordering.
Attributes
- Definition Classes
-
Ordering -> PartialOrdering -> Equiv
- Inherited from:
- Ordering
Computes the canonical representation of the integer n in this algebra, i.e. 1 + 1 + … + 1 (n times).
Computes the canonical representation of the integer n in this algebra, i.e. 1 + 1 + … + 1 (n times).
Attributes
- Throws
-
IllegalArgumentException
if
n < 0and this algebra has no additive inverse. - Inherited from:
- Semiring
Returns true if x > y in the ordering.
Returns true if x > y in the ordering.
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns true if x >= y in the ordering.
Returns true if x >= y in the ordering.
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
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
Returns true if x < y in the ordering.
Returns true if x < y in the ordering.
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns true if x <= y in the ordering.
Returns true if x <= y in the ordering.
Attributes
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Returns x if x >= y, otherwise y.
Returns x if x >= y, otherwise y.
Attributes
- Inherited from:
- Ordering
Returns x if x <= y, otherwise y.
Returns x if x <= y, otherwise y.
Attributes
- Inherited from:
- Ordering
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
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
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
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
- Definition Classes
-
Ordering -> PartialOrdering
- Inherited from:
- Ordering
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
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
Extensions
Extensions
Computes the sum of two values x and y, i.e. x + y.
Rounds a value x downwards (towards negative infinity) to the nearest integer value.
Rounds a value x downwards (towards negative infinity) to the nearest integer value.
Attributes
- See also
-
ceil.
- Definition Classes
Computes the product of two values x and y, i.e. x × y.
Computes the product of two values x and y, i.e. x × y.
Attributes
- Definition Classes
Computes the additive inverse (negative) of a value x, i.e. -x.
Computes the additive inverse (negative) of a value x, i.e. -x.
Attributes
- Definition Classes
Computes the multiplicative inverse (reciprocal) of a value x, i.e. 1 / x.
Computes the multiplicative inverse (reciprocal) of a value x, i.e. 1 / x.
Attributes
- Throws
-
ArithmeticException
if
x == zero. - Definition Classes
Inherited extensions
An alias for subtract.
An alias for add.
Attributes
- Returns
-
trueif and only if the left operand x is strictly smaller than the right y. - Inherited from:
- Ordered
Attributes
- Returns
-
trueif and only if the left operand x is not larger than the right y. - Inherited from:
- Ordered
Attributes
- Returns
-
trueif and only if the left operand x is strictly larger than the right y. - Inherited from:
- Ordered
Attributes
- Returns
-
trueif and only if the left operand x is not smaller than the right y. - Inherited from:
- Ordered
Clamps x to lie within the inclusive range [lb, ub].
Clamps x to lie within the inclusive range [lb, ub].
Attributes
- Returns
-
lb if
x < lb, ub ifx > ub, or x otherwise. If the range is degenerate, i.e.lb > ub, then x is returned unchanged. - Inherited from:
- Ordered
Attributes
- Returns
-
The greater of both operands.
- Inherited from:
- Ordered
An alias for mul.
An alias for negate.
Attributes
- Returns
-
trueif and only if x is strictly negative, i.e.x < 0. - Inherited from:
- OrderedAdditiveIdentity
Attributes
- Returns
-
trueif and only if x is positive or zero, i.e.x ≥ 0. - Inherited from:
- OrderedAdditiveIdentity
Attributes
- Returns
-
trueif and only if x is negative or zero, i.e.x ≤ 0. - Inherited from:
- OrderedAdditiveIdentity
Attributes
- Returns
-
trueif and only if x is strictly positive, i.e.x > 0. - Inherited from:
- OrderedAdditiveIdentity
Computes the fractional part of x, i.e. x - ⌊x⌋.
Computes the fractional part of x, i.e. x - ⌊x⌋.
Attributes
- Note
-
The result will always fall in the half-open interval
[0, 1). - Inherited from:
- ArchimedeanDifference
A version of div which returns None when y == zero.
An alias for scale, with the factor on the left.
An alias for scale, with the factor on the right.
Attributes
- Returns
-
trueif and only if x equals zero. - Inherited from:
- AdditiveIdentity
Attributes
- Returns
-
trueif and only if x doesn't equal zero. - Inherited from:
- AdditiveIdentity
Attributes
- Returns
-
trueif and only if x equals one. - Inherited from:
- MultiplicativeIdentity
Attributes
- Returns
-
trueif and only if x doesn't equal one. - Inherited from:
- MultiplicativeIdentity
An alias for pow.
Rounds a value x towards zero (downwards if x is positive or upwards if x is negative).
Rounds a value x towards zero (downwards if x is positive or upwards if x is negative).
Attributes
- Inherited from:
- ArchimedeanAdditiveIdentity
Rounds a value x upwards (towards positive infinity) to the nearest integer value.
Rounds a value x upwards (towards positive infinity) to the nearest integer value.
Attributes
- See also
- Definition Classes
- Inherited from:
- ArchimedeanAdditiveInverse
A version of reciprocal which returns None when x == zero.
Computes x multiplied by n, for any integer n.
Computes x multiplied by n, for any integer n.
Attributes
- Definition Classes
- Inherited from:
- AdditiveGroup
Computes the difference between two values x and y, i.e. x - y.
Computes the difference between two values x and y, i.e. x - y.
Attributes
- Definition Classes
- Inherited from:
- AdditiveGroup
Computes the greatest common divisor of x and y.
Computes the greatest common divisor of x and y.
Attributes
- Note
- Definition Classes
- Inherited from:
- Field
Computes the lowest common multiple of x and y.
Computes the lowest common multiple of x and y.
Attributes
- Note
- Definition Classes
- Inherited from:
- Field
Computes the remainder upon dividing x by y.
Computes the remainder upon dividing x by y.
Attributes
An alias for mod.
A version of mod which returns None when y == zero.
A version of mod which returns None when y == zero.
Attributes
- Inherited from:
- QuotientDifferenceSemiring
Computes the absolute value of a value x, i.e. |x| = x if x ≥ 0 or else -x if x < 0.
Computes the absolute value of a value x, i.e. |x| = x if x ≥ 0 or else -x if x < 0.
Attributes
- Inherited from:
- OrderedAdditiveGroup
Determines the sign of a value x, given by one if x is positive, the negation of one if x is negative, or zero if x is itself zero.
Determines the sign of a value x, given by one if x is positive, the negation of one if x is negative, or zero if x is itself zero.
Attributes
- Inherited from:
- OrderedRing
Computes the quotient between a dividend x and a divisor y, i.e. x / y.
Computes the quotient between a dividend x and a divisor y, i.e. x / y.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
For imprecise (e.g. integer) arithmetic, the result is rounded towards zero.
- Definition Classes
- Inherited from:
- MultiplicativeGroup
Computes x raised to the power of n, for any integer n.
Computes x raised to the power of n, for any integer n.
Attributes
- Throws
-
ArithmeticException
if
n < 0andx == zero. - Definition Classes
- Inherited from:
- MultiplicativeGroup
Computes the Euclidean quotient between a dividend x and a divisor y.
Computes the Euclidean quotient between a dividend x and a divisor y.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
For imprecise (e.g. integer) arithmetic, the result is rounded towards negative infinity if
y > 0, or otherwise towards positive infinity ify < 0. - Inherited from:
- OrderedQuotientRing
Computes the Euclidean remainder between a dividend x and a divisor y.
Computes the Euclidean remainder between a dividend x and a divisor y.
The signs of x and y are both ignored.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
The result will always be non-negative, and fall in the half-open interval
[0, |y|). - Inherited from:
- OrderedQuotientRing
Computes the floored quotient between a dividend x and a divisor y.
Computes the floored quotient between a dividend x and a divisor y.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
For imprecise (e.g. integer) arithmetic, the result is rounded towards negative infinity.
- Inherited from:
- OrderedQuotientRing
Computes the floored remainder between a dividend x and a divisor y.
Computes the floored remainder between a dividend x and a divisor y.
The sign of y determines the sign of the result. The sign of x is ignored.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
The result will always fall in the half-open interval
[0, y)ify > 0, or otherwise in(y, 0]ify < 0. - Inherited from:
- OrderedQuotientRing
Rounds a value x to the nearest integer value (with ties rounded up).
Rounds a value x to the nearest integer value (with ties rounded up).
Attributes
- Inherited from:
- ArchimedeanDifferenceSemiring
Computes the Euclidean remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded away from the remainder.
Computes the Euclidean remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded away from the remainder.
Unlike euclideanMod, which inherits its rounding behaviour from div (and is therefore always zero when division is exact), the quotient here is always rounded to an integer value first. The two coincide when div itself produces integer values.
The signs of x and y are both ignored.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
The result will always be non-negative, and fall in the half-open interval
[0, |y|). - Inherited from:
- ArchimedeanQuotientRing
Computes the floored remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded towards negative infinity.
Computes the floored remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded towards negative infinity.
Unlike floorMod, which inherits its rounding behaviour from div (and is therefore always zero when division is exact), the quotient here is always rounded to an integer value first. The two coincide when div itself produces integer values.
The sign of y determines the sign of the result. The sign of x is ignored.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
The result will always fall in the half-open interval
[0, y)ify > 0, or otherwise in(y, 0]ify < 0. - Inherited from:
- ArchimedeanQuotientRing
Computes the signed remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded towards zero.
Computes the signed remainder between a dividend x and a divisor y, relative to the nearest integer quotient rounded towards zero.
Unlike mod, which inherits its rounding behaviour from div (and is therefore always zero when division is exact), the quotient here is always rounded to an integer value first. The two coincide when div itself produces integer values.
The sign of x only determines the sign of the result. The sign of y is ignored.
Attributes
- Throws
-
ArithmeticException
if
y == zero. - See also
- Note
-
The result will always fall in the half-open interval
[0, |y|)ifx ≥ 0, or otherwise in(-|y|, 0]ifx < 0. - Inherited from:
- ArchimedeanQuotientRing
Attributes
- Returns
-
trueif and only if x is not an integer value. - Inherited from:
- Archimedean
Attributes
- Returns
-
trueif and only if x is an integer value. - Inherited from:
- Archimedean
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else zero if xs is empty.
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else zero if xs is empty.
Attributes
- Inherited from:
- AdditiveMonoid
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else one if xs is empty.
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else one if xs is empty.
Attributes
- Inherited from:
- MultiplicativeMonoid
Computes the product of x and all values in xs, i.e. x × xs₁ × xs₂ × ….
Computes the product of x and all values in xs, i.e. x × xs₁ × xs₂ × ….
Attributes
- Inherited from:
- MultiplicativeSemigroup
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else None if xs is empty.
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else None if xs is empty.
Attributes
- Inherited from:
- MultiplicativeSemigroup
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else default if xs is empty.
Computes the product of all values in xs, i.e. xs₁ × xs₂ × …, or else default if xs is empty.
Attributes
- Inherited from:
- MultiplicativeSemigroup
Computes the sum of x and all values in xs, i.e. x + xs₁ + xs₂ + ….
Computes the sum of x and all values in xs, i.e. x + xs₁ + xs₂ + ….
Attributes
- Inherited from:
- AdditiveSemigroup
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else None if xs is empty.
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else None if xs is empty.
Attributes
- Inherited from:
- AdditiveSemigroup
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else default if xs is empty.
Computes the sum of all values in xs, i.e. xs₁ + xs₂ + …, or else default if xs is empty.
Attributes
- Inherited from:
- AdditiveSemigroup
Implicits
Inherited implicits
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