FloatOrder

class FloatOrder extends Order[Float] with Hash[Float]

Due to the way floating-point equality works, this instance is not lawful under equality, but is correct when taken as an approximation of an exact value.

Due to the way floating-point equality works, this instance is not lawful under equality, but is correct when taken as an approximation of an exact value.

If you would prefer an absolutely lawful fractional value, you'll need to investigate rational numbers or more exotic types.

trait Hash[Float]
trait Order[Float]
trait PartialOrder[Float]
trait Eq[Float]
trait Serializable
class Object
trait Matchable
class Any

Value members

Concrete methods

def compare(x: Float, y: Float): Int
override def eqv(x: Float, y: Float): Boolean
Definition Classes
override def gt(x: Float, y: Float): Boolean
Definition Classes
override def gteqv(x: Float, y: Float): Boolean
Definition Classes
def hash(x: Float): Int
override def lt(x: Float, y: Float): Boolean
Definition Classes
override def lteqv(x: Float, y: Float): Boolean
Definition Classes
override def max(x: Float, y: Float): Float
Definition Classes
override def min(x: Float, y: Float): Float
Definition Classes
override def neqv(x: Float, y: Float): Boolean
Definition Classes

Inherited methods

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.

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

Inherited from
PartialOrder
def pmax(x: Float, y: Float): Option[Float]

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: Float, y: Float): Option[Float]

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 toOrdering: Ordering[Float]

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