cats-docs
2.10.0
API
Generated with
cats-docs/cats/cats.kernel/cats.kernel.instances/CharOrder

CharOrder

cats.kernel.instances.CharOrder
class CharOrder extends Order[Char], Hash[Char], CharBounded, CharEnumerable

Attributes

Source
CharInstances.scala
Graph
Supertypes
trait PartialNext[Char]
trait CharBounded
trait Hash[Char]
trait Order[Char]
trait Eq[Char]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def compare(x: Char, y: Char): Int

Result of comparing x with y.

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
CharInstances.scala
override def eqv(x: Char, y: Char): Boolean

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Attributes

Definition Classes
Source
CharInstances.scala
override def gt(x: Char, y: Char): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Attributes

Definition Classes
Source
CharInstances.scala
override def gteqv(x: Char, y: Char): Boolean

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Attributes

Definition Classes
Source
CharInstances.scala
def hash(x: Char): 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

Source
CharInstances.scala
override def lt(x: Char, y: Char): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Attributes

Definition Classes
Source
CharInstances.scala
override def lteqv(x: Char, y: Char): Boolean

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Attributes

Definition Classes
Source
CharInstances.scala
override def neqv(x: Char, y: Char): 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
Order -> Eq
Source
CharInstances.scala

Inherited methods

def comparison(x: Char, y: Char): Comparison

Like compare, but returns a cats.kernel.Comparison instead of an Int.

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

Attributes

Inherited from:
BoundedEnumerable
Source
Enumerable.scala
def cyclePrevious(a: Char): A

Attributes

Inherited from:
BoundedEnumerable
Source
Enumerable.scala
def max(x: Char, y: Char): 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 maxBound: Char

Returns the upper limit of a type.

Returns the upper limit of a type.

Attributes

Definition Classes
Inherited from:
CharBounded
Source
CharInstances.scala
def membersAscending: LazyList[A]

Enumerate the members in ascending order.

Enumerate the members in ascending order.

Attributes

Inherited from:
PartialNextLowerBounded
Source
EnumerableCompat.scala
def membersDescending: LazyList[A]

Enumerate the members in descending order.

Enumerate the members in descending order.

Attributes

Inherited from:
PartialPreviousUpperBounded
Source
EnumerableCompat.scala
def min(x: Char, y: Char): 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 minBound: Char

Returns the lower limit of a type.

Returns the lower limit of a type.

Attributes

Definition Classes
Inherited from:
CharBounded
Source
CharInstances.scala
def partialCompare(x: Char, y: Char): Double

Result of comparing x with y.

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
def partialComparison(x: Char, y: Char): Option[Comparison]

Like partialCompare, but returns a cats.kernel.Comparison instead of an Double.

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
override def partialNext(a: Char): Option[Char]

Attributes

Definition Classes
Inherited from:
CharEnumerable
Source
CharInstances.scala
override def partialOrder: PartialOrder[A]

Attributes

Definition Classes
Inherited from:
BoundedEnumerable
Source
Enumerable.scala
override def partialPrevious(a: Char): Option[Char]

Attributes

Definition Classes
Inherited from:
CharEnumerable
Source
CharInstances.scala
def pmax(x: Char, y: Char): 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: Char, y: Char): 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 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
Source
Order.scala
def tryCompare(x: Char, y: Char): Option[Int]

Result of comparing x with y.

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

Concrete fields

override val order: Order[Char]

Attributes

Source
CharInstances.scala
Generated with