QOrder

coulomb.ops.algebra.cats.quantity$.infra$.QOrder
class QOrder[V, U](ord: Order[V]) extends Order[Quantity[V, U]]

Attributes

Source:
quantity.scala
Graph
Supertypes
trait Order[Quantity[V, U]]
trait PartialOrder[Quantity[V, U]]
trait Eq[Quantity[V, U]]
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def compare(x: Quantity[V, U], y: Quantity[V, U]): 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

Source:
quantity.scala

Inherited methods

def comparison(x: Quantity[V, U], y: Quantity[V, U]): 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
Source:
Order.scala
override def eqv(x: Quantity[V, U], y: Quantity[V, U]): Boolean

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Attributes

Definition Classes
Inherited from:
Order
Source:
Order.scala
override def gt(x: Quantity[V, U], y: Quantity[V, U]): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Attributes

Definition Classes
Inherited from:
Order
Source:
Order.scala
override def gteqv(x: Quantity[V, U], y: Quantity[V, U]): Boolean

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Attributes

Definition Classes
Inherited from:
Order
Source:
Order.scala
override def lt(x: Quantity[V, U], y: Quantity[V, U]): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Attributes

Definition Classes
Inherited from:
Order
Source:
Order.scala
override def lteqv(x: Quantity[V, U], y: Quantity[V, U]): Boolean

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Attributes

Definition Classes
Inherited from:
Order
Source:
Order.scala
def max(x: Quantity[V, U], y: Quantity[V, U]): A

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

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

Attributes

Inherited from:
Order
Source:
Order.scala
def min(x: Quantity[V, U], y: Quantity[V, U]): A

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

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

Attributes

Inherited from:
Order
Source:
Order.scala
override def neqv(x: Quantity[V, U], y: Quantity[V, U]): 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
Inherited from:
Order
Source:
Order.scala
def partialCompare(x: Quantity[V, U], y: Quantity[V, U]): 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
Source:
Order.scala

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
Source:
PartialOrder.scala
def pmax(x: Quantity[V, U], y: Quantity[V, U]): 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
Source:
PartialOrder.scala
def pmin(x: Quantity[V, U], y: Quantity[V, U]): 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
Source:
PartialOrder.scala

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
Source:
Order.scala
def tryCompare(x: Quantity[V, U], y: Quantity[V, U]): 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
Source:
PartialOrder.scala