ArchimedeanAdditiveMonoid

com.alecdorrington.scalgebra.archimedean.ArchimedeanAdditiveMonoid

A typeclass for algebraic values with the following features:

  • Associative addition
  • Additive identity (0)
  • Total order
  • Rounding to integer values

Attributes

Graph
Supertypes
trait AdditiveMonoid[X]
trait AdditiveIdentity[X]
trait AdditiveMagma[X]
trait Archimedean[X]
trait Ordered[X]
trait Algebra[X]
trait Ordering[X]
trait PartialOrdering[X]
trait Equiv[X]
trait Serializable
trait Comparator[X]
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited classlikes

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.

Attributes

Inherited from:
Ordering
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

override def equiv(x: X, y: X): Boolean

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
override def gt(x: X, y: X): Boolean

Returns true if x > y in the ordering.

Returns true if x > y in the ordering.

Attributes

Definition Classes
Ordering -> PartialOrdering
Inherited from:
Ordering
override def gteq(x: X, y: X): Boolean

Returns true if x >= y in the ordering.

Returns true if x >= y in the ordering.

Attributes

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

Attributes

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

Returns true if x < y in the ordering.

Returns true if x < y in the ordering.

Attributes

Definition Classes
Ordering -> PartialOrdering
Inherited from:
Ordering
override def lteq(x: X, y: X): Boolean

Returns true if x <= y in the ordering.

Returns true if x <= y in the ordering.

Attributes

Definition Classes
Ordering -> PartialOrdering
Inherited from:
Ordering
def max[U <: X](x: U, y: U): U

Returns x if x >= y, otherwise y.

Returns x if x >= y, otherwise y.

Attributes

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

Returns x if x <= y, otherwise y.

Returns x if x <= y, otherwise y.

Attributes

Inherited from:
Ordering
def on[U](f: U => X): 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
def orElse(other: Ordering[X]): Ordering[X]

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
def orElseBy[S](f: X => S)(implicit ord: Ordering[S]): Ordering[X]

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
override def reverse: Ordering[X]

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
def reversed(): Comparator[X]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Comparator
def tryCompare(x: X, y: X): 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).

Attributes

Inherited from:
Ordering

Inherited and Abstract methods

def compare(x: X, y: X): 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
def zero: X

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

Inherited from:
AdditiveIdentity

Extensions

Inherited extensions

extension (x: X)
infix inline def <(y: X): Boolean

Attributes

Returns

true if and only if the left operand x is strictly smaller than the right y.

Inherited from:
Ordered
infix inline def <=(y: X): Boolean

Attributes

Returns

true if and only if the left operand x is not larger than the right y.

Inherited from:
Ordered
infix inline def >(y: X): Boolean

Attributes

Returns

true if and only if the left operand x is strictly larger than the right y.

Inherited from:
Ordered
infix inline def >=(y: X): Boolean

Attributes

Returns

true if and only if the left operand x is not smaller than the right y.

Inherited from:
Ordered
def clamp(lb: X, ub: X): X

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 &lt; lb, ub if x > ub, or x otherwise. If the range is degenerate, i.e. lb > ub, then x is returned unchanged.

Inherited from:
Ordered
infix def max(y: X): X

Attributes

Returns

The greater of both operands.

Inherited from:
Ordered
infix def min(y: X): X

Attributes

Returns

The lesser of both operands.

Inherited from:
Ordered
extension (x: X)
inline def isNegative: Boolean

Attributes

Returns

true if and only if x is strictly negative, i.e. x &lt; 0.

Inherited from:
OrderedAdditiveIdentity
inline def isNonNegative: Boolean

Attributes

Returns

true if and only if x is positive or zero, i.e. x ≥ 0.

Inherited from:
OrderedAdditiveIdentity
inline def isNonPositive: Boolean

Attributes

Returns

true if and only if x is negative or zero, i.e. x ≤ 0.

Inherited from:
OrderedAdditiveIdentity
inline def isPositive: Boolean

Attributes

Returns

true if and only if x is strictly positive, i.e. x > 0.

Inherited from:
OrderedAdditiveIdentity
extension (x: X)
infix inline def *:(n: Int): X

An alias for scale, with the factor on the left.

An alias for scale, with the factor on the left.

Attributes

Inherited from:
AdditiveSemigroup
infix inline def :*(n: Int): X

An alias for scale, with the factor on the right.

An alias for scale, with the factor on the right.

Attributes

Inherited from:
AdditiveSemigroup
extension (x: X)
inline def isZero: Boolean

Attributes

Returns

true if and only if x equals zero.

Inherited from:
AdditiveIdentity
inline def nonZero: Boolean

Attributes

Returns

true if and only if x doesn't equal zero.

Inherited from:
AdditiveIdentity
extension (x: X)
override def scale(n: Int): X

Computes x multiplied by n, for any non-negative integer n.

Computes x multiplied by n, for any non-negative integer n.

Attributes

Throws
IllegalArgumentException

if n &lt; 0.

Definition Classes
Inherited from:
AdditiveMonoid
extension (x: X)
def truncate: X

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
extension (xs: Iterable[X])
inline def sumOrZero: X

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
extension (xs: Iterable[X])
inline def sumFrom(x: X): X

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
inline def sumOption: Option[X]

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
inline def sumOrElse[Y >: X](default: Y): Y

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

Inherited and Abstract extensions

extension (x: X)
infix inline def +(y: X): X

An alias for add.

An alias for add.

Attributes

Inherited from:
AdditiveMagma
def add(y: X): X

Computes the sum of two values x and y, i.e. x + y.

Computes the sum of two values x and y, i.e. x + y.

Attributes

Inherited from:
AdditiveMagma
extension (x: X)
def ceil: X

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
Inherited from:
Archimedean
def floor: X

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
inline def isFractional: Boolean

Attributes

Returns

true if and only if x is not an integer value.

Inherited from:
Archimedean
inline def isIntegral: Boolean

Attributes

Returns

true if and only if x is an integer value.

Inherited from:
Archimedean

Implicits

Inherited implicits

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