SignedAdditiveCMonoid

trait SignedAdditiveCMonoid[@specialized(Byte, Short, Int, Long, Float, Double) A] extends Signed[A] with AdditiveCommutativeMonoid[A]
trait AdditiveCommutativeMonoid[A]
trait AdditiveCommutativeSemigroup[A]
trait AdditiveMonoid[A]
trait AdditiveSemigroup[A]
trait Signed[A]
trait Order[A]
trait PartialOrder[A]
trait Eq[A]
trait Serializable
class Any

Value members

Concrete methods

def signum(a: A): Int

Returns 0 if a is 0, 1 if a is positive, and -1 is a is negative.

Returns 0 if a is 0, 1 if a is positive, and -1 is a is negative.

Inherited methods

def abs(a: A): A

An idempotent function that ensures an object has a non-negative sign.

An idempotent function that ensures an object has a non-negative sign.

Inherited from
Signed
override
def additive: CommutativeMonoid[A]
Definition Classes
AdditiveCommutativeMonoid -> AdditiveCommutativeSemigroup -> AdditiveMonoid -> AdditiveSemigroup
Inherited from
AdditiveCommutativeMonoid
def compare(x: A, y: A): Int

Result of comparing x with y. Returns an Int whose sign is:

Result of comparing x with y. Returns an Int whose sign is:

  • negative iff x < y
  • zero iff x = y
  • positive iff x > y
Inherited from
Order
def comparison(x: A, y: A): Comparison

Like compare, but returns a cats.kernel.Comparison instead of an Int. Has the benefit of being able to pattern match on, but not as performant.

Like compare, but returns a cats.kernel.Comparison instead of an Int. Has the benefit of being able to pattern match on, but not as performant.

Inherited from
Order
override
def eqv(x: A, y: A): Boolean

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Definition Classes
Order -> PartialOrder -> Eq
Inherited from
Order
override
def gt(x: A, y: A): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Definition Classes
Order -> PartialOrder
Inherited from
Order
override
def gteqv(x: A, y: A): Boolean

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Definition Classes
Order -> PartialOrder
Inherited from
Order
def isSignNegative(a: A): Boolean
Inherited from
Signed
def isSignNonNegative(a: A): Boolean
Inherited from
Signed
def isSignNonPositive(a: A): Boolean
Inherited from
Signed
def isSignNonZero(a: A): Boolean
Inherited from
Signed
def isSignPositive(a: A): Boolean
Inherited from
Signed
def isSignZero(a: A): Boolean
Inherited from
Signed
def isZero(a: A)(implicit ev: Eq[A]): Boolean

Tests if a is zero.

Tests if a is zero.

Inherited from
AdditiveMonoid
override
def lt(x: A, y: A): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Definition Classes
Order -> PartialOrder
Inherited from
Order
override
def lteqv(x: A, y: A): Boolean

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Definition Classes
Order -> PartialOrder
Inherited from
Order
def max(x: A, y: A): A

If x > y, return x, else return y.

If x > y, return x, else return y.

Inherited from
Order
def min(x: A, y: A): A

If x < y, return x, else return y.

If x < y, return x, else return y.

Inherited from
Order
override
def neqv(x: A, y: A): Boolean

Returns true if x != y, false otherwise.

Returns true if x != y, false otherwise.

Note: this default implementation provided by Order is the same as the one defined in Eq, but for purposes of binary compatibility, the override in Order has not yet been removed. See this discussion.

Definition Classes
Order -> Eq
Inherited from
Order
def partialCompare(x: A, y: A): Double
Inherited from
Order
def partialComparison(x: A, y: A): Option[Comparison]

Like partialCompare, but returns a cats.kernel.Comparison instead of an Double. Has the benefit of being able to pattern match on, but not as performant.

Like partialCompare, but returns a cats.kernel.Comparison instead of an Double. Has the benefit of being able to pattern match on, but not as performant.

Inherited from
PartialOrder
def plus(x: A, y: A): A
Inherited from
AdditiveSemigroup
def pmax(x: A, y: A): Option[A]

Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

Inherited from
PartialOrder
def pmin(x: A, y: A): Option[A]

Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

Inherited from
PartialOrder
def sign(a: A): Sign

Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

Returns Zero if a is 0, Positive if a is positive, and Negative is a is negative.

Inherited from
Signed
def sum(as: IterableOnce[A]): A

Given a sequence of as, compute the sum.

Given a sequence of as, compute the sum.

Inherited from
AdditiveMonoid
override
def sumN(a: A, n: Int): A
Definition Classes
AdditiveMonoid -> AdditiveSemigroup
Inherited from
AdditiveMonoid
def toOrdering: Ordering[A]

Convert a Order[A] to a scala.math.Ordering[A] instance.

Convert a Order[A] to a scala.math.Ordering[A] instance.

Inherited from
Order
def tryCompare(x: A, y: A): Option[Int]

Result of comparing x with y. Returns None if operands are not comparable. If operands are comparable, returns Some[Int] where the Int sign is:

Result of comparing x with y. Returns None if operands are not comparable. If operands are comparable, returns Some[Int] where the Int sign is:

  • negative iff x < y
  • zero iff x = y
  • positive iff x > y
Inherited from
PartialOrder
override
def trySum(as: IterableOnce[A]): Option[A]
Definition Classes
AdditiveMonoid -> AdditiveSemigroup
Inherited from
AdditiveMonoid
def zero: A
Inherited from
AdditiveMonoid