Spec-Zone.ru › Scala 2.12 Library

Класс scala.collection.immutable.List

Компаньон объект List

абстрактный запечатанный класс List[+A] extends AbstractSeq[A] с LinearSeq[A] с Product с GenericTraversableTemplate[A, List] с LinearSeqOptimized[A, List[A]] с Serializable

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

Этот класс поставляется с двумя реализующими case-классами scala.Nil и scala.::, которые реализуют абстрактные члены isEmpty, head и tail.

Этот класс оптимален для шаблонов доступа «последний вошел — первый вышел» (LIFO), похожих на стек. Если вам нужен другой шаблон доступа, например, случайный доступ или FIFO, рассмотрите использование коллекции, более подходящей для этого, чем List.

Примечание: Несмотря на то, что это неизменяемая коллекция, в ходе построения внутренне используется изменяемое состояние. Эти изменения состояния незаметны в однопоточных кодах, но могут привести к гонкам в некоторых многопоточных сценариях. Состояние нового экземпляра коллекции может не быть «опубликовано» (в смысле спецификации Java Memory Model), поэтому несинхронизированное не-volatile чтение из другого потока может обнаружить объект в недопустимом состоянии (см. scala/bug#7838 для получения подробностей). Обратите внимание, что такое чтение не гарантируется, что *когда-либо* увидит написанный объект вообще, и поэтому не должно использоваться, независимо от этой проблемы. Самым простым решением является обмен значениями между потоками через volatile var.

Производительность

Время: List имеет O(1) предварение и доступ к head/tail. Большинство других операций зависят от O(n) от количества элементов в списке. Это включает в себя поиск элементов по индексу, length, append и reverse.

Память: List реализует **структурное совместное использование** хвостового списка. Это означает, что многие операции имеют нулевую или постоянную стоимость памяти.

val mainList = List(3, 2, 1)
val with4 =    4 :: mainList  // re-uses mainList, costs one :: instance
val with42 =   42 :: mainList // also re-uses mainList, cost one :: instance
val shorter =  mainList.tail  // costs nothing as it uses the same 2::1::Nil instances as mainList
Аннотации
@SerialVersionUID()
Источник
List.scala
Пример:
  1. // Make a list via the companion object factory
    val days = List("Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday")
    
    // Make a list element-by-element
    val when = "AM" :: "PM" :: List()
    
    // Pattern match
    days match {
      case firstDay :: otherDays =>
        println("The first day of the week is: " + firstDay)
      case List() =>
        println("There don't seem to be any week days.")
    }
С тех пор

1.0

Примечание

Функциональный список характеризуется устойчивостью и структурным совместным использованием, что обеспечивает значительные преимущества производительности и потребления памяти в некоторых сценариях при правильном использовании. Однако имейте в виду, что объекты, имеющие несколько ссылок в один и тот же функциональный список (то есть объекты, которые полагаются на структурное совместное использование), будут сериализованы и десериализованы с несколькими списками, по одному для каждой ссылки на него. То есть структурное совместное использование теряется после сериализации/десериализации.

См. также

"Обзор библиотеки коллекций Scala" раздел по Lists для получения дополнительной информации.

Линейные надтипы
Известные подклассы

Типовые члены

класс WithFilter extends FilterMonadic[A, Repr]

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

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

тип Self = List[A]

Тип, реализующий этот обход

Атрибуты
protected[this]
Определяющие классы
TraversableLike

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

абстрактный def productArity: Int

Размер этого произведения.

возвращает

для произведения A(x1, ..., xk), возвращает k

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

абстрактный def productElement(n: Int): Any

n-ый элемент этого произведения, нумерация с 0. Другими словами, для произведения A(x1, ..., xk), возвращает x(n+1) где 0 <= n < k.

n

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

возвращает

элемент n элементов после первого элемента

Определяющие классы
Product
Исключения, которые могут быть брошены

Члены-значения конкретного типа

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

значение хэша, соответствующее ==

Definition Classes
AnyRef → Any

def +(other: String): String

Implicit
Этот член добавляется неявным преобразованием из List[A] в any2stringadd[List[A]] с помощью метода any2stringadd в scala.Predef.
Definition Classes
any2stringadd

def ++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[List[A], B, That]): That

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

B

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

That

класс возвращаемой коллекции. В стандартной конфигурации библиотеки That всегда List[B], так как определен неявный элемент типа CanBuildFrom[List, B, That] в объекте List.

that

просматриваемая коллекция, которая будет добавленной.

bf

неявное значение класса CanBuildFrom, которое определяет класс результата That из текущего типа представления Repr и нового типа элемента B. Обычно это значение canBuildFrom , определённое в объекте List.

returns

новая коллекция типа That, которая содержит все элементы этого списка, за которыми следуют все элементы that.

Definition Classes
List → TraversableLike → GenTraversableLike

def ++:[B >: A, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[List[A], B, That]): That

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

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

Пример:

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

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

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

Поскольку у TraversableOnce нет метода ++, нам приходится реализовывать его непосредственно, но Traversable и ниже могут использовать перегруз.

B

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

That

класс возвращаемой коллекции. В тех случаях, где это возможно, That является тем же классом, что и текущий класс коллекции Repr, но это зависит от того, допустим ли тип элемента B для этого класса, что означает, что найден неявный экземпляр типа CanBuildFrom[Repr, B, That].

that

просматриваемая коллекция, которую следует добавить.

bf

неявное значение класса CanBuildFrom, которое определяет класс результата That из текущего типа представления Repr и нового типа элемента B.

returns

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

Definition Classes
TraversableLike

def ++:[B](that: TraversableOnce[B]): List[B]

[use case]

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

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

Пример:

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

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
B

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

that

просматриваемая коллекция, которую следует добавить.

returns

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

Definition Classes
TraversableLike
Полная сигнатура

def +:(elem: A): List[A]

[use case]

A copy of the list with an element prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Also, the original list is not modified, so you will want to capture the result.

Example:

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)
elem

the prepended element

returns

a new list consisting of elem followed by all elements of this list.

Definition Classes
List → SeqLike → GenSeqLike
Full Signature

def ->[B](y: B): (List[A], B)

Implicit
This member is added by an implicit conversion from List[A] to ArrowAssoc[List[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

def /:[B](z: B)(op: (B, A) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

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

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:

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

where x1, ..., xn are the elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce

def :+(elem: A): List[A]

[use case]

A copy of this list with an element appended.

A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Example:

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)
elem

the appended element

returns

a new list consisting of all elements of this list followed by elem.

Definition Classes
SeqLike → GenSeqLike
Full Signature

def ::(x: A): List[A]

[use case]

Adds an element at the beginning of this list.

Example:

1 :: List(2, 3) = List(2, 3).::(1) = List(1, 2, 3)
x

the element to prepend.

returns

a list which contains x as first element and which continues with this list.

Full Signature

def :::(prefix: List[A]): List[A]

[use case]

Adds the elements of a given list in front of this list.

Example:

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

The list elements to prepend.

returns

a list resulting from the concatenation of the given list prefix and this list.

Full Signature

def :\[B](z: B)(op: (A, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.

Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

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

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15
B

the result type of the binary operator.

z

the start value

op

the binary operator

returns

the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:

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

where x1, ..., xn are the elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce

final def ==(arg0: Any): Boolean

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

возвращает

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

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

def addString(b: StringBuilder): 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

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

возвращает

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

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

def addString(b: StringBuilder, sep: String): 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

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

возвращает

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

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

def addString(b: StringBuilder, start: String, sep: String, end: String): 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

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

возвращает

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

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

def aggregate[B](z: ⇒ B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B

Агрегирует результаты применения оператора к последующим элементам.

Это более общий вид fold и reduce. Он похож на foldLeft, поскольку не требует, чтобы результат был супертипом типа элемента. Кроме того, он позволяет обрабатывать параллельные коллекции частями и затем объединять промежуточные результаты.

aggregate разбивает итерируемый объект или итератор на разделы и обрабатывает каждый раздел последовательным применением seqop, начиная с z (как foldLeft). Эти промежуточные результаты затем объединяются с помощью combop (как fold). Реализация этой операции может работать с произвольным количеством разделов коллекции (даже с 1), поэтому combop может вызываться произвольное количество раз (даже 0).

В качестве примера рассмотрим суммирование целочисленных значений списка символов. Начальное значение для суммы равно 0. Во-первых, seqop преобразует каждый входной символ в целое число и добавляет его к сумме (раздела). Затем, combop просто нужно суммировать промежуточные результаты разделов:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
B

тип накопленных результатов

z

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

seqop

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

combop

ассоциативный оператор, используемый для объединения результатов из разных разделов

Определяющие классы
TraversableOnce → GenTraversableOnce

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

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

C

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

k

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

возвращает

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

Определяющие классы
PartialFunction → Function1

def apply(n: Int): A

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

возвращает

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

Определяющие классы
LinearSeqOptimized → SeqLike → GenSeqLike
Исключения

IndexOutOfBoundsException если idx не удовлетворяет 0 <= idx < length.

def applyOrElse[A1 <: Int, B1 >: A](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
Исключения

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
IterableLike → Equals

def clone(): AnyRef

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

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

returns

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

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

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

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

[use case]

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

B

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

pf

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

returns

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

Definition Classes
List → TraversableLike → GenTraversableLike
Полная сигнатура

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

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

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

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

pf

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

returns

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

Definition Classes
TraversableOnce
Пример:

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

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

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

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

returns

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

Definition Classes
SeqLike
Пример:

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

def companion: GenericCompanion[List]

Объект-компаньон-фабрика, который создаёт экземпляры класса List. (или его Iterable суперкласса, где класс List не является Seq.)

Definition Classes
List → LinearSeq → LinearSeq → Seq → Iterable → Traversable → Seq → GenSeq → Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate

def compose[A](g: (A) ⇒ Int): (A) ⇒ A

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

A

тип, к которому функция g может быть применена

g

функция A => T1

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

def contains[A1 >: A](elem: A1): Boolean

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

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

elem

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

returns

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

Definition Classes
LinearSeqOptimized → SeqLike

def containsSlice[B](that: GenSeq[B]): Boolean

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

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

that

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

returns

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

Definition Classes
SeqLike

def copyToArray(xs: Array[A], start: Int, len: Int): Unit

[use case]

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

xs

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

start

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

len

максимальное количество копируемых элементов.

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
Полная подпись

def copyToArray(xs: Array[A]): Unit

[use case]

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

xs

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная подпись

def copyToArray(xs: Array[A], start: Int): Unit

[use case]

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

xs

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

start

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Копирует все элементы этого перечислимого объекта или итератора в буфер.

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

dest

Буфер, в который копируются элементы.

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

final def corresponds[B](that: GenSeq[B])(p: (A, B) ⇒ Boolean): Boolean

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

B

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

that

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

p

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

возвращает

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

Определяющие классы
LinearSeqLike → SeqLike → GenSeqLike
Аннотации
@tailrec()

def count(p: (A) ⇒ Boolean): Int

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

p

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def diff(that: collection.Seq[A]): List[A]

[use case]

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

that

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

возвращает

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

Определяющие классы
SeqLike → GenSeqLike
Полная сигнатура

def distinct: List[A]

Создает новую последовательность из этой последовательности без дублирующих элементов.

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

возвращает

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

Определяющие классы
SeqLike → GenSeqLike

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

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

n

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

возвращает

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

Определяющие классы
List → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

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

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

n

Количество элементов для взятия

возвращает

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

Определяющие классы
LinearSeqOptimized → IterableLike

final def dropWhile(p: (A) ⇒ Boolean): List[A]

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

returns

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

Definition Classes
List → TraversableLike → GenTraversableLike
Annotations
@inline()

def endsWith[B](that: GenSeq[B]): Boolean

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

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

that

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

returns

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

Definition Classes
SeqLike → GenSeqLike

def ensuring(cond: (List[A]) ⇒ Boolean, msg: ⇒ Any): List[A]

Implicit
Этот член добавлен неявным преобразованием из List[A] в Ensuring[List[A]] выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (List[A]) ⇒ Boolean): List[A]

Implicit
Этот член добавлен неявным преобразованием из List[A] в Ensuring[List[A]] выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): List[A]

Implicit
Этот член добавлен неявным преобразованием из List[A] в Ensuring[List[A]] выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): List[A]

Implicit
Этот член добавлен неявным преобразованием из List[A] в Ensuring[List[A]] выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

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

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

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

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

returns

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

Definition Classes
AnyRef

def equals(that: Any): Boolean

Метод equals для произвольных последовательностей. Сравнивает эту последовательность с другим объектом.

that

Объект для сравнения с последовательностью

returns

true если that является последовательностью, имеющей те же элементы в том же порядке, false в противном случае

Definition Classes
GenSeqLike → Equals → Any

def exists(p: (A) ⇒ Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def filter(p: (A) ⇒ Boolean): List[A]

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def filterNot(p: (A) ⇒ Boolean): List[A]

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def finalize(): Unit

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

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

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

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

def find(p: (A) ⇒ Boolean): Option[A]

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

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

p

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

returns

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

Definition Classes
LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): List[B]

[use case]

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

Например:

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 => 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 → TraversableLike → GenTraversableLike → FilterMonadic
Полная подпись

def flatten[B]: List[B]

[use case]

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

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

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
GenericTraversableTemplate
Полная подпись

def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1

Складывает элементы этого обходчика или итератора с помощью заданного ассоциативного бинарного оператора.

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def foldLeft[B](z: B)(op: (B, A) ⇒ B): B

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
LinearSeqOptimized → TraversableOnce → GenTraversableOnce

def foldRight[B](z: B)(op: (A, 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 → LinearSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce

def forall(p: (A) ⇒ Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def foreach(f: (A) ⇒ Unit): Unit

[use case]

Применяет функцию f ко всем элементам этого списка.

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

f

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

Definition Classes
List → LinearSeqOptimized → IterableLike → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
Полная подпись

def formatted(fmtstr: String): String

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

Неявный
Этот член добавлен с помощью неявного преобразования из List[A] в StringFormat[List[A]] выполненного методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def genericBuilder[B]: Builder[B, List[B]]

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

Definition Classes
GenericTraversableTemplate

final def getClass(): Class[_]

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def groupBy[K](f: (A) ⇒ K): Map[K, List[A]]

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

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

K

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

f

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

returns

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

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

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

Definition Classes
TraversableLike → GenTraversableLike

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

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

size

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

returns

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

Definition Classes
IterableLike
See also

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

def hasDefiniteSize: Boolean

Проверяет, известно ли, что эта коллекция обхода имеет конечный размер. Все строгие коллекции известны как имеющие конечный размер. Для нестрогой коллекции, такой как Stream, предикат возвращает true если все элементы были вычислены. Он возвращает false если поток ещё не был вычислен до конца. Непустые итераторы обычно возвращают false даже если они были созданы из коллекции с известным конечным размером.

Примечание: многие методы коллекций не будут работать с коллекциями бесконечных размеров. Типичным режимом отказа является бесконечный цикл. Эти методы всегда пытаются выполнить обход без предварительной проверки, что hasDefiniteSize возвращает true. Однако проверка hasDefiniteSize может обеспечить гарантию, что размер определён и нежелательная бесконечность не является проблемой.

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce

def hashCode(): Int

Хеш-коды для Seq генерируют значение из хеш-кодов всех элементов последовательности.

returns

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

Definition Classes
LinearSeqLike → GenSeqLike → AnyRef → Any

def head: A

Выбирает первый элемент этой итерируемой коллекции.

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

returns

первый элемент этой итерируемой коллекции.

Definition Classes
IterableLike → TraversableLike → GenTraversableLike
Exceptions thrown

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def indexOf(elem: A, from: Int): Int

[use case]

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

elem

значение искомого элемента.

from

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

returns

индекс >= from первого элемента этого списка, который равен (как определено ==) elem, или -1, если такого элемента нет.

Definition Classes
GenSeqLike
Полная подпись

def indexOf(elem: A): Int

[use case]

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

elem

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

returns

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

Definition Classes
GenSeqLike
Полная сигнатура

def indexOfSlice[B >: A](that: GenSeq[B], from: Int): Int

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

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

that

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

from

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

returns

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

Definition Classes
SeqLike

def indexOfSlice[B >: A](that: GenSeq[B]): Int

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

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

that

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

returns

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

Definition Classes
SeqLike

def indexWhere(p: (A) ⇒ Boolean, from: Int): Int

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOptimized → SeqLike → GenSeqLike

def indexWhere(p: (A) ⇒ Boolean): Int

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

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

p

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

returns

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

Definition Classes
GenSeqLike

def indices: Range

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

returns

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

Definition Classes
SeqLike

def init: List[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Exceptions thrown

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

def inits: Iterator[List[A]]

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

returns

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

Definition Classes
TraversableLike
Пример:

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

def intersect(that: collection.Seq[A]): List[A]

[use case]

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

that

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

returns

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

Definition Classes
SeqLike → GenSeqLike
Полная сигнатура

def isDefinedAt(x: Int): Boolean

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

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

returns

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

Definition Classes
LinearSeqOptimized → GenSeqLike

def isEmpty: Boolean

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

returns

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

Definition Classes
SeqLike → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

final def isTraversableAgain: Boolean

Проверяет, можно ли повторно пройти по этому итерируемому набору.

returns

true

Definition Classes
TraversableLike → GenTraversableLike → GenTraversableOnce

def iterator: Iterator[A]

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

returns

новый итератор

Definition Classes
LinearSeqLike → IterableLike → GenIterableLike

def last: A

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

returns

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

Definition Classes
LinearSeqOptimized → TraversableLike → GenTraversableLike
Exceptions thrown

NoSuchElementException Если последовательность пуста.

def lastIndexOf(elem: A, end: Int): Int

[use case]

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

elem

значение искомого элемента.

end

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

returns

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

Definition Classes
GenSeqLike
Полная сигнатура

def lastIndexOf(elem: A): Int

[use case]

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

elem

значение искомого элемента.

returns

индекс последнего элемента этого списка, равного (как определено ==) elem, или -1, если такого нет.

Definition Classes
GenSeqLike
Полная сигнатура

def lastIndexOfSlice[B >: A](that: GenSeq[B], end: Int): Int

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

that

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

end

индекс конца

returns

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

Definition Classes
SeqLike

def lastIndexOfSlice[B >: A](that: GenSeq[B]): Int

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

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

that

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

returns

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

Definition Classes
SeqLike

def lastIndexWhere(p: (A) ⇒ Boolean, end: Int): Int

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

p

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

returns

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

Definition Classes
LinearSeqOptimized → SeqLike → GenSeqLike

def lastIndexWhere(p: (A) ⇒ Boolean): Int

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

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

p

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

returns

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

Definition Classes
GenSeqLike

def lastOption: Option[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def length: Int

Длина последовательности.

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

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

returns

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

Definition Classes
LinearSeqOptimized → SeqLike → GenSeqLike

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 является быстрым.

Definition Classes
LinearSeqOptimized → SeqLike

def lift: (Int) ⇒ Option[A]

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

returns

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

Definition Classes
PartialFunction
See also

Function.unlift

final def map[B](f: (A) ⇒ B): List[B]

[use case]

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

B

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

f

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

returns

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

Definition Classes
List → TraversableLike → GenTraversableLike → FilterMonadic
Полная сигнатура

final def mapConserve(f: (A) ⇒ A): List[A]

[use case]

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

f

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

returns

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

Полная сигнатура

def max: A

[use case]

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура
Exceptions thrown

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

def maxBy[B](f: (A) ⇒ B): A

[служебный случай]

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

B

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

f

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

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

def min: A

[служебный случай]

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

возвращает

наименьший элемент этого списка

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

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

def minBy[B](f: (A) ⇒ B): A

[служебный случай]

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

B

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

f

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

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

def mkString: String

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def mkString(sep: String): String

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

sep

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Пример:

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

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

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

start

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

sep

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

end

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

возвращает

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

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

def newBuilder: Builder[A, List[A]]

Построитель, создающий экземпляры типа Traversable[A]

Атрибуты
protected[this]
Определяющие классы
GenericTraversableTemplate → HasNewBuilder

def nonEmpty: Boolean

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

возвращает

true если traversable или итератор содержит хотя бы один элемент, false в противном случае.

Определяющие классы
TraversableOnce → GenTraversableOnce

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

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

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

A1

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

B1

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

that

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

returns

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

Definition Classes
PartialFunction

def padTo(len: Int, elem: A): List[A]

[use case]

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

len

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

elem

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

returns

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

Definition Classes
SeqLike → GenSeqLike
Полная подпись

def par: ParSeq[A]

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

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

Конкретные коллекции (например, ParArray или mutable.ParHashMap) переопределяют это поведение по умолчанию, создавая параллельную коллекцию, которая использует один и тот же базовый набор данных. Для таких коллекций par занимает постоянное или подлинейное время.

Все параллельные коллекции возвращают ссылку на себя.

returns

параллельная реализация этой коллекции

Definition Classes
Parallelizable

def parCombiner: Combiner[A, ParSeq[A]]

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

returns

комбинирующий объект для параллельной коллекции типа ParRepr

Attributes
protected[this]
Definition Classes
Seq → SeqLike → Iterable → TraversableLike → Parallelizable

def partition(p: (A) ⇒ Boolean): (List[A], List[A])

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

p

предикат для разделения.

returns

пара коллекций: первая коллекция содержит все элементы, удовлетворяющие предикату p, а вторая — все элементы, которые не удовлетворяют. Относительный порядок элементов в результирующих коллекциях такой же, как и в исходной.

Definition Classes
TraversableLike → GenTraversableLike

def patch(from: Int, that: GenSeq[A], replaced: Int): List[A]

[use case]

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

from

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

replaced

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

returns

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

Definition Classes
SeqLike → GenSeqLike
Полная подпись

def permutations: Iterator[List[A]]

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

returns

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

Definition Classes
SeqLike
Пример:

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

def prefixLength(p: (A) ⇒ Boolean): Int

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

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

p

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

возвращает

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

Definition Classes
GenSeqLike

def product: A

[use case]

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

возвращает

произведение всех элементов в этом списке чисел типа Int. Вместо Int, можно использовать любой другой тип T с неявной реализацией Numeric[T] в качестве типа элементов списка и типа результата product. Примеры таких типов: Long, Float, Double, BigInt.

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

def productIterator: scala.Iterator[Any]

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

возвращает

в стандартной реализации, Iterator[Any]

Definition Classes
Product

def productPrefix: String

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

возвращает

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

Definition Classes
Product

def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1

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

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

A1

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

op

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

возвращает

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

Definition Classes
TraversableOnce → GenTraversableOnce
Исключения

UnsupportedOperationException, если эта последовательность пуста.

def reduceLeft[B >: A](op: (B, A) ⇒ B): B

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

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

B

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

op

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

возвращает

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

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

где x1, ..., xn — элементы этой последовательности.

Definition Classes
LinearSeqOptimized → TraversableOnce
Исключения

UnsupportedOperationException, если эта последовательность пуста.

def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]

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

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

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

B

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

op

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

возвращает

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

Definition Classes
TraversableOnce → GenTraversableOnce

def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]

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

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

A1

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

op

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

возвращает

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

Definition Classes
TraversableOnce → GenTraversableOnce

def reduceRight[B >: A](op: (A, B) ⇒ B): B

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

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

B

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

op

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

returns

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

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

где x1, ..., xn являются элементами этой последовательности.

Definition Classes
LinearSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
Исключения

UnsupportedOperationException, если эта последовательность пустая.

def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]

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

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

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

B

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

op

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

returns

значение Option, содержащее результат reduceRight(op) если этот итерируемый объект или итератор непустой, None в противном случае.

Definition Classes
TraversableOnce → GenTraversableOnce

def repr: List[A]

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

Definition Classes
TraversableLike → GenTraversableLike

def reverse: List[A]

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

returns

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

Definition Classes
List → SeqLike → GenSeqLike

def reverseIterator: Iterator[A]

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

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

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

returns

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

Definition Classes
SeqLike

def reverseMap[B](f: (A) ⇒ B): List[B]

[use case]

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

Примечание: xs.reverseMap(f) эквивалентно xs.reverse.map(f), но может быть более эффективным.

B

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

f

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

returns

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

Definition Classes
SeqLike → GenSeqLike
Полная сигнатура

def reverse_:::(prefix: List[A]): List[A]

[use case]

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

prefix

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

returns

соединение перевернутого префикса и текущего списка.

Полная сигнатура

def reversed: scala.List[A]

Атрибуты
protected[this]
Definition Classes
TraversableOnce

def runWith[U](action: (A) ⇒ 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

См. также

applyOrElse.

def sameElements(that: GenIterable[A]): Boolean

[use case]

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

that

коллекция для сравнения.

returns

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

Definition Classes
LinearSeqOptimized → IterableLike → GenIterableLike
Полная сигнатура

def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[List[A], B, That]): That

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

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

B

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

That

тип результирующей коллекции

z

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

op

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

cbf

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

returns

новая коллекция, содержащая префиксное сканирование элементов в этой коллекции

Definition Classes
TraversableLike → GenTraversableLike

def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[List[A], B, That]): That

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

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

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

B

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

That

фактический тип результирующей коллекции

z

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

op

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

bf

неявное значение класса CanBuildFrom, которое определяет результирующий класс That из текущего типа представления Repr и нового типа элемента B.

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[List[A], B, That]): That

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

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

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

Пример:

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

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

That

фактический тип результирующей коллекции

z

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

op

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

bf

неявное значение класса CanBuildFrom, которое определяет результирующий класс That из текущего типа представления Repr и нового типа элемента B.

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Аннотации
@migration
Миграция

(Изменено в версии 2.9.0) Поведение scanRight изменилось. Предыдущее поведение можно воспроизвести с помощью scanRight.reverse.

def segmentLength(p: (A) ⇒ Boolean, from: Int): Int

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOptimized → SeqLike → GenSeqLike

def seq: LinearSeq[A]

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

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

returns

последовательный вид коллекции.

Definition Classes
LinearSeq → LinearSeq → LinearSeqLike → Seq → Seq → GenSeq → GenSeqLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

def size: Int

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

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

returns

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

Definition Classes
SeqLike → GenTraversableLike → TraversableOnce → GenTraversableOnce

def sizeHintIfCheap: Int

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

returns

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

Attributes
protected[collection]
Definition Classes
GenTraversableOnce

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

returns

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

Definition Classes
List → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
Пример:
    // 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[A]]

Группирует элементы в блоки фиксированного размера, пропуская "скользящее окно" над ними (в отличие от их разбиения, как это делается в grouped.)

size

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

step

расстояние между первыми элементами последовательных групп

returns

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

Definition Classes
IterableLike
См. также

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

def sliding(size: Int): Iterator[List[A]]

Группирует элементы в блоки фиксированного размера, пропуская "скользящее окно" над ними (в отличие от их разбиения, как это делается в grouped). Шаг "скользящего окна" установлен в единицу.

size

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

returns

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

Definition Classes
IterableLike
См. также

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

def sortBy[B](f: (A) ⇒ B)(implicit ord: math.Ordering[B]): List[A]

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

B

целевой тип преобразования f, и тип, где определено упорядочивание ord.

f

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

ord

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

returns

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с порядком, где x < y , если ord.lt(f(x), f(y)).

Definition Classes
SeqLike
Пример:
    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)
См. также

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

def sortWith(lt: (A, A) ⇒ Boolean): List[A]

Сортирует эту последовательность в соответствии с функцией сравнения.

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

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

lt

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

returns

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

Definition Classes
SeqLike
Пример:
    List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
    List("Bob", "John", "Steve", "Tom")

def sorted[B >: A](implicit ord: math.Ordering[B]): List[A]

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

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

ord

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

returns

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

Definition Classes
SeqLike
См. также

scala.math.Ordering

final def span(p: (A) ⇒ Boolean): (List[A], List[A])

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

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не вызывает побочных эффектов.

returns

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

Definition Classes
List → LinearSeqOptimized → TraversableLike → GenTraversableLike
Аннотации
@inline()

def splitAt(n: Int): (List[A], List[A])

Разделяет этот список на две части в заданной позиции. Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

n

позиция, в которой необходимо разделить.

returns

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

Definition Classes
List → TraversableLike → GenTraversableLike

def startsWith[B](that: GenSeq[B], offset: Int): Boolean

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

Примечание: Если как объект-получатель this , так и аргумент that являются бесконечными последовательностями, этот метод может не завершиться.

that

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

offset

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

returns

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

Definition Classes
SeqLike → GenSeqLike

def startsWith[B](that: GenSeq[B]): Boolean

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

that

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

returns

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

Definition Classes
GenSeqLike

def stringPrefix: String

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

returns

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

Definition Classes
List → TraversableLike → GenTraversableLike

def sum: A

[use case]

Суммирует элементы этого набора.

returns

сумма всех элементов в этом списке чисел типа Int. Вместо Int, может быть использован любой другой тип T с неявным Numeric[T] реализацией, который может быть использован как тип элементов в списке, и как тип результата sum. Примеры таких типов: Long, Float, Double, BigInt.

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef

def tail: List[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Исключения

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

def tails: Iterator[List[A]]

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

returns

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

Definition Classes
LinearSeqOptimized → TraversableLike
Пример:

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

def take(n: Int): List[A]

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

n

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

returns

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

Definition Classes
List → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike

def takeRight(n: Int): List[A]

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

n

количество элементов, которые нужно взять

returns

список, содержащий только последние n элементы этого списка, или весь список, если в нём меньше n элементов.

Definition Classes
List → IterableLike

final def takeWhile(p: (A) ⇒ Boolean): List[A]

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

returns

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

Definition Classes
List → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
Аннотации
@inline()

def thisCollection: collection.LinearSeq[A]

Базовая коллекция, рассматриваемая как экземпляр Seq. По умолчанию это реализовано как текущий объект коллекции, но это можно переопределить.

Атрибуты
protected[this]
Definition Classes
LinearSeqLike → SeqLike → IterableLike → TraversableLike

def to[Col[_]]: Col[A]

[use case]

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

Col

Тип коллекции, которую нужно создать.

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce
Полная сигнатура

def toArray: Array[A]

[служебный случай]

Преобразует этот список в массив.

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная подпись

def toBuffer[B >: A]: Buffer[B]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toCollection(repr: List[A]): collection.LinearSeq[A]

Преобразование из коллекций типа Repr в объекты Seq. По умолчанию это реализовано просто как приведение типа, но это можно переопределить.

Атрибуты
protected[this]
Определяющие классы
LinearSeqLike → SeqLike → IterableLike → TraversableLike

def toIndexedSeq: IndexedSeq[A]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toIterable: collection.Iterable[A]

Возвращает эту итерируемую коллекцию как итерируемую коллекцию.

Новая коллекция не будет построена; ленивые коллекции останутся ленивыми.

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

возвращает

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

Определяющие классы
IterableLike → TraversableOnce → GenTraversableOnce

def toIterator: Iterator[A]

Возвращает итератор над элементами в этой итерируемой коллекции. Производит тот же результат, что и iterator.

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

возвращает

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

Определяющие классы
IterableLike → TraversableLike → GenTraversableOnce
Аннотации
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toList: List[A]

Преобразует этот список в список.

возвращает

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

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

def toMap[T, U]: collection.Map[T, U]

[служебный случай]

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

возвращает

карта типа immutable.Map[T, U] содержащая все пары ключ/значение типа (T, U) из этого списка.

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная подпись

def toParArray: ParArray[T]

Неявный
Этот член добавлен с помощью неявного преобразования из List[A] в CollectionsHaveToParArray[List[A], T] выполненного методом CollectionsHaveToParArray в scala.collection.parallel. Это преобразование произойдет только в том случае, если в области видимости есть неявное значение типа (List[A]) ⇒ GenTraversableOnce[T].
Определяющие классы
CollectionsHaveToParArray

def toSeq: Seq[A]

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

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

Новая коллекция не будет построена; в частности, ленивые последовательности останутся ленивыми.

returns

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

Definition Classes
Seq → SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce

def toSet[B >: A]: Set[B]

Преобразует это перебираемое или итератор в множество.

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

returns

множество, содержащее все элементы этого перебираемого или итератора.

Definition Classes
TraversableOnce → GenTraversableOnce

def toStream: Stream[A]

Преобразует этот список в поток.

returns

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

Definition Classes
List → IterableLike → TraversableLike → GenTraversableOnce

def toString(): String

Преобразует эту последовательность в строку.

returns

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

Definition Classes
SeqLike → TraversableLike → Any

def toTraversable: collection.Traversable[A]

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

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

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce
Annotations
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toVector: scala.Vector[A]

Преобразует это перебираемое или итератор в вектор.

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[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

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

asTraversable

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

returns

двумерная коллекция коллекций, у которой n-я строка является n-м столбцом этой коллекции.

Definition Classes
GenericTraversableTemplate
Annotations
@migration
Migration

(Изменено в версии 2.9.0) transpose выбрасывает IllegalArgumentException если коллекции не имеют одинакового размера.

Exceptions thrown

IllegalArgumentException если все коллекции в этой коллекции не имеют одинакового размера.

def union(that: collection.Seq[A]): List[A]

[use case]

Создаёт новую последовательность, которая содержит все элементы этого списка, а также все элементы заданной последовательности. xs union ys эквивалентно xs ++ ys.

Другой способ выразить это - xs union ys вычисляет сохраняющую порядок многозначное объединение xs и ys. union - это поэтому аналог diff и intersect, которые также работают с многозначными множествами.

that

последовательность, которую нужно добавить.

returns

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

Definition Classes
SeqLike → GenSeqLike
Full Signature

def unzip[A1, A2](implicit asPair: (A) ⇒ (A1, A2)): (List[A1], List[A2])

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

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

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

returns

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

Definition Classes
GenericTraversableTemplate

def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (List[A1], List[A2], List[A3])

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

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))
A1

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

A2

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

A3

тип третьего члена троек элементов

asTriple

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

returns

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

Definition Classes
GenericTraversableTemplate

def updated(index: Int, elem: A): List[A]

[use case]

Копия этого списка с одним заменённым элементом.

index

позиция замены

elem

элемент замены

returns

копия этого списка с элементом в позиции index заменённым на elem.

Definition Classes
SeqLike → GenSeqLike
Полная подпись

def view(from: Int, until: Int): SeqView[A, List[A]]

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

Примечание: разница между view и slice заключается в том, что view создаёт представление текущей последовательности, а slice — новую последовательность.

Примечание: view(from, to) эквивалентно view.slice(from, to)

from

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

until

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

returns

нестрогое представление фрагмента этой последовательности, начинающегося с индекса from и продолжающегося до (но не включая) индекса until.

Definition Classes
SeqLike → IterableLike → TraversableLike

def view: SeqView[A, List[A]]

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

returns

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

Definition Classes
SeqLike → IterableLike → TraversableLike

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

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

Definition Classes
AnyRef
Annotations
@throws( ... )

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

def withFilter(p: (A) ⇒ Boolean): FilterMonadic[A, List[A]]

Создаёт нестрогий фильтр этой коллекции.

Примечание: разница между c filter p и c withFilter p в том, что первый создаёт новую коллекцию, а второй только ограничивает область действия последующих map, flatMap, foreach, и withFilter операций.

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

p

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

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этой коллекции, которые удовлетворяют предикату p.

Definition Classes
TraversableLike → FilterMonadic

final def writeReplace(): AnyRef

Attributes
protected

def zip[B](that: GenIterable[B]): List[(A, B)]

[use case]

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

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableLike → GenIterableLike
Полная сигнатура

def zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): List[(A, B)]

[use case]

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

B

тип второй половины возвращаемых пар

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableLike → GenIterableLike
Полная сигнатура

def zipWithIndex: List[(A, Int)]

[use case]

Объединяет этот список со своими индексами.

returns

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

Definition Classes
IterableLike → GenIterableLike
Полная сигнатура
Пример:

    List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))

def →[B](y: B): (List[A], B)

Implicit
Этот член добавлен неявным преобразованием из List[A] в ArrowAssoc[List[A]], выполненное методом ArrowAssoc в scala.Predef.
Definition Classes
ArrowAssoc

Затенённые неявные члены значения

def filter(p: (A) ⇒ Boolean): TraversableOnce[A]

Неявный
Этот член добавлен благодаря неявной конверсии из List[A] в MonadOps[A], выполненной методом MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(list: MonadOps[A]).filter(p)
Классы определений
MonadOps

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): TraversableOnce[B]

Неявный
Этот член добавлен благодаря неявной конверсии из List[A] в MonadOps[A], выполненной методом MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(list: MonadOps[A]).flatMap(f)
Классы определений
MonadOps

def map[B](f: (A) ⇒ B): TraversableOnce[B]

Неявный
Этот член добавлен благодаря неявной конверсии из List[A] в MonadOps[A], выполненной методом MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(list: MonadOps[A]).map(f)
Классы определений
MonadOps

def withFilter(p: (A) ⇒ Boolean): Iterator[A]

Неявный
Этот член добавлен благодаря неявной конверсии из List[A] в MonadOps[A], выполненной методом MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(list: MonadOps[A]).withFilter(p)
Классы определений
MonadOps

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/collection/immutable/List.html

Spec-Zone.ru

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