Spec-Zone.ru › Scala 2.13 Library

Трейт scala.math.Ordering.OptionOrdering

trait OptionOrdering[T] extends Ordering[Option[T]]

Источник
Ordering.scala
Линейные надтипы
Ordering[Option[T]], PartialOrdering[Option[T]], Equiv[Option[T]], java.io.Serializable, Comparator[Option[T]], AnyRef, Any

Члены типа

класс OrderingOps extends AnyRef

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

Определяющие классы
Ordering

Абстрактные члены значения

абстрактный def optionOrdering: Ordering[T]

Члены конкретных значений

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

возвращает

true если !(this == that), иначе false.

Определяющие классы
AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode за исключением упакованных числовых типов и null. Для чисел возвращает хэш-значение, согласованное с равенством значений: если два экземпляра типов значений сравниваются как true, тогда ## возвратит одинаковое хэш-значение для каждого из них. Для null возвращает хэш-код, где null.hashCode вызывает NullPointerException.

возвращает

хэш-значение, согласованное с ==

Определяющие классы
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавляется неявным преобразованием из OptionOrdering[T] вany2stringadd[OptionOrdering[T]] с помощью метода any2stringadd в scala.Predef.
Определяющие классы
any2stringadd

def ->[B](y: B): (OptionOrdering[T], B)

Неявный
Этот член добавляется неявным преобразованием из OptionOrdering[T] вArrowAssoc[OptionOrdering[T]] с помощью метода ArrowAssoc в scala.Predef.
Определяющие классы
ArrowAssoc
Аннотации
@inline()

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Определяющие классы
AnyRef → Any

final def asInstanceOf[T0]: T0

Приведение объекта-получателя к типу T0.

Обратите внимание, что успех приведения во время выполнения зависит от семантики стирания Scala. Следовательно, выражение 1.asInstanceOf[String] вызовет ClassCastException во время выполнения, в то время как выражение List(1).asInstanceOf[List[String]] не вызовет.

возвращает

объект-получатель.

Определяющие классы
Any
Исключения

ClassCastException, если объект-получатель не является экземпляром стирания типа T0.

def clone(): AnyRef

Создать копию объекта-получателя.

По умолчанию реализация метода clone зависит от платформы.

возвращает

копию объекта-получателя.

Атрибуты
protected[java.lang]
Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Примечание

не указано SLS как члена AnyRef

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

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

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

    отрицательный, если x < yположительный, если x > yноль, если x == y
Определяющие классы
OptionOrdering → Ordering → Comparator

def ensuring(cond: (OptionOrdering[T]) => Boolean, msg: => Any): OptionOrdering[T]

Неявный
Этот член добавлен неявным преобразованием из OptionOrdering[T] в Ensuring[OptionOrdering[T]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: (OptionOrdering[T]) => Boolean): OptionOrdering[T]

Неявный
Этот член добавлен неявным преобразованием из OptionOrdering[T] в Ensuring[OptionOrdering[T]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean, msg: => Any): OptionOrdering[T]

Неявный
Этот член добавлен неявным преобразованием из OptionOrdering[T] в Ensuring[OptionOrdering[T]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean): OptionOrdering[T]

Неявный
Этот член добавлен неявным преобразованием из OptionOrdering[T] в Ensuring[OptionOrdering[T]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на объект-получатель (this).

Метод eq реализует отношение эквивалентности на непустых экземплярах AnyRef, и имеет три дополнительных свойства:

    Он согласован: для любых непустых экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false.Для любого непустого экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращают false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить согласованность их поведения с равенством ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и должны иметь одинаковое значение хеша (o1.hashCode == o2.hashCode).

returns

true если аргумент является ссылкой на объект-получатель; false в противном случае.

Определяющие классы
AnyRef

def equals(obj: Any): Boolean

Метод равенства для ссылочных типов. Стандартная реализация делегирует eq.

См. также equals в scala.Any.

returns

true если объект-получатель эквивалентен аргументу; false в противном случае.

Определяющие классы
OptionOrdering → Comparator → AnyRef → Any

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

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

Определяющие классы
Ordering → PartialOrdering → Equiv

def finalize(): Unit

Вызывается сборщиком мусора для объекта-получателя, когда больше нет ссылок на объект.

Подробности о том, когда и если вызывается метод finalize, а также взаимодействие между finalize и нелокальными возвратами и исключениями, зависят от платформы.

Атрибуты
protected[java.lang]
Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.Throwable])
Примечание

не указано SLS в качестве члена AnyRef

def formatted(fmtstr: String): String

Возвращает строку, отформатированную согласно заданной строке format. Форматные строки такие же, как для String.format (@see java.lang.String.format).

Неявное
Этот член добавляется неявным преобразованием из OptionOrdering[T] в StringFormat[OptionOrdering[T]] с помощью метода StringFormat в scala.Predef.
Определяющие классы
StringFormat
Аннотации
@inline()

final def getClass(): Class[_ <: AnyRef]

Возвращает представление класса объекта во время выполнения.

возвращает

объект класса, соответствующий времени выполнения типа получателя.

Определяющие классы
AnyRef → Any
Аннотации
@native()

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

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

Определяющие классы
Ordering → PartialOrdering

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

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

Определяющие классы
Ordering → PartialOrdering

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

возвращает

значение хэш-кода для этого объекта.

Определяющие классы
OptionOrdering → AnyRef → Any

final def isInstanceOf[T0]: Boolean

Проверить, является ли динамический тип принимающего объекта T0.

Обратите внимание, что результат теста является модулем семантики стирания Scala. Поэтому выражение 1.isInstanceOf[String] вернет false, а выражение List(1).isInstanceOf[List[String]] вернет true. В последнем примере, поскольку аргумент типа стирается в процессе компиляции, проверить, содержится ли в списке указанный тип, невозможно.

возвращает

true если принимающий объект является экземпляром стирания типа T0; false в противном случае.

Определяющие классы
Any

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

Возвращает, является ли другая сортировка противоположной сортировкой этой.

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

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

Определяющие классы
Ordering

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

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

Определяющие классы
Ordering → PartialOrdering

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

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

Определяющие классы
Ordering → PartialOrdering

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

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

Определяющие классы
Ordering

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

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

Definition Classes
Ordering

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

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

Definition Classes
Ordering

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

returns

true если аргумент не является ссылкой на объект-получатель; false иначе.

Definition Classes
AnyRef

final def notify(): Unit

Будит один поток, ожидающий на мониторе объекта-получателя.

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

final def notifyAll(): Unit

Будит все потоки, ожидающие на мониторе объекта-получателя.

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

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))
Definition Classes
Ordering

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

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

other

Ordering для использования, если этот Ordering возвращает ноль

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

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

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

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

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

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

def reverse: Ordering[Option[T]]

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

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

Definition Classes
Ordering → PartialOrdering

def reversed(): Comparator[Option[T]]

Definition Classes
Comparator

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: Option[T] <: AnyRef, _ <: U]): Comparator[Option[T]]

Definition Classes
Comparator

def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: Option[T] <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[Option[T]]

Definition Classes
Comparator

def thenComparing(arg0: Comparator[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]

Definition Classes
Comparator

def thenComparingDouble(arg0: ToDoubleFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]

Definition Classes
Comparator

def thenComparingInt(arg0: ToIntFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]

Definition Classes
Comparator

def thenComparingLong(arg0: ToLongFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]

Definition Classes
Comparator

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

returns

строковое представление объекта.

Definition Classes
AnyRef → Any

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

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

Definition Classes
Ordering → PartialOrdering

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/math/Ordering$$OptionOrdering.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API