FloatTotalOrder

org.saddle.util.FloatTotalOrder$

Attributes

Graph
Supertypes
trait Hash[Float]
trait Order[Float]
trait PartialOrder[Float]
trait Eq[Float]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Inherited methods

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

Attributes

Inherited from:
FloatTotalOrderTrait (hidden)
def comparison(x: Float, y: Float): 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.

Attributes

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

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Attributes

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

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Attributes

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

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Attributes

Definition Classes
FloatTotalOrderTrait -> Order -> PartialOrder
Inherited from:
FloatTotalOrderTrait (hidden)
def hash(x: Float): Int

Returns the hash code of the given object under this hashing scheme.

Returns the hash code of the given object under this hashing scheme.

Attributes

Inherited from:
FloatTotalOrderTrait (hidden)
override def lt(x: Float, y: Float): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Attributes

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

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Attributes

Definition Classes
FloatTotalOrderTrait -> Order -> PartialOrder
Inherited from:
FloatTotalOrderTrait (hidden)
override def max(x: Float, y: Float): Float

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

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

Attributes

Definition Classes
FloatTotalOrderTrait -> Order
Inherited from:
FloatTotalOrderTrait (hidden)
override def min(x: Float, y: Float): Float

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

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

Attributes

Definition Classes
FloatTotalOrderTrait -> Order
Inherited from:
FloatTotalOrderTrait (hidden)
override def neqv(x: Float, y: Float): 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.

Attributes

Definition Classes
FloatTotalOrderTrait -> Order -> Eq
Inherited from:
FloatTotalOrderTrait (hidden)
def partialCompare(x: Float, y: Float): Double

Result of comparing x with y. Returns NaN if operands are not comparable. If operands are comparable, returns a Double whose sign is:

Result of comparing x with y. Returns NaN if operands are not comparable. If operands are comparable, returns a Double whose sign is:

  • negative iff x < y
  • zero iff x = y
  • positive iff x > y

Attributes

Inherited from:
Order
def partialComparison(x: Float, y: Float): 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.

Attributes

Inherited from:
PartialOrder
def pmax(x: Float, y: Float): 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.

Attributes

Inherited from:
PartialOrder
def pmin(x: Float, y: Float): 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.

Attributes

Inherited from:
PartialOrder
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.

Attributes

Inherited from:
Order
def tryCompare(x: Float, y: Float): 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

Attributes

Inherited from:
PartialOrder