Трейт Ordering.OptionOrdering

трейт OptionOrdering[T] extends Ordering[Option[T]]

Наследуемые классы

Исходный код

класс OrderingOps(lhs: T)

Этот внутренний класс определяет операторы сравнения, доступные для T.

Он не может расширять AnyVal, потому что это не класс верхнего уровня или член статически доступного объекта.

Абстрактные методы

Исходный код

def optionOrdering: Ordering[T]

Конкретные методы

Исходный код

def compare(x: Option[T], y: Option[T]): Int

Возвращает целое число, знак которого указывает, как x сравнивается с y.

Знак результата имеет следующее значение:

- отрицательный, если x < y - положительный, если x > y - нулевой, иначе (если x == y)

Исходный код

override def equals(obj: Any): Boolean

Сравнивает объект-получатель (this) с объектом-аргументом (that) на эквивалентность.

Любая реализация этого метода должна быть отношением эквивалентности:

- Он рефлексивен: для любого экземпляра x типа Any, x.equals(x) должен вернуть true. - Он симметричен: для любых экземпляров x и y типа Any, x.equals(y) должен вернуть true тогда и только тогда, когда y.equals(x) возвращает true. - Он транзитивен: для любых экземпляров x, y, и z типа Any если x.equals(y) возвращает true и y.equals(z) возвращает true, то x.equals(z) должен вернуть true.

Если вы переопределяете этот метод, вы должны проверить, что ваша реализация остается отношением эквивалентности. Кроме того, при переопределении этого метода обычно необходимо переопределить hashCode, чтобы гарантировать, что объекты, которые являются «равными» (o1.equals(o2) возвращает true), имеют одинаковые хэш-коды (o1.hashCode.equals(o2.hashCode)).

Исходный код

override def hashCode(): Int

Вычислите хэш-код объекта.

Алгоритм хэширования по умолчанию зависит от платформы.

Обратите внимание, что разрешается, чтобы у двух объектов были идентичные хэш-коды (o1.hashCode.equals(o2.hashCode)), но они не были равны (o1.equals(o2) возвращает false). Вырожденная реализация может всегда возвращать 0. Однако требуется, чтобы если два объекта равны (o1.equals(o2) возвращает true), у них были идентичные хэш-коды (o1.hashCode.equals(o2.hashCode)). Поэтому при переопределении этого метода обязательно проверьте, что поведение согласуется с методом equals.

Наследуемые методы

Исходный код

override def equiv(x: Option[T], y: Option[T]): Boolean

Возвращает true, если x == y в порядке сортировки.

Исходный код

override def gt(x: Option[T], y: Option[T]): Boolean

Возвращает true, если x > y в порядке сортировки.

Исходный код

override def gteq(x: Option[T], y: Option[T]): Boolean

Возвращает true, если x >= y в порядке сортировки.

Исходный код

def isReverseOf(other: Ordering[_]): Boolean

Возвращает true, если порядок other является обратным порядком этого порядка.

Эквивалентно other == this.reverse.

Реализации должны переопределять этот метод только в том случае, если они переопределяют reverse также.

Исходный код

override def lt(x: Option[T], y: Option[T]): Boolean

Возвращает true, если x < y в порядке сортировки.

Исходный код

override def lteq(x: Option[T], y: Option[T]): Boolean

Возвращает true, если x <= y в порядке сортировки.

Исходный код

def max[U <: Option[T]](x: U, y: U): U

Возвращает x если x >= y, в противном случае y.

Исходный код

def min[U <: Option[T]](x: U, y: U): U

Возвращает x если x <= y, в противном случае y.

Source

def on[U](f: U => Option[T]): Ordering[U]

Принимая f, функцию из U в T, создаёт Ordering[U], чья функция сравнения эквивалентна:

def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))

Source

def orElse(other: Ordering[Option[T]]): Ordering[T]

Создаёт Ordering[T], чья функция сравнения возвращает результат функции сравнения этого Ordering, если она не равна нулю, или же результат функции сравнения other.

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElse(Ordering.by[Pair, Int](_.b))

Source

def orElseBy[S](f: Option[T] => S)(implicit ord: Ordering[S]): Ordering[T]

Принимая f, функцию из T в S, создаёт Ordering[T], чья функция сравнения возвращает результат функции сравнения этого Ordering, если она не равна нулю, или же результат, эквивалентный:

Ordering[S].compare(f(x), f(y))

Эта функция эквивалентна передаче результата Ordering.by(f) в orElse.

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElseBy[Int](_.b)

Source

override def reverse: Ordering[T]

Возвращает обратный порядок этого.

Реализации, переопределяющие этот метод, ДОЛЖНЫ также переопределить isReverseOf, если они изменяют поведение (например, кеширование не требует переопределения).

def reversed(): Comparator[T]

def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x$0: Function[_ >: Option[T] <: <FromJavaObject>, _ <: U]): Comparator[T]

def thenComparing[U <: <FromJavaObject>](x$0: Function[_ >: Option[T] <: <FromJavaObject>, _ <: U], x$1: Comparator[_ >: U <: <FromJavaObject>]): Comparator[T]

def thenComparing(x$0: Comparator[_ >: Option[T] <: <FromJavaObject>]): Comparator[T]

def thenComparingDouble(x$0: ToDoubleFunction[_ >: Option[T] <: <FromJavaObject>]): Comparator[T]

def thenComparingInt(x$0: ToIntFunction[_ >: Option[T] <: <FromJavaObject>]): Comparator[T]

def thenComparingLong(x$0: ToLongFunction[_ >: Option[T] <: <FromJavaObject>]): Comparator[T]

Source

def tryCompare(x: Option[T], y: Option[T]): Option[Int]

Возвращает, определено ли сравнение между x и y, и если да, то результат compare(x, y).

Inherited implicits

Source

implicit def mkOrderingOps(lhs: Option[T]): OrderingOps

Этот неявный метод дополняет T операторами сравнения, определёнными в scala.math.Ordering.Ops.