Spec-Zone.ru › Scala 3.2

Object Ordering.String

Исходный код

object String extends StringOrdering

Supertypes
trait StringOrdering
trait Ordering[String]
trait PartialOrdering[String]
trait Equiv[String]
trait Serializable
trait Comparator[String]
class Object
trait Matchable
class Any
Self type
String.type

Inherited classlikes

Исходный код
class OrderingOps(lhs: T)

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

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

Inherited from Ordering

Inherited methods

Исходный код
def compare(x: String, y: String): Int

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

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

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

Inherited from StringOrdering

Исходный код
override def equiv(x: String, y: String): Boolean

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

Definition Classes Ordering -> PartialOrdering -> Equiv
Inherited from Ordering

Исходный код
override def gt(x: String, y: String): Boolean

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

Definition Classes Ordering -> PartialOrdering
Inherited from Ordering

Исходный код
override def gteq(x: String, y: String): Boolean

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

Definition Classes Ordering -> PartialOrdering
Inherited from Ordering

Исходный код
def isReverseOf(other: Ordering[_]): Boolean

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

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

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

Inherited from Ordering

Исходный код
override def lt(x: String, y: String): Boolean

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

Definition Classes Ordering -> PartialOrdering
Inherited from Ordering

Исходный код
override def lteq(x: String, y: String): Boolean

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

Definition Classes Ordering -> PartialOrdering
Inherited from Ordering

Исходный код
def max[U <: String](x: U, y: U): U

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

Inherited from Ordering

Исходный код
def min[U <: String](x: U, y: U): U

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

Inherited from Ordering

Исходный код
def on[U](f: U => String): Ordering[U]

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

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

Исходный код
def orElse(other: Ordering[String]): Ordering[T]

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

Value parameters
other

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

Пример
case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElse(Ordering.by[Pair, Int](_.b))
Inherited from Ordering

Исходный код
def orElseBy[S](f: String => 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)
Inherited from Ordering

Исходный код
override def reverse: Ordering[T]

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

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

Definition Classes Ordering -> PartialOrdering
Inherited from Ordering

def reversed(): Comparator[T]

Унаследовано от Comparator

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

Унаследовано от Comparator

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

Унаследовано от Comparator

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

Унаследовано от Comparator

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

Унаследовано от Comparator

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

Унаследовано от Comparator

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

Унаследовано от Comparator

Источник
def tryCompare(x: String, y: String): Option[Int]

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

Унаследовано от Ordering

Унаследованные неявные методы

Источник
implicit def mkOrderingOps(lhs: String): OrderingOps

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

Унаследовано от Ordering

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

Spec-Zone.ru

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