Spec-Zone.ru › Scala 2.13 Library

Объект scala.collection.immutable.Nil

объект Nil extends List[Nothing] with Product with Serializable

Источник
List.scala
Линейные супертипы
Product, Список[Nothing], DefaultSerializable, java.io.Serializable, StrictOptimizedSeqOps[Nothing, Список, Список[Nothing]], StrictOptimizedLinearSeqOps[Nothing, Список, Список[Nothing]], collection.StrictOptimizedSeqOps[Nothing, Список, Список[Nothing]], StrictOptimizedIterableOps[Nothing, Список, Список[Nothing]], LinearSeq[Nothing], LinearSeqOps[Nothing, [X]Список[X], Список[Nothing]], collection.LinearSeq[Nothing], collection.LinearSeqOps[Nothing, [X]Список[X], Список[Nothing]], AbstractSeq[Nothing], Последовательность[Nothing], SeqOps[Nothing, [_]Список[_], Список[Nothing]], Iterable[
Nothing], сборник.AbstractSeq[Nothing], сборник.Seq[Nothing], Equals, сборник.SeqOps[Nothing, [_]Список[_], Список[Nothing]], ЧастичнаяФункция[Int, Nothing], (Int) => Nothing, AbstractIterable[Nothing], сборник.Iterable[Nothing], IterableFactoryDefaults[Nothing, [x]Список[x]], IterableOps[Nothing, [_]Список[_], Список[Nothing]], IterableOnceOps[Nothing, [_]Список[_], Список[Nothing]], IterableOnce[Nothing], AnyRef, Any

Члены-значения

final def !=(arg0: Any): Boolean

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

возвращает

true если !(this == that), в противном случае false.

Классы-определения
AnyRef → Any

final def ##(): Int

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

возвращает

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

Классы-определения
AnyRef → Any

final def ++[B >: Nothing](suffix: IterableOnce[B]): List[B]

Псевдоним для concat

Классы-определения
IterableOps
Аннотации
@inline()

final def ++:[B >: Nothing](prefix: IterableOnce[B]): List[B]

Псевдоним для prependedAll

Классы-определения
SeqOps → IterableOps
Аннотации
@inline()

final def +:[B >: Nothing](elem: B): List[B]

Псевдоним для prepended.

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое правило для +: против :+: двоеточие ставится со стороны коллекции.

Определяющие классы
SeqOps
Аннотации
@inline()

final def :+[B >: Nothing](elem: B): List[B]

Псевдоним для appended

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое правило для +: против :+: двоеточие ставится со стороны коллекции.

Определяющие классы
SeqOps
Аннотации
@inline()

final def :++[B >: Nothing](suffix: IterableOnce[B]): List[B]

Псевдоним для appendedAll

Определяющие классы
SeqOps
Аннотации
@inline()

def ::[B >: Nothing](elem: B): List[B]

Добавляет элемент в начало списка.

elem

элемент для добавления в начало.

возвращает

список, который содержит x в качестве первого элемента и продолжает этот список. Пример:

1 :: List(2, 3) = List(2, 3).::(1) = List(1, 2, 3)
Определяющие классы
List

def :::[B >: Nothing](prefix: List[B]): List[B]

Добавляет элементы заданного списка перед этим списком.

Пример:

List(1, 2) ::: List(3, 4) = List(3, 4).:::(List(1, 2)) = List(1, 2, 3, 4)
prefix

Элементы списка, которые нужно добавить в начало.

returns

список, полученный в результате конкатенации заданного списка prefix и этого списка.

Definition Classes
Список

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def addString(b: mutable.StringBuilder): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер. Текст, который будет записан, состоит из строковых представлений (относительно метода toString) всех элементов этой коллекции без разделительной строки.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234
b

строковый буфер, в который добавляются элементы.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
IterableOnceOps
Annotations
@inline()

final def addString(b: mutable.StringBuilder, sep: String): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер с использованием разделительной строки. Записываемый текст состоит из строковых представлений (относительно метода toString) всех элементов этой коллекции, разделенных строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
b

строковый буфер, в который добавляются элементы.

sep

разделительная строка.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
IterableOnceOps
Annotations
@inline()

def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder

Добавляет все элементы этой коллекции в строковый буфер, используя начальную, конечную и разделительные строки. Текст начинается со строки start и заканчивается строкой end. Внутри строковые представления (с точки зрения метода toString) всех элементов этой коллекции разделены строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
b

строковый буфер, в который добавляются элементы.

start

начальная строка.

sep

разделительная строка.

end

конечная строка.

returns

строковый буфер b, в который были добавлены элементы.

Definition Classes
IterableOnceOps

def andThen[C](k: PartialFunction[Nothing, C]): PartialFunction[Int, C]

Компонует эту частичную функцию с другой частичной функцией, которая применяется к результатам этой частичной функции.

Обратите внимание, что вызов isDefinedAt на полученной частичной функции может применить первую частичную функцию и выполнить её побочное действие. Для повышения эффективности рекомендуется использовать applyOrElse вместо isDefinedAt / apply.

C

тип результата функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения этой частичной функции, суженной другой частичной функцией, которая отображает аргументы x в k(this(x)).

Definition Classes
PartialFunction

def andThen[C](k: (Nothing) => C): PartialFunction[Int, C]

Составляет эту частичную функцию с функцией преобразования, которая применяется к результатам этой частичной функции.

Если тип функции во время выполнения является PartialFunction, то используется другой метод andThen (обратите внимание на его предостережения).

C

тип результата функции преобразования.

k

функция преобразования

возвращает

частичная функция с областью определения этой частичной функции, возможно суженная заданной функцией, которая отображает аргументы x на k(this(x)).

Классы определения
PartialFunction → Function1

def appended[B >: Nothing](elem: B): List[B]

Копия этого набора с добавленным элементом.

Примечание: не будет завершаться для наборов бесконечного размера.

Пример:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)
B

тип элемента возвращаемого набора.

elem

добавляемый элемент

возвращает

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

Классы определения
StrictOptimizedSeqOps → SeqOps

def appendedAll[B >: Nothing](suffix: IterableOnce[B]): List[B]

Возвращает новый список, содержащий элементы из левого операнда, после которых следуют элементы из правого операнда. Тип элемента списка — это наиболее специфический суперкласс, охватывающий типы элементов двух операндов.

B

тип элемента возвращаемой коллекции.

suffix

перечисляемый для добавления.

возвращает

новая коллекция типа CC[B], которая содержит все элементы этого списка, после которых следуют все элементы suffix.

Классы определения
List → StrictOptimizedSeqOps → SeqOps

def apply(n: Int): Nothing

Получить элемент по указанному индексу. Эта операция предоставляется для удобства в Seq. Не следует предполагать её эффективность, если у вас нет IndexedSeq.

Definition Classes
LinearSeqOps → SeqOps
Annotations
@throws(scala.this.throws.<init>$default$1[IndexOutOfBoundsException])

def applyOrElse[A1 <: Int, B1 >: Nothing](x: A1, default: (A1) => B1): B1

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

Обратите внимание, что выражение pf.applyOrElse(x, default) эквивалентно

if(pf isDefinedAt x) pf(x) else default(x)

за исключением того, что метод applyOrElse может быть реализован более эффективно. Для всех литералов частичных функций компилятор генерирует реализацию applyOrElse, которая избегает двойной оценки предикатных совпадений и условий. Это делает applyOrElse основой для эффективной реализации во многих операциях и сценариях, таких как:

    соединение частичных функций в orElse/andThen цепочки не приводит к чрезмерной apply/isDefinedAt оценке lift и unlift не оценивают исходные функции дважды при каждом вызове runWith позволяет эффективно комбинировать частичные функции в императивном стиле с условными действиями

Для классов частичных функций, отличных от литералов, с нетривиальным методом isDefinedAt рекомендуется переопределить метод applyOrElse с настраиваемой реализацией, которая избегает двойной оценки isDefinedAt. Это может привести к лучшей производительности и более предсказуемому поведению относительно побочных эффектов.

x

аргумент функции

default

функция по умолчанию

returns

результат применения этой функции или функции по умолчанию.

Definition Classes
PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

Преобразовать объект-получатель к типу T0.

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

returns

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

Definition Classes
Any
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

Объект, с которым должна сравниваться эта последовательность

returns

true, если эта последовательность может быть равна that, false в противном случае. Тест учитывает только типы объектов во время выполнения, но игнорирует их элементы.

Definition Classes
Seq → Equals

def className: String

Определяет префикс представления этого объекта toString.

Рекомендуется возвращать имя конкретного типа коллекции, а не подклассов реализации. Например, для ListMap этот метод должен возвращать "ListMap", а не "Map" (супертип) или "Node" (подкласс реализации).

По умолчанию реализация возвращает "Iterable". Она переопределяется для основных типов коллекций "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" и "View".

returns

строковое представление, которое начинается с результата toString, применённого к этому списку. По умолчанию строковый префикс - это простое имя класса коллекции список.

Attributes
protected[this]
Definition Classes
List → Iterable

def clone(): AnyRef

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

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

returns

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

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

final def coll: Nil.this.type

returns

Эта коллекция как C.

Attributes
protected
Definition Classes
Iterable → IterableOps

final def collect[B](pf: PartialFunction[Nothing, B]): List[B]

Создаёт новый список, применяя частичную функцию ко всем элементам этого списка, для которых эта функция определена.

B

тип элементов возвращаемого списка.

pf

частичная функция, которая фильтрует и отображает список.

returns

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

Definition Classes
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Повторное использование: После вызова этого метода следует отказаться от итератора, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе.

def collectFirst[B](pf: PartialFunction[Nothing, B]): Option[B]

Находит первый элемент коллекции, для которого заданная частичная функция определена, и применяет частичную функцию к нему.

Примечание: может не завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип коллекции не упорядочен.

pf

частичная функция

returns

значение типа Option, содержащее результат применения pf к первому элементу, для которого функция определена, или None, если такого элемента нет.

Definition Classes
IterableOnceOps
Пример:

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def combinations(n: Int): Iterator[List[Nothing]]

Итерирует по комбинациям. _Комбинация_ длины n — это подпоследовательность исходной последовательности, элементы которой взяты в порядке. Таким образом, "xy" и "yy" являются комбинациями длины 2 последовательности "xyy", но "yx" таковой не является. Если существует более одного способа сгенерировать одну и ту же подпоследовательность, будет возвращён только один.

Например, "xyyy" имеет три различных способа сгенерировать "xy" в зависимости от того, какой элемент — первый, второй или третий "y" — выбран. Однако, так как все они идентичны, будет выбран только один. Какой из трёх будет выбран, является деталью реализации, которая не определена.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

returns

Итератор, который проходит по возможным комбинациям из n элементов этой последовательности.

Definition Classes
SeqOps
Пример:

    "abbbc".combinations(2) = Iterator(ab, ac, bb, bc)

def compose[R](k: PartialFunction[R, Int]): PartialFunction[R, Nothing]

Компонует другую частичную функцию k с этой частичной функцией таким образом, что эта частичная функция применяется к результатам k.

Обратите внимание, что вызов isDefinedAt для результирующей частичной функции может применить первую частичную функцию и выполнить её побочное действие. Крайне рекомендуется использовать applyOrElse вместо isDefinedAt / apply для повышения эффективности.

R

тип параметра функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения другой частичной функции, суженной этой частичной функцией, которая отображает аргументы x в this(k(x)).

Definition Classes
PartialFunction

def compose[A](g: (A) => Int): (A) => Nothing

Компонует две инстанции Function1 в новую Function1, при этом эта функция применяется последней.

A

тип, к которому можно применить функцию g

g

функция A => T1

returns

новая функция f, такая что f(x) == apply(g(x))

Definition Classes
Function1
Annotations
@unspecialized()

final def concat[B >: Nothing](suffix: IterableOnce[B]): List[B]

Возвращает новую последовательность, содержащую элементы левого операнда, за которыми следуют элементы правого операнда. Тип элементов последовательности — это наиболее специфичный суперкласс, охватывающий типы элементов двух операндов.

B

тип элементов возвращаемого набора.

suffix

проходимая последовательность для добавления.

returns

новая последовательность, содержащая все элементы этой последовательности, за которыми следуют все элементы suffix.

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

final def contains[A1 >: Nothing](elem: A1): Boolean

Проверяет, содержит ли этот список заданное значение в качестве элемента.

elem

элемент для проверки.

returns

true, если в этом списке есть элемент, равный (как определяется ==) elem; false в противном случае.

Definition Classes
List → LinearSeqOps → SeqOps

def containsSlice[B](that: collection.Seq[B]): Boolean

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

Примечание: может не завершаться для последовательностей бесконечного размера.

that

последовательность для проверки

returns

true, если эта последовательность содержит фрагмент с теми же элементами, что и that; в противном случае false.

Definition Classes
SeqOps

def copyToArray[B >: Nothing](xs: Array[B], start: Int, len: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs, начиная с индекса start, не более чем len элементами из этого набора.

Копирование прекращается, когда скопированы все элементы этого набора, или достигнут конец массива, или len элементов были скопированы.

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс массива xs.

len

максимальное количество элементов для копирования.

returns

количество элементов, записанных в массив

Definition Classes
IterableOnceOps
Note

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван. Использование после этого метода не определено и может измениться. Примечание: не завершится для коллекций бесконечного размера.

def copyToArray[B >: Nothing](xs: Array[B], start: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs, начиная с индекса start, значениями из этой коллекции.

Копирование прекращается, когда скопированы все элементы этой коллекции или достигнут конец массива.

B

тип элементов массива.

xs

массив для заполнения.

start

начальный индекс массива xs.

returns

количество элементов, записанных в массив. Примечание: не завершится для коллекций бесконечного размера.

Definition Classes
IterableOnceOps

def copyToArray[B >: Nothing](xs: Array[B]): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs, начиная с индекса start, значениями из этой коллекции.

Копирование прекращается, когда скопированы все элементы этой коллекции или достигнут конец массива.

B

тип элементов массива.

xs

массив для заполнения.

returns

количество элементов, записанных в массив. Примечание: не завершится для коллекций бесконечного размера.

Definition Classes
IterableOnceOps

def corresponds[B](that: collection.Seq[B])(p: (Nothing, B) => Boolean): Boolean

Проверяет, соответствует ли каждый элемент этого списка соответствующему элементу другой последовательности, удовлетворяя предикату проверки.

B

тип элементов that

that

другая последовательность

p

предикат проверки, связывающий элементы из обеих последовательностей

returns

true, если обе последовательности имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x этого списка и y из that, в противном случае false.

Definition Classes
List → SeqOps

def corresponds[B](that: IterableOnce[B])(p: (Nothing, B) => Boolean): Boolean

Проверяет, удовлетворяют ли каждый элемент итератора этого набора условию предикатом проверки соответствующему элементу другого набора.

B

тип элементов that

that

другой набор

p

предикат проверки, связывающий элементы из обоих наборов

returns

true, если оба набора имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x итератора этого набора и y из that, в противном случае false

Definition Classes
IterableOnceOps

def count(p: (Nothing) => Boolean): Int

Подсчитывает количество элементов в наборе, удовлетворяющих предикату.

p

предикат для проверки элементов.

returns

количество элементов, удовлетворяющих предикату p.

Definition Classes
IterableOnceOps

def diff[B >: Nothing](that: collection.Seq[B]): List[Nothing]

Вычисляет разность множеств для данной последовательности и другой последовательности.

that

последовательность элементов для удаления

returns

новая последовательность, содержащая все элементы этой последовательности, за исключением некоторых вхождений элементов, которые также присутствуют в that. Если значение элемента x появляется n раз в that, то первые n вхождений x не будут частью результата, но любые последующие вхождения будут.

Definition Classes
StrictOptimizedSeqOps → SeqOps

def distinct: List[Nothing]

Выбирает все элементы этой последовательности, игнорируя дубликаты.

returns

новая последовательность, состоящая из всех элементов этой последовательности без дубликатов.

Definition Classes
SeqOps

def distinctBy[B](f: (Nothing) => B): List[Nothing]

Выбирает все элементы этой неизменяемой последовательности, игнорируя дубликаты, определяемые по результату применения функции преобразования == к каждому элементу после применения функции преобразования f.

B

тип элементов после преобразования функцией f

f

Функция преобразования, результат которой используется для определения уникальности каждого элемента

returns

новая неизменяемая последовательность, содержащая все элементы этой неизменяемой последовательности без дубликатов.

Definition Classes
StrictOptimizedSeqOps → StrictOptimizedSeqOps → SeqOps

def drop(n: Int): List[Nothing]

Выбирает все элементы, кроме первых n.

n

количество элементов, которые нужно удалить из этой последовательности.

returns

последовательность, содержащая все элементы этой последовательности, за исключением первых n элементов, или пустая последовательность, если в этой последовательности меньше n элементов. Если n отрицательное, то не удалять ни одного элемента.

Definition Classes
StrictOptimizedLinearSeqOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода необходимо отказаться от итератора, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе тоже.

def dropRight(n: Int): List[Nothing]

Остальная часть коллекции без её последних элементов. Для линейных неизменяемых коллекций это должно избежать создания копии.

Примечание: Даже при применении к представлению или ленивой коллекции, элементы всегда будут принудительно получены.

n

количество элементов для удаления из этой итерируемой коллекции.

returns

итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, кроме последних n, или же пустая итерируемая коллекция, если в этой итерируемой коллекции меньше n элементов. Если n отрицательно, не удалять ни одного элемента.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def dropWhile(p: (Nothing) => Boolean): List[Nothing]

Удаляет самую длинную префиксную последовательность элементов, удовлетворяющих предикату.

p

Предикат, используемый для проверки элементов.

returns

самый длинный суффикс этой последовательности, первый элемент которого не удовлетворяет предикату p.

Definition Classes
StrictOptimizedLinearSeqOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенный итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе также.

def elementWise: ElementWiseExtractor[Int, Nothing]

Возвращает объект-экстрактор с методом unapplySeq, который извлекает каждый элемент данных последовательности.

Definition Classes
PartialFunction
Пример:
    val firstChar: String => Option[Char] = _.headOption
    
    Seq("foo", "bar", "baz") match {
      case firstChar.unlift.elementWise(c0, c1, c2) =>
        println(s"$c0, $c1, $c2") // Output: f, b, b
    }

def empty: List[Nothing]

Пустая итерируемая коллекция того же типа, что и эта итерируемая коллекция.

returns

пустая итерируемая коллекция типа C.

Definition Classes
IterableFactoryDefaults → IterableOps

def endsWith[B >: Nothing](that: collection.Iterable[B]): Boolean

Проверяет, заканчивается ли эта последовательность заданной последовательностью.

Примечание: не завершится для бесконечно больших коллекций.

that

последовательность для проверки

returns

true, если эта последовательность имеет that в качестве суффикса, false в противном случае.

Definition Classes
SeqOps

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 в противном случае.

Definition Classes
AnyRef

def equals(o: Any): Boolean

Универсальный метод равенства, определённый в AnyRef.

Definition Classes
List → Seq → Equals → AnyRef → Any

final def exists(p: (Nothing) => Boolean): Boolean

Проверяет, выполняется ли предикат для хотя бы одного элемента этого списка.

p

предикат, используемый для проверки элементов.

returns

true, если заданный предикат p удовлетворяется хотя бы одним элементом этого списка, в противном случае false

Definition Classes
List → LinearSeqOps → IterableOnceOps

def filter(p: (Nothing) => Boolean): List[Nothing]

Выбирает все элементы этого списка, которые удовлетворяют предикату.

p

предикат, используемый для проверки элементов.

returns

новый итератор, состоящий из всех элементов этого списка, которые удовлетворяют заданному предикату p. Порядок элементов сохраняется.

Definition Classes
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def filterImpl(pred: (Nothing) => Boolean, isFlipped: Boolean): List[Nothing]

Attributes
protected[scala.collection]
Definition Classes
StrictOptimizedIterableOps

def filterNot(p: (Nothing) => Boolean): List[Nothing]

Выбирает все элементы этого списка, которые не удовлетворяют предикату.

returns

новый список, состоящий из всех элементов этого списка, которые не удовлетворяют заданному предикату pred. Порядок элементов может быть не сохранён.

Definition Classes
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

final def find(p: (Nothing) => Boolean): Option[Nothing]

Находит первый элемент в списке, удовлетворяющий предикату, если таковой имеется.

p

предикат для проверки элементов.

возвращает

объект типа Option, содержащий первый элемент в списке, удовлетворяющий p, или None, если таковой не существует.

Определяющие классы
List → LinearSeqOps → IterableOnceOps

def findLast(p: (Nothing) => Boolean): Option[Nothing]

Находит последний элемент в последовательности, удовлетворяющий предикату, если таковой имеется.

Примечание: не будет завершаться для бесконечных коллекций.

p

предикат для проверки элементов.

возвращает

объект типа Option, содержащий последний элемент в последовательности, удовлетворяющий p, или None, если таковой не существует.

Определяющие классы
LinearSeqOps → SeqOps

final def flatMap[B](f: (Nothing) => IterableOnce[B]): List[B]

Создаёт новый список, применяя функцию ко всем элементам этого списка и используя элементы полученных коллекций.

Например:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

Тип результирующей коллекции определяется статическим типом списка. Это может иногда приводить к неожиданным результатам. Например:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
B

тип элементов возвращаемой коллекции.

f

функция, которая применяется к каждому элементу.

returns

новый список, полученный путём применения заданной функции, возвращающей коллекцию f, к каждому элементу этого списка и конкатенации результатов.

Definition Classes
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Повторное использование: после вызова этого метода нужно удалить итератор, на котором был вызван метод, и использовать только возвращённый итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе также.

def flatten[B](implicit toIterableOnce: (Nothing) => IterableOnce[B]): List[B]

Преобразует эту итерируемую коллекцию из перебираемых коллекций в итерируемую коллекцию, образованную из элементов этих перебираемых коллекций.

Тип результирующей коллекции будет определяться типом итерируемой коллекции. Например:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)
B

тип элементов каждой перебираемой коллекции.

returns

новая итерируемая коллекция, полученная путём конкатенации всех итерируемых коллекций элементов.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Повторное использование: после вызова этого метода нужно удалить итератор, на котором был вызван метод, и использовать только возвращённый итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе также.

def fold[A1 >: Nothing](z: A1)(op: (A1, A1) => A1): A1

Складывает элементы этого набора, используя заданный ассоциативный бинарный оператор. Реализация по умолчанию в IterableOnce эквивалентна foldLeft, но может быть переопределена для более эффективного порядка обхода.

Порядок выполнения операций над элементами не определён и может быть недетерминированным.

Примечание: не завершит работу для наборов бесконечного размера.

A1

тип параметр для бинарного оператора, супертип A.

z

нейтральный элемент для операции сложения; может быть добавлен в результат произвольное количество раз и не должен изменять результат (например, Nil для конкатенации списков, 0 для сложения или 1 для умножения).

op

бинарный оператор, который должен быть ассоциативным.

returns

результат применения оператора сложения op между всеми элементами и z, или z, если этот набор пуст.

Definition Classes
IterableOnceOps

def foldLeft[B](z: B)(op: (B, Nothing) => B): B

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

Примечание: не завершит работу для наборов бесконечного размера.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой последовательности слева направо с начальным значением z слева:

op(...op(z, x_1), x_2, ..., x_n)

где x1, ..., xn - элементы этой последовательности. Возвращает z, если эта последовательность пуста.

Definition Classes
LinearSeqOps → IterableOnceOps

final def foldRight[B](z: B)(op: (Nothing, B) => B): B

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

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого списка, двигаясь справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn - элементы этого списка. Возвращает z, если этот список пуст.

Definition Classes
List → IterableOnceOps

final def forall(p: (Nothing) => Boolean): Boolean

Проверяет, выполняется ли предикат для всех элементов этого списка.

p

предикат, используемый для проверки элементов.

returns

true, если этот список пуст или данный предикат p выполняется для всех элементов этого списка, в противном случае false.

Definition Classes
List → LinearSeqOps → IterableOnceOps

final def foreach[U](f: (Nothing) => U): Unit

Применяет f к каждому элементу для побочных эффектов. Примечание: параметр [U] необходим для помощи в инференции типов scalac.

Definition Classes
List → LinearSeqOps → IterableOnceOps
Annotations
@inline()

def fromSpecific(coll: IterableOnce[Nothing]): List[Nothing]

Определяет, как преобразовать заданную Iterable[A] в коллекцию типа C.

Этот процесс может выполняться строго или нестрого (т.е. без оценки элементов результирующих коллекций). Другими словами, этот метод определяет модель оценки коллекции.

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (иначе компилятор выдаст ошибку). В общем случае, где C =:= CC[A], это можно сделать, добавив в миксин IterableFactoryDefaults, который реализует метод с помощью iterableFactory.

,

Как свидетельствует аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, при условии, что он вызывается с Iterable[A], полученной из this коллекции (как это происходит в реализациях операций, где мы используем View[A]), он безопасен.

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def groupBy[K](f: (Nothing) => K): Map[K, List[Nothing]]

Разделяет это итерируемое коллекцию на карту итерируемых коллекций в соответствии с функцией-дискриминатором.

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

K

тип ключей, возвращаемых функцией-дискриминатором.

f

функция-дискриминатор.

returns

Карта, сопоставляющая ключи итерируемым коллекциям, для которой выполняется следующее инвариантное свойство:

(xs groupBy f)(k) = xs filter (x => f(x) == k)

То есть, каждый ключ k привязан к итерируемой коллекции тех элементов x, для которых f(x) равно k.

Definition Classes
IterableOps

def groupMap[K, B](key: (Nothing) => K)(f: (Nothing) => B): Map[K, List[B]]

Разделяет это итерируемое коллекцию на карту итерируемых коллекций согласно функции-дискриминатору key. Каждый элемент в группе преобразуется в значение типа B с помощью функции value.

Эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Примечание: даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

K

тип ключей, возвращаемых функцией-дискриминатором

B

тип значений, возвращаемых функцией преобразования

key

функция-дискриминатор

f

функция преобразования элементов

Definition Classes
IterableOps

def groupMapReduce[K, B](key: (Nothing) => K)(f: (Nothing) => B)(reduce: (B, B) => B): Map[K, B]

Разделяет этот итерируемый набор на карту в соответствии с функцией-дискриминатором key. Все значения, имеющие одинаковый дискриминатор, затем преобразуются с помощью функции value, а затем сводятся к одному значению с помощью функции reduce.

Это эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Примечание: Даже при применении к представлению или ленивому набору, он всегда принудительно обрабатывает элементы.

Definition Classes
IterableOps

def grouped(size: Int): Iterator[List[Nothing]]

Разделяет элементы на итерируемые наборы фиксированного размера.

size

количество элементов в группе

returns

Итератор, генерирующий итерируемые наборы размера size, за исключением последнего, который будет меньше, чем size size, если элементы не делятся нацело.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод grouped

def hashCode(): Int

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

returns

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

Definition Classes
Seq → AnyRef → Any

def head: Nothing

Возвращает первый элемент этого списка.

returns

первый элемент этого списка.

Definition Classes
Nil → LinearSeqOps → IterableOps
Exceptions thrown

NoSuchElementException, если список пуст.

def headOption: None.type

Возвращает первый элемент, если он существует, иначе - значение None.

возвращает

первый элемент этого списка, если он не пуст, значение None, если список пуст.

Определяющие классы
Nil → LinearSeqOps → IterableOps

def indexOf[B >: Nothing](elem: B): Int

Находит индекс первого вхождения значения в этой последовательности.

B

тип элемента.

elem

значение элемента для поиска.

возвращает

индекс первого элемента в этой последовательности, равного (как определяется по заданному принципу) заданному значению, или -1, если такого элемента не существует.

Определяющие классы
SeqOps
Аннотации
@deprecatedOverriding("Override indexOf(elem, from) instead - indexOf(elem) calls indexOf(elem, 0)", "2.13.0")

def indexOf[B >: Nothing](elem: B, from: Int): Int

Находит индекс первого вхождения значения в этой последовательности после или на заданном стартовом индексе.

B

тип элемента.

elem

значение элемента для поиска.

from

стартовый индекс

возвращает

индекс первого элемента в этой последовательности, равного (как определяется по заданному принципу) заданному значению, или -1, если такого элемента не существует.

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

def indexOfSlice[B >: Nothing](that: collection.Seq[B]): Int

Находит первый индекс, где эта последовательность содержит заданную последовательность в качестве подпоследовательности.

Примечание: может не завершаться для бесконечных коллекций.

that

последовательность для проверки

returns

первый индекс >= 0, такой что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1, если такая подпоследовательность не существует.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexOfSlice(that, from) instead - indexOfSlice(that) calls indexOfSlice(that, 0)", "2.13.0")

def indexOfSlice[B >: Nothing](that: collection.Seq[B], from: Int): Int

Находит первый индекс после или на заданном начальном индексе, где эта последовательность содержит заданную последовательность в качестве подпоследовательности.

Примечание: может не завершаться для бесконечных коллекций.

that

последовательность для проверки

from

начальный индекс

returns

первый индекс >= from, такой что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1, если такая подпоследовательность не существует.

Definition Classes
SeqOps

def indexWhere(p: (Nothing) => Boolean, from: Int): Int

Находит индекс первого элемента, удовлетворяющего некоторому предикату после или на заданном начальном индексе.

Примечание: может не завершаться для бесконечных коллекций.

p

предикат, используемый для проверки элементов.

from

начальный индекс

returns

индекс >= from первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если таковой не существует.

Definition Classes
LinearSeqOps → SeqOps

def indexWhere(p: (Nothing) => Boolean): Int

Находит индекс первого элемента, удовлетворяющего некоторому предикату.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

возвращает

индекс >= 0 первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Классы определений
SeqOps
Аннотации
@deprecatedOverriding("Override indexWhere(p, from) вместо этого - indexWhere(p) вызывает indexWhere(p, 0)", "2.13.0")

def indices: Range

Создаёт диапазон всех индексов этой последовательности.

Примечание: Даже при применении к представлению или ленивой коллекции элементы всегда будут форсированы.

возвращает

значение Range от 0 до значения, на единицу меньшего, чем длина этой последовательности.

Классы определений
SeqOps

def init: Nothing

Начальная часть коллекции без последнего элемента.

Примечание: Даже при применении к представлению или ленивой коллекции элементы всегда будут форсированы.

Классы определений
Nil → IterableOps

def inits: Iterator[List[Nothing]]

Итерируется по начальным частям (inits) этой итерируемой коллекции. Первое значение будет этой итерируемой коллекцией, а последнее — пустой итерируемой коллекцией, а промежуточные значения будут результатами последовательного применения init.

Примечание: Даже при применении к представлению или ленивой коллекции элементы всегда будут форсированы.

возвращает

итератор по всем начальным частям (inits) этой итерируемой коллекции

Классы определений
IterableOps
Пример:

    List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

def intersect[B >: Nothing](that: collection.Seq[B]): List[Nothing]

Вычисляет пересечение мультимножества между этой последовательностью и другой последовательностью.

that

последовательность элементов для пересечения.

возвращает

новая последовательность, которая содержит все элементы этой последовательности, которые также присутствуют в that. Если значение элемента x появляется n раз в that, то первые n вхождений x будут сохранены в результате, но любые последующие вхождения будут опущены.

Определяющие классы
StrictOptimizedSeqOps → SeqOps

def isDefinedAt(x: Int): Boolean

Проверяет, содержит ли эта последовательность указанный индекс.

Реализации методов apply и isDefinedAt преобразуют Seq[A] в PartialFunction[Int, A].

возвращает

true, если эта последовательность содержит элемент в позиции idx, false в противном случае.

Определяющие классы
LinearSeqOps → SeqOps

final def isEmpty: Boolean

Проверяет, является ли список пустым.

Примечание: Реализации в подклассах, которые не являются многократно проходимыми, должны позаботиться о том, чтобы не потреблять какие-либо элементы при вызове isEmpty.

возвращает

true, если список не содержит элементов, false в противном случае.

Определяющие классы
List → LinearSeqOps → SeqOps → IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def isTraversableAgain: Boolean

Проверяет, можно ли многократно пройти по этому итерируемому набору. Всегда истинно для Iterables и ложно для Iterators, если не переопределено.

returns

true, если можно многократно пройти, false в противном случае.

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: SeqFactory[List]

Объект-компаньон этого списка, предоставляющий различные методы фабрики.

Definition Classes
List → LinearSeq → LinearSeq → Seq → Iterable → Seq → Iterable → IterableOps
Note

При реализации пользовательского типа коллекции и уточнении CC до нового типа, этот метод должен быть переопределен для возвращения фабрики для нового типа (в противном случае компилятор выдаст ошибку).

def iterator: Iterator[Nothing]

Итератор может быть использован только один раз

Definition Classes
Nil → StrictOptimizedLinearSeqOps → LinearSeqOps → IterableOnce

def knownSize: Int

returns

Количество элементов в этом списке, если его можно легко вычислить, -1 в противном случае. Легко вычислить обычно означает: не требует обхода коллекции.

Definition Classes
Nil → IterableOnce

def last: Nothing

Выбирает последний элемент.

returns

Последний элемент этого списка.

Definition Classes
Nil → List → LinearSeqOps → IterableOps
Exceptions thrown

NoSuchElementException Если список пуст.

def lastIndexOf[B >: Nothing](elem: B, end: Int = length - 1): Int

Находит индекс последнего вхождения некоторого значения в этой последовательности до или на заданном индексе конца.

Примечание: не будет завершаться для коллекций бесконечного размера.

B

тип элемента elem.

elem

значение элемента для поиска.

end

индекс конца.

returns

индекс <= end последнего элемента этой последовательности, равного (как определяется ==) elem, или -1, если он не существует.

Definition Classes
SeqOps

def lastIndexOfSlice[B >: Nothing](that: collection.Seq[B]): Int

Находит последний индекс, где эта последовательность содержит заданную последовательность как срез.

Примечание: не будет завершаться для коллекций бесконечного размера.

that

последовательность для проверки

returns

последний индекс, такой, что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1, если такая подпоследовательность не существует.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override lastIndexOfSlice(that, end) instead - lastIndexOfSlice(that) calls lastIndexOfSlice(that, Int.MaxValue)", "2.13.0")

def lastIndexOfSlice[B >: Nothing](that: collection.Seq[B], end: Int): Int

Находит последний индекс до или на заданном конечном индексе, где эта последовательность содержит заданную последовательность как срез.

Примечание: не будет завершаться для коллекций бесконечного размера.

that

последовательность для проверки

end

конечный индекс

returns

последний индекс <= end, такой что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1, если такой подпоследовательности не существует.

Definition Classes
SeqOps

def lastIndexWhere(p: (Nothing) => Boolean, end: Int): Int

Находит индекс последнего элемента, удовлетворяющего некоторому предикату до или на заданном конечном индексе.

Примечание: не будет завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

индекс <= end последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
LinearSeqOps → SeqOps

def lastIndexWhere(p: (Nothing) => Boolean): Int

Находит индекс последнего элемента, удовлетворяющего некоторому предикату.

Примечание: не будет завершаться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

индекс последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override lastIndexWhere(p, end) instead - lastIndexWhere(p) calls lastIndexWhere(p, Int.MaxValue)", "2.13.0")

def lastOption: Option[Nothing]

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

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

последний элемент этой итерируемой коллекции, если она не пуста, None, если она пуста.

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[Nothing, B, Nil.this.type]

Аналогично zip, за исключением того, что элементы в каждом наборе не потребляются до тех пор, пока не будет вызвано строгое действие над возвращенным LazyZip2 декоратором.

Вызовы lazyZip могут быть объединены для поддержки более высоких арностей (до 4) без затрат на построение и деструктурирование промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

тип второго элемента в каждой возможной паре

that

итерируемый объект, предоставляющий второй элемент каждой возможной пары

returns

декоратор LazyZip2, который позволяет выполнять строгие операции над лениво вычисляемыми парами или объединять вызовы lazyZip. Поддерживается также неявное преобразование в Iterable[(A, B)].

Definition Classes
Iterable

final def length: Int

Длина (количество элементов) списка. size — псевдоним для length в Seq коллекциях.

Definition Classes
List → LinearSeqOps → SeqOps

final def lengthCompare(len: Int): Int

Сравнивает длину этого списка со значением-тестом.

len

значение-тест, которое сравнивается с длиной.

returns

Значение x, где

x <  0       if this.length <  len
x == 0       if this.length == len
x >  0       if this.length >  len

Реализация данного метода не вызывает length напрямую; её время выполнения составляет O(length min len), а не O(length). Метод следует переопределять, если вычисление length является быстрым, а knownSize возвращает -1.

Definition Classes
List → LinearSeqOps → SeqOps
See also

lengthIs

def lengthCompare(that: collection.Iterable[_]): Int

Сравнивает длину этой последовательности с размером другого Iterable.

that

Iterable, размер которого сравнивается с длиной этой последовательности.

returns

Значение x, где

x <  0       if this.length <  that.size
x == 0       if this.length == that.size
x >  0       if this.length >  that.size

Реализация данного метода не вызывает length или size напрямую; её время выполнения составляет O(this.length min that.size), а не O(this.length + that.size). Метод следует переопределять, если вычисление size является быстрым, а knownSize возвращает -1.

Definition Classes
LinearSeqOps → SeqOps

final def lengthIs: SizeCompareOps

Возвращает значение класса, содержащего операции для сравнения длины этой последовательности со значением-тестом.

Эти операции реализованы с точки зрения lengthCompare(Int), и позволяют использовать следующие более читаемые варианты:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0
Definition Classes
SeqOps
Annotations
@inline()

def lift: (Int) => Option[Nothing]

Преобразует эту частичную функцию в обычную функцию, возвращающую результат Option.

returns

функцию, которая принимает аргумент x и возвращает Some(this(x)), если this определено для x, и None в противном случае.

Definition Classes
PartialFunction
See also

Function.unlift

final def map[B](f: (Nothing) => B): List[B]

Создаёт новый список, применяя функцию ко всем элементам этого списка.

B

тип элементов возвращаемого списка.

f

функция, применяемая к каждому элементу.

returns

новый список, полученный путём применения заданной функции f к каждому элементу этого списка и сбора результатов.

Definition Classes
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода нужно удалить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора неопределённо, может измениться, и может привести к изменениям в новом итераторе тоже.

final def mapConserve[B >: Nothing <: AnyRef](f: (Nothing) => B): List[B]

Создаёт новый список, применяя функцию ко всем элементам этого списка. Подобно xs map f, но возвращает xs неизменным, если функция f отображает все элементы на себя (как определено eq).

B

тип элементов возвращаемого набора.

f

функция, которая должна быть применена к каждому элементу.

returns

список, полученный путём применения заданной функции f к каждому элементу этого списка и сбора результатов.

Definition Classes
List
Annotations
@inline()

def max[B >: Nothing](implicit ord: math.Ordering[B]): Nothing

Находит наибольший элемент.

B

Тип, по которому определяется упорядочение.

ord

Упорядочение, используемое для сравнения элементов.

returns

наибольший элемент этого набора относительно заданного упорядочения ord.

Definition Classes
IterableOnceOps
Исключения

UnsupportedOperationException, если этот набор пустой.

def maxBy[B](f: (Nothing) => B)(implicit cmp: math.Ordering[B]): Nothing

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Упорядочение, используемое для сравнения элементов.

returns

первый элемент этого набора с наибольшим значением, измеренным функцией f, относительно упорядочения cmp.

Definition Classes
IterableOnceOps
Исключения

UnsupportedOperationException, если этот набор пустой.

def maxByOption[B](f: (Nothing) => B)(implicit cmp: math.Ordering[B]): Option[Nothing]

Находит первый элемент, который дает наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, который будет использоваться для сравнения элементов.

returns

значение типа Option, содержащее первый элемент этого набора с наибольшим значением, измеренным функцией f относительно порядка cmp.

Definition Classes
IterableOnceOps

def maxOption[B >: Nothing](implicit ord: math.Ordering[B]): Option[Nothing]

Находит наибольший элемент.

B

Тип, по которому определен порядок.

ord

Порядок, который будет использоваться для сравнения элементов.

returns

значение типа Option, содержащее наибольший элемент этого набора относительно порядка ord.

Definition Classes
IterableOnceOps

def min[B >: Nothing](implicit ord: math.Ordering[B]): Nothing

Находит наименьший элемент.

B

Тип, по которому определен порядок.

ord

Порядок, который будет использоваться для сравнения элементов.

returns

наименьший элемент этого набора относительно порядка ord.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если этот набор пуст.

def minBy[B](f: (Nothing) => B)(implicit cmp: math.Ordering[B]): Nothing

Находит первый элемент, который даёт наименьшее значение, измеряемое функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

первый элемент этого набора с наименьшим значением, измеренным функцией f, относительно порядка cmp.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если этот набор пуст.

def minByOption[B](f: (Nothing) => B)(implicit cmp: math.Ordering[B]): Option[Nothing]

Находит первый элемент, который даёт наименьшее значение, измеряемое функцией f.

B

Тип результата функции f.

f

Функция измерения.

cmp

Порядок, используемый для сравнения элементов.

returns

значение Option, содержащее первый элемент этого набора с наименьшим значением, измеренным функцией f, относительно порядка cmp.

Definition Classes
IterableOnceOps

def minOption[B >: Nothing](implicit ord: math.Ordering[B]): Option[Nothing]

Находит наименьший элемент.

B

Тип, для которого определён порядок.

ord

Порядок, используемый для сравнения элементов.

returns

значение Option, содержащее наименьший элемент этого набора относительно порядка ord.

Definition Classes
IterableOnceOps

final def mkString: String

Отображает все элементы этого набора в строке.

Делегирует вызов addString, который можно переопределить.

returns

строковое представление этого набора. В результирующей строке строковые представления (согласно методу toString) всех элементов этого набора следуют друг за другом без разделительной строки.

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

Отображает все элементы этого набора в строке с использованием разделителя.

Делегирует вызов addString, который может быть переопределён.

sep

строка-разделитель.

returns

строковое представление этого набора. В результирующей строке строковые представления (относительно метода toString) всех элементов этого набора разделены строкой sep.

Definition Classes
IterableOnceOps
Annotations
@inline()
Пример:

    List(1, 2, 3).mkString("|") = "1|2|3"

final def mkString(start: String, sep: String, end: String): String

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

Делегирует вызов addString, который может быть переопределён.

start

начальная строка.

sep

строка-разделитель.

end

конечная строка.

returns

строковое представление этого набора. Результирующая строка начинается со строки start и заканчивается строкой end. Внутри, строковые представления (относительно метода toString) всех элементов этого набора разделены строкой sep.

Definition Classes
IterableOnceOps
Пример:

    List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[Nothing, List[Nothing]]

возвращает

строгий билдер для того же типа коллекции. Обратите внимание, что в случае ленивых коллекций (например, View или immutable.LazyList), реализовать этот метод возможно, но полученный Builder нарушит ленивость. Вследствие этого, операции предпочтительно реализовывать с помощью fromSpecific вместо этого метода.

Атрибуты
protected
Определяющие классы
IterableFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, смешав в себе IterableFactoryDefaults trait, который реализует метод с использованием iterableFactory.

,

Как показывает аннотация @uncheckedVariance, использование этого метода может быть некорректным. Однако, пока возвращаемый билдер получает только A значения, взятые из this экземпляра, он безопасен.

def nonEmpty: Boolean

Проверяет, не пуста ли коллекция.

возвращает

true, если коллекция содержит как минимум один элемент, false в противном случае.

Определяющие классы
IterableOnceOps
Аннотации
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

def occCounts[B](sq: collection.Seq[B]): mutable.Map[B, Int]

Атрибуты
protected[scala.collection]
Классы определения
SeqOps

def orElse[A1 <: Int, B1 >: Nothing](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

Компонует данную частичную функцию с резервной частичной функцией, которая применяется в случае, если данная частичная функция не определена.

A1

тип аргумента резервной функции

B1

тип результата резервной функции

that

резервная функция

возвращает

частичная функция, область определения которой является объединением областей определения данной частичной функции и that. Результирующая частичная функция принимает x в this(x), где this определена, и в that(x), где она не определена.

Классы определения
PartialFunction

def padTo[B >: Nothing](len: Int, elem: B): List[B]

Копия этого последовательности с добавленными элементами-значениями до достижения заданной длины.

B

тип элементов возвращаемой последовательности.

len

целевая длина

elem

значение для заполнения

возвращает

новая последовательность, состоящая из всех элементов этой последовательности, за которыми следует минимальное количество вхождений elem, так что полученная коллекция имеет длину не менее len.

Классы определения
StrictOptimizedSeqOps → SeqOps

def partition(p: (Nothing) => Boolean): (List[Nothing], List[Nothing])

Пара, во-первых, всех элементов, удовлетворяющих предикату p, и, во-вторых, всех элементов, которые не удовлетворяют. Интересно, потому что это разделяет коллекцию на две части.

Предоставленная здесь реализация по умолчанию требует двух проходов по коллекции. Строгие коллекции имеют переопределённую версию partition в StrictOptimizedIterableOps, которая требует только одного прохода.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def partitionMap[A1, A2](f: (Nothing) => Either[A1, A2]): (List[A1], List[A2])

Применяет функцию f к каждому элементу итерируемой коллекции и возвращает пару итерируемых коллекций: первая состоит из значений, возвращённых f, которые были заключены в scala.util.Left, а вторая — из тех, которые были заключены в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип элементов первой результирующей коллекции

A2

тип элементов второй результирующей коллекции

f

функция 'разделения', отображающая элементы этой итерируемой коллекции в scala.util.Either

returns

пара итерируемых коллекций: первая состоит из значений, возвращённых f, которые были заключены в scala.util.Left, а вторая — из тех, которые были заключены в scala.util.Right.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def patch[B >: Nothing](from: Int, other: IterableOnce[B], replaced: Int): List[B]

Создаёт новую неизменяемую последовательность, где фрагмент элементов в этой неизменяемой последовательности заменяется другой последовательностью.

Замена по отрицательным индексам такая же, как замена, начинающаяся с 0. Замена по индексам, равным или большим длины исходной неизменяемой последовательности, добавляет замену в конец. Если заменяемых значений больше, чем фактически существует, избыток игнорируется.

B

тип элемента возвращаемой неизменяемой последовательности.

from

индекс первого заменяемого элемента

other

последовательность для замены

replaced

количество элементов для удаления в исходной неизменяемой последовательности

returns

новая неизменяемая последовательность, состоящая из всех элементов этой неизменяемой последовательности, за исключением того, что replaced элементов, начиная с from, заменяются всеми элементами other.

Definition Classes
StrictOptimizedSeqOps → SeqOps

def permutations: Iterator[List[Nothing]]

Итерация по различным перестановкам.

Примечание: Даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно вычисляться.

returns

Итератор, который проходит по различным перестановкам этой последовательности.

Definition Classes
SeqOps
Пример:

    "abb".permutations = Iterator(abb, bab, bba)

def prepended[B >: Nothing](elem: B): List[B]

Копия списка с добавленным элементом в начало.

Также, исходный список не изменяется, поэтому вам нужно будет сохранить результат.

Пример:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)
B

тип элемента возвращаемого списка.

elem

элемент, добавляемый в начало

returns

новый список, состоящий из value, за которым следуют все элементы этого списка.

Definition Classes
List → StrictOptimizedSeqOps → SeqOps

def prependedAll[B >: Nothing](prefix: IterableOnce[B]): List[B]

Как и :++, возвращает новую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда.

Она отличается от :++ тем, что правый операнд определяет тип результирующей коллекции, а не левый. Мемоническое правило: двоеточие стоит со стороны нового типа коллекции.

B

тип элементов возвращаемой коллекции.

prefix

итерируемый объект, который нужно добавить в начало.

returns

новый список, содержащий все элементы prefix, за которыми следуют все элементы этого списка.

Definition Classes
Список → StrictOptimizedSeqOps → SeqOps

def product[B >: Nothing](implicit num: math.Numeric[B]): B

Перемножает элементы этой коллекции.

B

тип результата оператора *.

num

неявный параметр, определяющий набор числовых операций, которые включают оператор *, используемый для вычисления произведения.

returns

произведение всех элементов этой коллекции относительно оператора * в num.

Definition Classes
IterableOnceOps

def productElementName(n: Int): Строка

Имя n-ого элемента этого произведения, нумерация с 0. В реализации по умолчанию — пустая строка.

n

индекс элемента, имя которого нужно вернуть

returns

имя указанного элемента

Definition Classes
Product
Exceptions thrown

IndexOutOfBoundsException, если индекс n находится вне диапазона (n < 0 || n >= productArity).

def productElementNames: Итератор[Строка]

Итератор по именам всех элементов этого произведения.

Definition Classes
Product

def reduce[B >: Nothing](op: (B, B) => B): B

Уменьшает элементы этой коллекции с использованием указанного ассоциативного бинарного оператора.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

B

Параметр типа для бинарного оператора, являющийся супертипом A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

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

Definition Classes
IterableOnceOps
Исключения

UnsupportedOperationException, если эта коллекция пуста.

def reduceLeft[B >: Nothing](op: (B, Nothing) => B): B

Применяет бинарный оператор ко всем элементам этой коллекции слева направо.

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип коллекции по умолчанию не упорядочен, или оператор не является ассоциативным и коммутативным.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции слева направо:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

где x1, ..., xn - элементы этой коллекции.

Definition Classes
IterableOnceOps
Исключения

UnsupportedOperationException если эта коллекция пуста.

def reduceLeftOption[B >: Nothing](op: (B, Nothing) => B): Option[B]

Необязательно применяет бинарный оператор ко всем элементам этой коллекции слева направо.

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип коллекции по умолчанию не упорядочен, или оператор не является ассоциативным и коммутативным.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение option, содержащее результат reduceLeft(op), если эта коллекция не пуста, None в противном случае.

Definition Classes
IterableOnceOps

def reduceOption[B >: Nothing](op: (B, B) => B): Option[B]

Применяет заданный ассоциативный бинарный оператор к элементам этой коллекции, если таковые имеются.

Порядок выполнения операций над элементами не определён и может быть не детерминированным.

B

Тип параметра для бинарного оператора, являющийся супертипом A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Значение типа Option, содержащее результат применения оператора reduce к всем элементам коллекции, если коллекция не пуста, и None в противном случае.

Definition Classes
IterableOnceOps

def reduceRight[B >: Nothing](op: (Nothing, B) => B): B

Применяет бинарный оператор ко всем элементам этой коллекции, справа налево.

Примечание: не завершит работу для коллекций бесконечной длины.

Примечание: может возвращать разные результаты при разных запусках, если тип коллекции не упорядочен или оператор не ассоциативен и не коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этой коллекции справа налево:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

где x1, ..., xn — элементы этой коллекции.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException, если эта коллекция пуста.

def reduceRightOption[B >: Nothing](op: (Nothing, B) => B): Option[B]

Необязательно применяет бинарный оператор ко всем элементам этой коллекции справа налево.

Примечание: не завершит работу для коллекций бесконечной длины.

Примечание: может возвращать разные результаты при разных запусках, если тип коллекции не упорядочен или оператор не ассоциативен и не коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение типа Option, содержащее результат применения оператора, если коллекция не пуста, иначе None.

Definition Classes
IterableOnceOps

final def reverse: List[Nothing]

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

Примечание: даже при применении к представлению или ленивому набору элементов он всегда будет принудительно их использовать.

returns

Новый список со всеми элементами этого списка в обратном порядке.

Definition Classes
List → SeqOps

def reverseIterator: Iterator[Nothing]

Итератор, возвращающий элементы в обратном порядке.

Примечание: не завершится для наборов бесконечного размера.

Примечание: xs.reverseIterator эквивалентно xs.reverse.iterator, но может быть более эффективным.

returns

итератор, возвращающий элементы этой последовательности в обратном порядке

Definition Classes
SeqOps

def reverse_:::[B >: Nothing](prefix: List[B]): List[B]

Добавляет элементы заданного списка в обратном порядке в начало этого списка. xs reverse_::: ys эквивалентно xs.reverse ::: ys, но более эффективно.

prefix

Префикс, который нужно перевернуть и добавить в начало

returns

Результат конкатенации перевернутого префикса и текущего списка.

Definition Classes
List

def reversed: collection.Iterable[Nothing]

Attributes
protected
Definition Classes
IterableOnceOps

def runWith[U](action: (Nothing) => U): (Int) => Boolean

Объединяет эту частичную функцию с функцией действия, которая применяется к результатам этой частичной функции. Функция действия вызывается только для своих побочных эффектов; её результат игнорируется.

Обратите внимание, что выражение pf.runWith(action)(x) эквивалентно

if(pf isDefinedAt x) { action(pf(x)); true } else false

за исключением того, что runWith реализована через applyOrElse и, следовательно, потенциально более эффективна. Использование runWith избегает двойной оценки соответствия шаблонам и условий для литералов частичных функций.

action

функция действия

returns

функция, которая сопоставляет аргументы x с isDefinedAt(x). Результирующая функция выполняет action(this(x)), где this определена.

Definition Classes
PartialFunction
Since

2.10

See also

applyOrElse.

def sameElements[B >: Nothing](that: IterableOnce[B]): Boolean

Являются ли элементы этого набора данных такими же (и в том же порядке), что и элементы that?

Definition Classes
LinearSeqOps → SeqOps

def scan[B >: Nothing](z: B)(op: (B, B) => B): List[B]

Вычисляет префиксное сканирование элементов набора данных.

Примечание: нейтральный элемент z может применяться более одного раза.

B

тип элементов результирующего набора данных

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

returns

новый итерируемый набор данных, содержащий префиксное сканирование элементов в этом итерируемом наборе данных

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, Nothing) => B): List[B]

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

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Note

Переиспользование: после вызова этого метода следует отбросить итератор, на котором он был вызван, и использовать только итератор, который был возвращен. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе тоже.

def scanRight[B](z: B)(op: (Nothing, B) => B): List[B]

Производит коллекцию, содержащую кумулятивные результаты применения оператора справа налево. Голова коллекции — последний кумулятивный результат.

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

тип элементов в результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

returns

коллекция с промежуточными результатами

Definition Classes
IterableOps

def search[B >: Nothing](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult

Поиск элемента в отсортированной последовательности в заданном интервале. Если последовательность является IndexedSeq, используется бинарный поиск. В противном случае используется линейный поиск.

Последовательность должна быть отсортирована с использованием того же Ordering перед вызовом; в противном случае результаты не определены.

elem

искомый элемент.

from

индекс, с которого начинается поиск.

to

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

ord

упорядочение, используемое для сравнения элементов.

returns

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, куда элемент был бы вставлен, если элемент отсутствует в последовательности.

Definition Classes
SeqOps
Note

если to <= from, пространство поиска пусто, и возвращается InsertionPoint в from

See also

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

def search[B >: Nothing](elem: B)(implicit ord: Ordering[B]): SearchResult

Поиск заданного элемента в этой отсортированной последовательности. Если последовательность является IndexedSeq, используется бинарный поиск. В противном случае используется линейный поиск.

Последовательность должна быть отсортирована с использованием того же Ordering перед вызовом; в противном случае результаты не определены.

elem

искомый элемент.

ord

упорядочение, используемое для сравнения элементов.

returns

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, куда элемент был бы вставлен, если элемент отсутствует в последовательности.

Definition Classes
SeqOps
See also

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

def segmentLength(p: (Nothing) => Boolean, from: Int): Int

Вычисляет длину самого длинного сегмента, элементы которого удовлетворяют некоторому предикату.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

from

индекс, с которого начинается поиск.

returns

длина самого длинного сегмента этой последовательности, начинающегося с индекса from, в котором каждый элемент сегмента удовлетворяет предикату p.

Definition Classes
LinearSeqOps → SeqOps

final def segmentLength(p: (Nothing) => Boolean): Int

Вычисляет длину самого длинного сегмента, элементы которого удовлетворяют некоторому предикату.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

длина самого длинного сегмента этой последовательности, в котором каждый элемент сегмента удовлетворяет предикату p.

Definition Classes
SeqOps

final def size: Int

Размер этой последовательности.

Примечание: не завершится для коллекций бесконечного размера.

returns

количество элементов в этой последовательности.

Definition Classes
SeqOps → IterableOnceOps

final def sizeCompare(that: collection.Iterable[_]): Int

Сравнивает размер этой последовательности с размером другой Iterable.

that

Iterable, размер которой сравнивается с размером этой последовательности.

returns

Значение x, где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Метод, как реализован здесь, не вызывает size напрямую; его время выполнения составляет O(this.size min that.size) вместо O(this.size + that.size). Метод следует переопределить, если вычисление size является быстрым, а knownSize возвращает -1.

Definition Classes
SeqOps → IterableOps

final def sizeCompare(otherSize: Int): Int

Сравнивает размер этой последовательности со значением теста.

otherSize

тестовое значение, которое сравнивается с размером.

returns

Значение x, где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Реализация метода здесь не вызывает size напрямую; его время выполнения составляет O(size min otherSize) вместо O(size). Метод следует переопределять, если вычисление size является дешёвым, а knownSize возвращает -1.

Definition Classes
SeqOps → IterableOps
См. также

sizeIs

final def sizeIs: SizeCompareOps

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

Эти операции реализованы с точки зрения sizeCompare(Int), и позволяют следующие более читаемые способы использования:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Аннотации
@inline()

def slice(from: Int, until: Int): List[Nothing]

from

наименьший индекс для включения из этого списка.

until

наименьший индекс для исключения из этого списка.

returns

список, содержащий элементы, большие или равные индексу from, простирающийся до (но не включая) индекс until этого списка.

Definition Classes
List → IterableOps → IterableOnceOps
Пример:
    // Given a list
    val letters = List('a','b','c','d','e')
    
    // `slice` returns all elements beginning at index `from` and afterwards,
    // up until index `until` (excluding index `until`.)
    letters.slice(1,3) // Returns List('b','c')

def sliding(size: Int, step: Int): Iterator[List[Nothing]]

Элементы группируются в блоки фиксированного размера, используя "скользящее окно" (в отличие от разбиения, как в grouped).

size

количество элементов в группе

step

расстояние между первыми элементами последовательных групп

returns

Итератор, возвращающий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным), который усекается, если оставшихся элементов для группировки меньше, чем size.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sliding(size: Int): Iterator[List[Nothing]]

Элементы группируются в блоки фиксированного размера, используя "скользящее окно" (в отличие от разбиения, как в grouped). Шаг "скользящего окна" устанавливается в единицу.

size

количество элементов в группе

returns

Итератор, возвращающий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным), который усекается, если оставшихся элементов для группировки меньше, чем size.

Definition Classes
IterableOps
See also

scala.collection.Iterator, метод sliding

def sortBy[B](f: (Nothing) => B)(implicit ord: Ordering[B]): List[Nothing]

Сортирует эту последовательность в соответствии с упорядочением, полученным путем преобразования неявно заданного упорядочения с помощью функции преобразования.

Примечание: не будет завершаться для бесконечных коллекций.

Примечание: даже при применении к представлению или ленивой коллекции она всегда принудительно вычисляет элементы.

Сортировка устойчивая. То есть, элементы, которые равны (как определяется ord.compare), появляются в отсортированной последовательности в том же порядке, что и в исходной.

B

целевой тип преобразования f и тип, где определено упорядочение ord.

f

функция преобразования, отображающая элементы в какую-либо другую область B.

ord

упорядочение, предполагаемое для области B.

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с упорядочением, где x < y, если ord.lt(f(x), f(y)).

Definition Classes
SeqOps
Пример:
    val words = "The quick brown fox jumped over the lazy dog".split(' ')
    // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
    words.sortBy(x => (x.length, x.head))
    res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
See also

scala.math.Ordering

def sortWith(lt: (Nothing, Nothing) => Boolean): List[Nothing]

Сортирует эту последовательность в соответствии с функцией сравнения.

Примечание: не будет завершаться для коллекций бесконечного размера.

Примечание: даже при применении к представлению или ленивой коллекции она всегда принудительно форсирует элементы.

Сортировка стабильна. То есть элементы, которые равны (как определено функцией lt), появляются в отсортированной последовательности в том же порядке, что и в исходной.

lt

функция сравнения, которая проверяет, предшествует ли первый аргумент второму аргументу в желаемом порядке.

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с функцией сравнения lt.

Definition Classes
SeqOps
Пример:
    List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
    List("Bob", "John", "Steve", "Tom")

def sorted[B >: Nothing](implicit ord: Ordering[B]): List[Nothing]

Сортирует эту неизменяемую последовательность в соответствии с порядком.

Сортировка стабильна. То есть элементы, которые равны (как определено функцией ord.compare), появляются в отсортированной последовательности в том же порядке, что и в исходной.

ord

порядок, используемый для сравнения элементов.

returns

неизменяемая последовательность, состоящая из элементов этой неизменяемой последовательности, отсортированных в соответствии с порядком ord.

Definition Classes
StrictOptimizedSeqOps → SeqOps
See also

scala.math.Ordering Примечание: даже при применении к представлению или ленивой коллекции она всегда принудительно форсирует элементы.

final def span(p: (Nothing) => Boolean): (List[Nothing], List[Nothing])

Разделяет этот список на пару префикс/суффикс в соответствии с предикатом.

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не вызывает побочных эффектов.

p

предикат проверки

возвращает

пара, состоящая из самого длинного префикса этого списка, элементы которого удовлетворяют p, и остальной части этого списка.

Классы-определения
List → StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Аннотации
@inline()
Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращённые итераторы. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новых итераторах.

def splitAt(n: Int): (List[Nothing], List[Nothing])

Разделяет этот список на пару префикс/суффикс в заданной позиции.

Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

n

позиция разделения.

возвращает

пару списков, состоящую из первых n элементов этого списка и остальных элементов.

Классы-определения
List → IterableOps → IterableOnceOps
Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращённые итераторы. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новых итераторах.

def startsWith[B >: Nothing](that: IterableOnce[B], offset: Int = 0): Boolean

Проверяет, содержит ли эта последовательность заданную последовательность в заданном индексе.

Примечание: Если как получаемый объект this, так и аргумент that являются бесконечными последовательностями, этот метод может не завершиться.

that

тестируемая последовательность

offset

индекс, в котором ищется последовательность.

возвращает

true, если последовательность that содержится в этой последовательности в индексе offset, в противном случае false.

Классы-определения
SeqOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[Nothing, S]): S

Возвращает Stepper для элементов этого набора.

Stepper позволяет создать Java-поток для работы с набором, см. scala.jdk.StreamConverters. Для наборов, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элементов этого набора.

    Для наборов Int, Short, Byte или Char возвращается IntStepperДля наборов Double или Float возвращается DoubleStepperДля наборов Long возвращается LongStepperДля любого другого типа элементов возвращается AnyStepper

Обратите внимание, что этот метод переопределен в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например IndexedSeqOps.stepper. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как обычные Steppers могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

final def strictOptimizedCollect[B, C2](b: Builder[B, C2], pf: PartialFunction[Nothing, B]): C2

B

Тип элементов результирующего набора (например, String)

C2

Тип результирующего набора (например, List[String])

b

Библиотека для построения результирующего набора

pf

Частичная функция преобразования элементов

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedConcat[B >: Nothing, C2](that: IterableOnce[B], b: Builder[B, C2]): C2

B

Тип элементов результирующих коллекций (например, Int)

C2

Тип результирующей коллекции (например, List[Int])

that

Элементы для конкатенации с этой коллекцией

b

Библиотека для построения результирующей коллекции

returns

Результирующая коллекция

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatMap[B, C2](b: Builder[B, C2], f: (Nothing) => IterableOnce[B]): C2

B

Тип элементов результирующей коллекции (например, String)

C2

Тип результирующей коллекции (например, List[String])

b

Библиотека для построения результирующей коллекции

f

Функция преобразования элементов

returns

Результирующая коллекция

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: (Nothing) => IterableOnce[B]): C2

B

Тип элементов результирующего набора (например, Int)

C2

Тип результирующего набора (например, List[Int])

b

Используемый билдер для построения результирующего набора

toIterableOnce

Доказательство того, что A может рассматриваться как IterableOnce[B]

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedMap[B, C2](b: Builder[B, C2], f: (Nothing) => B): C2

B

Тип элементов результирующего набора (например, String)

C2

Тип результирующего набора (например, List[String])

b

Используемый билдер для построения результирующего набора

f

Функция преобразования элемента

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedZip[B, C2](that: IterableOnce[B], b: Builder[(Nothing, B), C2]): C2

B

Тип элементов второго набора (например, String)

C2

Тип результирующего набора (например, List[(Int, String)])

that

Набор для объединения с этим набором

b

Используемый билдер для построения результирующего набора

returns

Результирующий набор

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

def stringPrefix: String

Атрибуты
protected[this]
Классы-определения
LinearSeq → Seq → Iterable
Аннотации
@deprecatedOverriding("Compatibility override", "2.13.0")

def sum[B >: Nothing](implicit num: math.Numeric[B]): B

Суммирует элементы этого набора.

B

тип результата оператора +.

num

явный параметр, определяющий набор арифметических операций, в том числе оператор +, используемый для вычисления суммы.

возвращает

сумму всех элементов этого набора относительно оператора + в num.

Классы-определения
IterableOnceOps

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

Классы-определения
AnyRef

def tail: Nothing

Остальная часть коллекции без ее первого элемента.

Классы-определения
Nil → LinearSeqOps → IterableOps

def tails: Iterator[List[Nothing]]

Проходит по хвостам этой последовательности. Первое значение будет этой последовательностью, а последнее — пустой последовательностью, а промежуточные значения — результатом последовательных применений tail.

возвращает

итератор по всем хвостам этой последовательности

Классы-определения
LinearSeqOps → IterableOps
Пример:

    List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

def take(n: Int): List[Nothing]

Выбирает первые n элементов.

n

количество элементов, которые нужно взять из этого списка.

returns

список, содержащий только первые n элементов этого списка, или весь список, если в нем меньше n элементов. Если n отрицательное, возвращает пустой список.

Definition Classes
List → IterableOps → IterableOnceOps
Note

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенный итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе тоже.

def takeRight(n: Int): List[Nothing]

Коллекция, содержащая последние n элементов этой коллекции.

Примечание: Даже при применении к представлению или ленивой коллекции элементы всегда будут принудительно взяты.

n

количество элементов, которые нужно взять из этого списка.

returns

список, содержащий только последние n элементы этого списка, или весь список, если в нем меньше n элементов. Если n отрицательное, возвращает пустой список.

Definition Classes
List → StrictOptimizedIterableOps → IterableOps

final def takeWhile(p: (Nothing) => Boolean): List[Nothing]

Взятие наибольшего префикса элементов, удовлетворяющих предикату.

p

Предикат, используемый для проверки элементов.

returns

наибольший префикс этого списка, все элементы которого удовлетворяют предикату p.

Definition Classes
List → IterableOps → IterableOnceOps
Annotations
@inline()

def tapEach[U](f: (Nothing) => U): List[Nothing]

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

U

тип возвращаемого значения f

f

функция для применения к каждому элементу в этой итерируемой коллекции

returns

Такая же логическая коллекция, как и эта

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps

def to[C1](factory: Factory[Nothing, C1]): C1

При заданном фабрике коллекции factory, преобразуйте эту коллекцию в соответствующую представление для текущего типа элемента A. Примеры использования:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Definition Classes
IterableOnceOps

def toArray[B >: Nothing](implicit arg0: ClassTag[B]): Array[B]

Преобразование коллекции в массив.

Definition Classes
IterableOnceOps

final def toBuffer[B >: Nothing]: Buffer[B]

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[Nothing]

Definition Classes
IterableOnceOps

final def toIterable: Nil.this.type

возвращает

Это коллекцию в виде Iterable[A]. Новая коллекция не будет создана, если this уже является Iterable[A].

Определяющие классы
Iterable → IterableOps

final def toList: List[Nothing]

Определяющие классы
List → IterableOnceOps

def toMap[K, V](implicit ev: <:<[Nothing, (K, V)]): Map[K, V]

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

final def toSeq: Nil.this.type

возвращает

Это коллекцию в виде Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Определяющие классы
Seq → IterableOnceOps

def toSet[B >: Nothing]: Set[B]

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

def toString(): String

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

возвращает

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

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

def toVector: Vector[Nothing]

Definition Classes
IterableOnceOps

def transpose[B](implicit asIterable: (Nothing) => collection.Iterable[B]): List[List[B]]

Транспонирует это итерируемое множество итерируемых множеств в итерируемое множество итерируемых множеств.

Тип результирующего множества будет определяться статическим типом итерируемого множества. Например:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Примечание: Даже при применении к представлению или ленивому множеству, оно всегда будет принудительно вычислять элементы.

B

тип элементов каждого итерируемого множества.

asIterable

явное преобразование, которое утверждает, что тип элемента этого итерируемого множества является Iterable.

returns

двумерное итерируемое множество итерируемых множеств, в котором n-я строка соответствует n-му столбцу этого итерируемого множества.

Definition Classes
IterableOps
Исключения

IllegalArgumentException, если все множества в этом итерируемом множестве не имеют одинаковый размер.

def unapply(a: Int): Option[Nothing]

Попытка извлечь B из A в выражении сопоставления с образцом.

Definition Classes
PartialFunction

def unzip[A1, A2](implicit asPair: (Nothing) => (A1, A2)): (List[A1], List[A2])

Преобразует этот список пар в два множества первой и второй половины каждой пары.

val xs = `List`(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (`List`(1, 2, 3),
//        `List`(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

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

returns

пара списков, содержащих первую и, соответственно, вторую половину каждой пары элементов этого списка.

Definition Classes
Nil → StrictOptimizedIterableOps → IterableOps

def unzip3[A1, A2, A3](implicit asTriple: (Nothing) => (A1, A2, A3)): (List[A1], List[A2], List[A3])

Преобразует эту итерируемую коллекцию троек в три коллекции первого, второго и третьего элемента каждой тройки.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

тип первого члена троек элементов

A2

тип второго члена троек элементов

A3

тип третьего члена троек элементов

asTriple

неявное преобразование, которое утверждает, что тип элемента этой итерируемой коллекции — тройка.

returns

тройка итерируемых коллекций, содержащая первый, второй, соответственно третий член каждой тройки элементов этой итерируемой коллекции.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def updated[B >: Nothing](index: Int, elem: B): List[B]

Копия этого списка с одним заменённым элементом.

B

тип элемента возвращаемого списка.

index

позиция замены

elem

заменяющий элемент

returns

новый список, который является копией этого списка с элементом в позиции index, заменённым на elem.

Definition Classes
List → StrictOptimizedSeqOps → SeqOps
Exceptions thrown

IndexOutOfBoundsException если index не удовлетворяет 0 <= index < length. В случае ленивой коллекции это исключение может быть выброшено в более позднее время или вообще не выброшено (если конец коллекции никогда не оценивается).

def view: SeqView[Nothing]

Просмотр элементов этой коллекции.

Definition Classes
SeqOps → IterableOps

final def wait(): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

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

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException]) @native()

def withFilter(p: (Nothing) => Boolean): WithFilter[Nothing, [_]List[_]]

Создаёт нестрогий фильтр для этого итерируемого набора.

Примечание: различие между c filter p и c withFilter p заключается в том, что первый создаёт новый набор, а второй только ограничивает область последующих map, flatMap, foreach и withFilter операций.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

p

предикат, используемый для проверки элементов.

возвращает

объект класса WithFilter, который поддерживает map, flatMap, foreach и withFilter операции. Все эти операции применяются к тем элементам этого итерируемого набора, которые удовлетворяют предикату p.

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

def writeReplace(): AnyRef

Атрибуты
protected[this]
Определяющие классы
DefaultSerializable

def zip[B](that: IterableOnce[B]): List[(Nothing, B)]

Возвращает итерируемое множество, образованное из этого итерируемого множества и другого итерируемого множества путём объединения соответствующих элементов в пары. Если одно из двух множеств длиннее другого, оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

Итерируемое множество, предоставляющее вторую половину каждой пары результата

returns

новое итерируемое множество, содержащее пары, состоящие из соответствующих элементов этого итерируемого множества и that. Длина возвращаемого множества равна минимальному значению длин этого итерируемого множества и that.

Definition Classes
StrictOptimizedIterableOps → IterableOps

def zipAll[A1 >: Nothing, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): List[(A1, B)]

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

that

итерируемое множество, предоставляющее вторую половину каждой пары результата

thisElem

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

thatElem

элемент, используемый для заполнения результата, если that короче этого итерируемого множества.

returns

новое множество типа That, содержащее пары, состоящие из соответствующих элементов этого итерируемого множества и that. Длина возвращаемого множества равна максимальному значению длин этого итерируемого множества и that. Если это итерируемое множество короче that, для заполнения результата используются значения thisElem. Если that короче этого итерируемого множества, для заполнения результата используются значения thatElem.

Definition Classes
IterableOps

def zipWithIndex: List[(Nothing, Int)]

Сцепляет эту итерируемую коллекцию с её индексами.

returns

Новая итерируемая коллекция, содержащая пары, состоящие из всех элементов этой итерируемой коллекции, сопоставленных с их индексом. Индексы начинаются с 0.

Definition Classes
StrictOptimizedIterableOps → IterableOps → IterableOnceOps
Example:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

Переиспользование: после вызова этого метода нужно удалить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе тоже.

© 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/collection/immutable/Nil$.html

Spec-Zone.ru

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