ArchimedeanAdditiveInverse
A typeclass for algebraic values with the following features:
- Additive inverse (negation)
- Total order
- Rounding to integer values
Attributes
- Graph
-
- Supertypes
-
trait OrderedAdditiveInverse[X]trait AdditiveInverse[X]trait Archimedean[X]trait Ordered[X]trait Algebra[X]trait Ordering[X]trait PartialOrdering[X]trait Equiv[X]trait Serializabletrait Comparator[X]class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait ArchimedeanAdditiveGroup[X]trait ArchimedeanPseudoring[X]trait ArchimedeanRing[X]trait ArchimedeanQuotientRing[X]trait ArchimedeanField[X]Show all
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
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
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
Inherited and Abstract 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
- Inherited from:
- Ordering
Extensions
Extensions
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 extensions
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
Inherited and Abstract extensions
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
- Inherited from:
- AdditiveInverse
An alias for negate.
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.
- Inherited from:
- Archimedean
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
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