Spec-Zone.ru › Scala 2.13 Library

Трейт scala.collection.immutable.Seq

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

trait Seq[+A] extends Iterable[A] с collection.Seq[A] с SeqOps[A, Seq, Seq[A]] с IterableFactoryDefaults[A, Seq]

Source
Seq.scala
Линейные супертипы
SeqOps[A, Seq, Seq[A]], collection.Seq[A], Equals, collection.SeqOps[A, [_]Seq[_], Seq[A]], PartialFunction[Int, A], (Int) => A, Iterable[A], collection.Iterable[A], IterableFactoryDefaults[A, [x]Seq[x]], IterableOps[A, [_]Seq[_], Seq[A]], IterableOnceOps[A, [_]Seq[_], Seq[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
::, AbstractSeq, ArraySeq, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, IndexedSeq, LazyList, LinearSeq, List, Nil, NumericRange, Exclusive, Inclusive, Queue, Range, Exclusive, Inclusive, Cons, Empty, Vector, WrappedString, Stream

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

abstract def apply(i: Int): A

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

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

abstract def iterator: Iterator[A]

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

Definition Classes
IterableOnce

abstract def length: Int

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

Definition Classes
SeqOps

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

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

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

final def ++[B >: A](suffix: IterableOnce[B]): Seq[B]

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

Definition Classes
IterableOps
Annotations
@inline()

final def ++:[B >: A](prefix: IterableOnce[B]): Seq[B]

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

final def +:[B >: A](elem: B): Seq[B]

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

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

Definition Classes
SeqOps
Annotations
@inline()

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

Неявный
Этот член добавляется с помощью неявного преобразования из Seq[A] в ArrowAssoc[Seq[A]], выполненного методом ArrowAssoc в scala.Predef. Это преобразование будет выполнено только в том случае, если A является подклассом Option[Nothing] (A <: Option[Nothing]).
Definition Classes
ArrowAssoc
Annotations
@inline()

final def :+[B >: A](elem: B): Seq[B]

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

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

Definition Classes
SeqOps
Annotations
@inline()

final def :++[B >: A](suffix: IterableOnce[B]): Seq[B]

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

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

final def ==(arg0: Any): Boolean

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

возвращает

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

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

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

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

Пример:

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

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

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

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

возвращает

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

Классы определений
IterableOnceOps
Аннотации
@inline()

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

Классы определений
IterableOnceOps
Аннотации
@inline()

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

возвращает

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

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

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

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

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

C

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

k

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

возвращает

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

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

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

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

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

C

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

k

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

возвращает

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

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

def appended[B >: A](elem: B): Seq[B]

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

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

Пример:

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

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

scala> println(a)
List(1)
B

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

elem

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

returns

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

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

def appendedAll[B >: A](suffix: IterableOnce[B]): Seq[B]

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

B

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

suffix

итерируемый объект для добавления.

returns

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

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

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

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

Определяющие классы
PartialFunction
С момента версии

2.10

final def asInstanceOf[T0]: T0

Привести принимающий объект к типу T0.

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

returns

принимающий объект.

Определяющие классы
Any
Выбрасываемые исключения

ClassCastException если принимающий объект не является экземпляром стирания типа T0.

def canEqual(that: Any): Boolean

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

that

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

returns

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

Определяющие классы
Seq → Equals

def className: String

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

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

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

returns

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

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

def clone(): AnyRef

Создать копию принимающего объекта.

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

returns

копия принимающего объекта.

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

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

final def coll: Seq.this.type

returns

Этот набор как C.

Attributes
protected
Definition Classes
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

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

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

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

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

returns

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

Definition Classes
SeqOps
Пример:

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

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

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

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

R

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

k

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

returns

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

Definition Classes
PartialFunction

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

final def concat[B >: A](suffix: IterableOnce[B]): Seq[B]

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

B

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

suffix

траверсабельный объект для добавления.

returns

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

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

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

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

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

elem

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

returns

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

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

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

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

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

that

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

returns

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

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

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

Определяющие классы
IterableOnceOps
Примечание

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

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

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

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

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

B

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

xs

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

start

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

returns

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

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

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

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

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

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

B

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

xs

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

returns

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

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

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

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

B

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

that

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

p

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

returns

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

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

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

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

B

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

that

другая коллекция

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

that

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

returns

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

Definition Classes
SeqOps

def distinct: Seq[A]

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

returns

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

Definition Classes
SeqOps

def distinctBy[B](f: (A) => B): Seq[A]

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

B

тип элементов после преобразования f

f

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

returns

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

Definition Classes
SeqOps

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

def dropWhile(p: (A) => Boolean): Seq[A]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[Int, A]

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

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

def empty: Seq[A]

Пустой итерируемый набор того же типа, что и этот итерируемый набор.

returns

пустой итерируемый набор типа C.

Definition Classes
IterableFactoryDefaults → IterableOps

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

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

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

that

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

returns

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

Definition Classes
SeqOps

def ensuring(cond: (Seq[A]) => Boolean, msg: => Any): Seq[A]

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

def ensuring(cond: (Seq[A]) => Boolean): Seq[A]

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

def ensuring(cond: Boolean, msg: => Any): Seq[A]

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

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

Неявный
Этот член добавлен неявным преобразованием из Seq[A] вEnsuring[Seq[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 в противном случае.

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

def equals(o: Any): Boolean

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

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

def exists(p: (A) => Boolean): Boolean

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

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

p

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

returns

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

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

def filter(pred: (A) => Boolean): Seq[A]

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

returns

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

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

def filterNot(pred: (A) => Boolean): Seq[A]

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

pred

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

returns

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

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

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

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

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

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

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

p

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

returns

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

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

def flatMap[B](f: (A) => IterableOnce[B]): Seq[B]

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def flatten[B](implicit asIterable: (A) => IterableOnce[B]): Seq[B]

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

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

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

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

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

asIterable

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

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

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

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

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

A1

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

z

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

op

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

returns

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

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

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, если эта коллекция пуста.

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

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, если эта коллекция пуста.

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

def forall(p: (A) => Boolean): Boolean

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

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

p

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

returns

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

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

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

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

Definition Classes
IterableOnceOps

def formatted(fmtstr: String): String

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

Implicit
Этот член добавлен неявным преобразованием из Seq[A] в StringFormat[Seq[A]], выполненное методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def fromSpecific(coll: IterableOnce[A]): Seq[A]

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

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def groupBy[K](f: (A) => K): Map[K, Seq[A]]

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

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

K

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

f

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

returns

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

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

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

Definition Classes
IterableOps

def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, Seq[B]]

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

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

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

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

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

K

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

B

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

key

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

f

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

Definition Classes
IterableOps

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

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

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

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

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

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

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

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

size

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

возвращает

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

Классы-определения
IterableOps
См. также

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

def hashCode(): Int

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

возвращает

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

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

def head: A

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

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

возвращает

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

Классы-определения
IterableOps
Исключения

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

def headOption: Option[A]

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

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

возвращает

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

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

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

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

B

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

elem

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

возвращает

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

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

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

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

B

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

elem

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

from

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

возвращает

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

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

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

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

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

that

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

возвращает

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

Классы-определения
SeqOps
Аннотации
@deprecatedOverriding("Override indexOfSlice(that, from) instead - indexOfSlice(that) calls indexOfSlice(that, 0)", "2.13.0")

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

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

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

that

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

from

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

возвращает

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

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

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

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

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

p

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

возвращает

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

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

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

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

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

p

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

from

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

возвращает

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

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

def indices: Range

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

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

возвращает

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

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

def init: Seq[A]

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

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

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

def inits: Iterator[Seq[A]]

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

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

возвращает

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

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

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

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

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

that

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

возвращает

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

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

def isDefinedAt(idx: Int): Boolean

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

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

idx

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

возвращает

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

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

def isEmpty: Boolean

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

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

возвращает

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

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

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: SeqFactory[Seq]

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

Definition Classes
Seq → Seq → Iterable → Iterable → IterableOps
Note

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

def knownSize: Int

returns

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

Definition Classes
IterableOnce

def last: A

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

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

returns

Последний элемент этого итерируемого набора.

Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException Если итерируемый набор пуст.

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

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

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

B

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

elem

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

end

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

returns

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

Definition Classes
SeqOps

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

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

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

that

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

returns

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

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

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

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

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

that

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

end

индекс конца

returns

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

Definition Classes
SeqOps

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

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

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

p

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

возвращает

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

Определяющие классы
SeqOps
Аннотации
@deprecatedOverriding("Override lastIndexWhere(p, end) вместо - lastIndexWhere(p) вызывает lastIndexWhere(p, Int.MaxValue)", "2.13.0")

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

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

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

p

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

возвращает

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

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

def lastOption: Option[A]

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

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

возвращает

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

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

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

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

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

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

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

that

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

возвращает

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

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

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

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

that

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

возвращает

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

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

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

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

def lengthCompare(len: Int): Int

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

len

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

возвращает

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

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

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

Определяющие классы
SeqOps
См. также

lengthIs

final def lengthIs: SizeCompareOps

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

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

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0
Определяющие классы
SeqOps
Аннотации
@inline()

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

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

возвращает

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

Определяющие классы
PartialFunction
См. также

Function.unlift

def map[B](f: (A) => B): Seq[B]

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

B

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

f

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

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

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

B

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

ord

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

B

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

f

Измерительная функция.

cmp

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

B

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

f

Измерительная функция.

cmp

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

returns

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

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

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

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

B

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

ord

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

returns

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

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

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

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

B

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

ord

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

B

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

f

Измерительная функция.

cmp

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[A, Seq[A]]

returns

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Примечание

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

,

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

def nonEmpty: Boolean

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

returns

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

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

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

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

Атрибуты
protected[scala.collection]
Определяющие классы
SeqOps

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

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

A1

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

B1

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

that

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

returns

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

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

def padTo[B >: A](len: Int, elem: B): Seq[B]

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

B

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

len

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

elem

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

returns

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

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

def partition(p: (A) => Boolean): (Seq[A], Seq[A])

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

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

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

def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (Seq[A1], Seq[A2])

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

Пример:

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

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

A2

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

f

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

returns

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

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

def patch[B >: A](from: Int, other: IterableOnce[B], replaced: Int): Seq[B]

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

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

B

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

from

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

other

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

replaced

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

returns

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

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

def permutations: Iterator[Seq[A]]

Перебирает различные перестановки.

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

returns

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

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

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

def prepended[B >: A](elem: B): Seq[B]

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

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

Пример:

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

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

scala> println(x)
List(1)
B

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

elem

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

returns

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

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

def prependedAll[B >: A](prefix: IterableOnce[B]): Seq[B]

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

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

B

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

prefix

добавляемая в начало итерируемая коллекция.

returns

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

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

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

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

B

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

num

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

returns

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

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

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

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

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

B

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

op

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

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

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

B

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

op

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

returns

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

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

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

B

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

op

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

returns

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

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

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 - элементы этой коллекции.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

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

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

B

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

op

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

returns

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

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

def reverse: Seq[A]

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

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

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

returns

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

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

def reverseIterator: Iterator[A]

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

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

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

returns

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

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

def reversed: collection.Iterable[A]

Атрибуты
protected
Определяющие классы
IterableOnceOps

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

See also

applyOrElse.

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

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

Definition Classes
SeqOps

def scan[B >: A](z: B)(op: (B, B) => B): Seq[B]

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, A) => B): Seq[B]

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def scanRight[B](z: B)(op: (A, B) => B): Seq[B]

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

elem

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

from

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

to

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

ord

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

returns

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

Definition Classes
SeqOps
Note

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

See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

elem

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

ord

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

returns

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

Definition Classes
SeqOps
See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

p

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

p

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

returns

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

Definition Classes
SeqOps

final def size: Int

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

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

returns

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

Definition Classes
SeqOps → IterableOnceOps

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

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

that

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

returns

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

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

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

Definition Classes
SeqOps → IterableOps

final def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

Definition Classes
SeqOps → IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

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

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Annotations
@inline()

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

Выбирает интервал элементов. Полученный итерируемый набор состоит из всех элементов x, которые удовлетворяют инварианту:

from <= indexOf(x) < until

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

from

наименьший индекс, включаемый в этом итерируемом наборе.

until

наименьший индекс, ИСКЛЮЧАЕМЫЙ в этом итерируемом наборе.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def sliding(size: Int, step: Int): Iterator[Seq[A]]

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def sortBy[B](f: (A) => B)(implicit ord: Ordering[B]): Seq[A]

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

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

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

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

B

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

f

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

ord

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

returns

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

Definition Classes
SeqOps
Пример:
    val words = "The quick brown fox jumped over the lazy dog".split(' ')
    // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
    words.sortBy(x => (x.length, x.head))
    res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
See also

scala.math.Ordering

def sortWith(lt: (A, A) => Boolean): Seq[A]

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

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

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

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

lt

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

returns

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

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

def sorted[B >: A](implicit ord: Ordering[B]): Seq[A]

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

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

ord

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

returns

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

Definition Classes
SeqOps
See also

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

def span(p: (A) => Boolean): (Seq[A], Seq[A])

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

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

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

p

предикат проверки

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def startsWith[B >: A](that: IterableOnce[B], offset: Int = 0): Boolean

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

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

that

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

offset

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

returns

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

Definition Classes
SeqOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Возвращает Stepper для элементов этой коллекции.

Stepper позволяет создавать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип результирующего Stepper в соответствии с типом элемента этой коллекции.

    Для коллекций Int, Short, Byte или Char, возвращается IntStepperДля коллекций Double или Float, возвращается DoubleStepperДля коллекций Long возвращается LongStepperДля любого другого типа элементов возвращается AnyStepper

Обратите внимание, что этот метод переопределен в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например IndexedSeqOps.stepper. Для Stepper, помеченных как scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Stepper могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
Seq → Iterable
Annotations
@deprecatedOverriding("Compatibility override", "2.13.0")

def sum[B >: A](implicit num: math.Numeric[B]): B

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
AnyRef

def tail: Seq[A]

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

Definition Classes
IterableOps

def tails: Iterator[Seq[A]]

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

returns

итератор по всем хвостам этой итерируемой коллекции

Definition Classes
IterableOps
Пример:

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

def takeWhile(p: (A) => Boolean): Seq[A]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def tapEach[U](f: (A) => U): Seq[A]

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

U

тип возвращаемого значения f

f

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

returns

Такая же логическая коллекция, как и эта

Definition Classes
IterableOps → IterableOnceOps

def to[C1](factory: Factory[A, C1]): C1

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Definition Classes
IterableOnceOps

def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

Преобразование коллекции в массив.

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: Seq.this.type

возвращает

Данную коллекцию как Iterable[A]. Новая коллекция не будет создана, если this уже является Iterable[A].

Definition Classes
Iterable → IterableOps

def toList: List[A]

Definition Classes
IterableOnceOps

def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]

Definition Classes
IterableOnceOps

final def toSeq: Seq.this.type

возвращает

Данную коллекцию как Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Definition Classes
Seq → IterableOnceOps

def toSet[B >: A]: Set[B]

Definition Classes
IterableOnceOps

def toString(): String

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

возвращает

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

Definition Classes
Seq → Function1 → Iterable → AnyRef → Any

def toVector: Vector[A]

Definition Classes
IterableOnceOps

def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): Seq[Seq[B]]

Транспонирует эту итерируемую коллекцию итерируемых коллекций в итерируемую коллекцию итерируемых коллекций.

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

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

B

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

asIterable

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

возвращает

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

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

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

def unapply(a: Int): Option[A]

Пытается извлечь B из A в выражении сопоставления с образцом.

Definition Classes
PartialFunction

def unlift: PartialFunction[Int, B]

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

Implicit
Этот член добавлен неявным преобразованием из Seq[A] в UnliftOps[Int, B], выполненное методом UnliftOps в scala.Function1. Это преобразование выполняется только в том случае, если A является подклассом Option[B] (A <: Option[B]).
Definition Classes
UnliftOps
Пример:

    В отличие от Function.unlift, этот метод UnliftOps.unlift может использоваться в экстракторах.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (Seq[A1], Seq[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип первой половины элементов пар

A2

тип второй половины элементов пар

asPair

неявное преобразование, которое утверждает, что тип элементов этого итерируемого множества является парой.

returns

пара итерируемых множеств, содержащих первую, соответственно, вторую половину каждой пары элементов этого итерируемого множества.

Definition Classes
IterableOps

def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (Seq[A1], Seq[A2], Seq[A3])

Преобразует это итерируемое множество троек в три множества первого, второго и третьего элемента каждой тройки.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

тип первого члена троек элементов

A2

тип второго члена троек элементов

A3

тип третьего члена троек элементов

asTriple

неявное преобразование, которое утверждает, что тип элементов этого итерируемого множества является тройкой.

returns

тройка итерируемых множеств, содержащих первый, второй, соответственно третий член каждой тройки элементов этого итерируемого множества.

Definition Classes
IterableOps

def updated[B >: A](index: Int, elem: B): Seq[B]

Копия этого массива с одним заменённым элементом.

B

тип элементов возвращаемого массива.

index

позиция замены

elem

элемент замены

returns

новый массив, который является копией этого массива с элементом в позиции index заменённым на elem.

Definition Classes
SeqOps
Exceptions thrown

IndexOutOfBoundsException, если index не удовлетворяет 0 <= index < length. В случае ленивой коллекции это исключение может быть выброшено в более позднее время или вообще не выброшено (если конец коллекции никогда не оценивается).

def view: SeqView[A]

Представление над элементами этой коллекции.

Definition Classes
SeqOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withFilter(p: (A) => Boolean): WithFilter[A, [_]Seq[_]]

Создаёт нестрогий фильтр этой итерируемой коллекции.

Примечание: разница между c filter p и c withFilter p заключается в том, что первый создаёт новую коллекцию, а второй только ограничивает область применения последующих map, flatMap, foreach, и withFilter операций.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

p

предикат, используемый для проверки элементов.

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этой итерируемой коллекции, которые удовлетворяют предикату p.

Definition Classes
IterableOps

def zip[B](that: IterableOnce[B]): Seq[(A, B)]

Возвращает итерируемую коллекцию, образованную из этой итерируемой коллекции и другой итерируемой коллекции, объединяя соответствующие элементы парами. Если одна из двух коллекций длиннее другой, оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

Итерируемый объект, предоставляющий вторую половину каждой пары результата

returns

новая итерируемая коллекция, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции является минимальной из длин этой итерируемой коллекции и that.

Definition Classes
IterableOps

def zipAll[A1 >: A, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Seq[(A1, B)]

Возвращает итерируемую коллекцию, образованную из этой итерируемой коллекции и другой итерируемой коллекции, объединяя соответствующие элементы парами. Если одна из двух коллекций короче другой, используются заполняющие элементы для расширения более короткой коллекции до длины более длинной.

that

итерируемый объект, предоставляющий вторую половину каждой пары результата

thisElem

элемент, используемый для заполнения результата, если эта итерируемая коллекция короче that.

thatElem

элемент, используемый для заполнения результата, если that короче этой итерируемой коллекции.

returns

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции равна максимальной из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче that, значения thisElem используются для заполнения результата. Если that короче этой итерируемой коллекции, значения thatElem используются для заполнения результата.

Definition Classes
IterableOps

def zipWithIndex: Seq[(A, Int)]

Объединяет эту итерируемую коллекцию с её индексами.

returns

новая итерируемая коллекция, содержащая пары, состоящие из всех элементов этой итерируемой коллекции, спаренных с их индексом. Индексы начинаются с 0.

Definition Classes
IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

Повторное использование: после вызова этого метода следует отбросить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора неопределённо, может изменяться и может привести к изменениям в новом итераторе тоже.

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/Seq.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API