IsAlgebraic

trait IsAlgebraic[@specialized A] extends IsReal[A]
Companion:
object
trait IsReal[A]
trait Signed[A]
trait Order[A]
trait PartialOrder[A]
trait Eq[A]
class Any

Value members

Abstract methods

Concrete methods

def toReal(a: A): Real

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
def ceil(a: A): A

Rounds a the nearest integer that is greater than or equal to a.

Rounds a the nearest integer that is greater than or equal to a.

Inherited from:
IsReal
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
Inherited from:
Order
def floor(a: A): A

Rounds a the nearest integer that is less than or equal to a.

Rounds a the nearest integer that is less than or equal to a.

Inherited from:
IsReal
override def gt(x: A, y: A): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Definition Classes
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
Inherited from:
Order
Inherited from:
Signed
Inherited from:
Signed
Inherited from:
Signed
Inherited from:
Signed
Inherited from:
Signed
def isSignZero(a: A): Boolean
Inherited from:
Signed
def isWhole(a: A): Boolean

Returns true iff a is a an integer.

Returns true iff a is a an integer.

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

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Definition Classes
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
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
Inherited from:
Order
def order: Order[A]
Inherited from:
Signed
def partialCompare(x: A, y: A): Double
Inherited from:
Order

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 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 round(a: A): A

Rounds a to the nearest integer.

Rounds a to the nearest integer.

Inherited from:
IsReal
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 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 from:
Signed
def toDouble(a: A): Double

Approximates a as a Double.

Approximates a as a Double.

Inherited from:
IsReal

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