Spec-Zone.ru › Scala 2.13 Library

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

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

трейт Seq[A] extends Iterable[A] with collection.Seq[A] with SeqOps[A, Seq, Seq[A]] with IterableFactoryDefaults[A, Seq]

Источник
Seq.scala
Линейные надтипы
SeqOps[A, Seq, Seq[A]], Cloneable[Seq[A]], java.lang.Cloneable, 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
Известные подклассы
AbstractBuffer, AbstractSeq, ArrayBuffer, ArrayDeque, ArraySeq, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, Buffer, IndexedBuffer, IndexedSeq, ListBuffer, Queue, Stack, StringBuilder, UnrolledBuffer, Accumulator, AnyAccumulator, DoubleAccumulator, IntAccumulator, LongAccumulator

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

абстрактный def apply(i: Int): A

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

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

абстрактный def iterator: Iterator[A]

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

Definition Classes
IterableOnce

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

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

Definition Classes
SeqOps

абстрактный def update(idx: Int, elem: A): Unit

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

idx

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

elem

новое значение.

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

IndexOutOfBoundsException, если индекс недопустим.

Конкретные члены значения

final def !=(arg0: Any): Boolean

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

returns

true if !(this == that), false otherwise.

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

final def ##(): Int

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

returns

хеш-значение, согласующееся с ==

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

def +(other: String): String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Определяющие классы
SeqOps
Аннотации
@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: StringBuilder): StringBuilder

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

Пример:

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

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

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

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

возвращает

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

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

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

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

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

возвращает

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

Определяющие классы
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.

Definition Classes
SeqOps

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

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

B

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

suffix

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

returns

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

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

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

Definition Classes
PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

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

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

returns

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

Definition Classes
Any
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Seq → Equals

def className: String

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

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

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

returns

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

Attributes
protected[this]
Definition Classes
Iterable

def clone(): Seq[A]

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

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

returns

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

Definition Classes
SeqOps → Cloneable → AnyRef
Note

не указано 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

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

Definition Classes
IterableOnceOps
Example:

    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
Example:

    "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.

Definition Classes
SeqOps → IterableOps
Annotations
@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

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

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

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

p

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

returns

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

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

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

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

that

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

returns

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

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

def distinct: Seq[A]

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

returns

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

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

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

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

B

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

f

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

returns

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

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

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

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

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

n

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

returns

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

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

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

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

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

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

n

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

returns

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

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

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

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

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

p

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

returns

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

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

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

def elementWise: ElementWiseExtractor[Int, A]

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

Definition Classes
PartialFunction
Example:
    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]

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

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

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

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

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

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

Implicit
Этот член добавляется неявным преобразованием из 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 в противном случае.

Definition Classes
AnyRef

def equals(o: Any): Boolean

Метод универсального сравнения равенства, определённый в AnyRef.

Definition Classes
Seq → Equals → AnyRef → Any

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

pred

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
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, к каждому элементу этого итерируемого набора и конкатенации результатов.

Definition Classes
IterableOps → IterableOnceOps
Note

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

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.

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

def formatted(fmtstr: String): String

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

Неявное
Этот член добавляется неявным преобразованием из Seq[A] в StringFormat[Seq[A]], выполняемым методом StringFormat в scala.Predef.
Определяющие классы
StringFormat
Аннотации
@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): immutable.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): immutable.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): immutable.Map[K, B]

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

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

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

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

Definition Classes
IterableOps

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

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

def head: A

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

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

returns

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

Определяющие классы
IterableOps
Возбуждаемые исключения

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

def headOption: Option[A]

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

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

returns

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

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

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

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

B

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

elem

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

returns

индекс >= 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

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

returns

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

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

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

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

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

that

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

returns

первый индекс >= 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

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

returns

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

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

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

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

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

p

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

returns

индекс >= 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

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

returns

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

Definition Classes
SeqOps

def indices: immutable.Range

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

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

returns

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

Definition Classes
SeqOps

def init: Seq[A]

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

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

Definition Classes
IterableOps

def inits: Iterator[Seq[A]]

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

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

returns

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

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

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

returns

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

Definition Classes
SeqOps

def isDefinedAt(idx: Int): Boolean

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

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

idx

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

returns

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

Definition Classes
SeqOps

def isEmpty: Boolean

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

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

returns

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

Definition Classes
SeqOps → IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

Проверяет, можно ли многократно пройтись по этой итерируемой коллекции. Всегда true для Iterables и false для 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

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

returns

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

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

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

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

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

p

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

returns

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

Definition Classes
SeqOps

def lastOption: Option[A]

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

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

returns

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

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

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

returns

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

Definition Classes
Iterable

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

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

that

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

returns

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

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

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

Definition Classes
SeqOps

def lengthCompare(len: Int): Int

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

len

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

returns

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

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

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

Definition Classes
SeqOps
See also

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
Definition Classes
SeqOps
Annotations
@inline()

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

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

returns

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

Definition Classes
PartialFunction
See also

Function.unlift

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

Тип, над которым определён порядок.

ord

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

returns

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

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

final def mkString: String

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

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

возвращает

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

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

final def mkString(sep: String): String

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

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

sep

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

возвращает

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

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

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

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

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

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

start

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

sep

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

end

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

возвращает

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

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

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

final def ne(arg0: AnyRef): Boolean

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

возвращает

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

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

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

возвращает

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

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

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

,

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

def nonEmpty: Boolean

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

возвращает

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

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

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

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

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

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

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

A1

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

B1

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

that

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

возвращает

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

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

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

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

B

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

len

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

elem

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

возвращает

новый массив, состоящий из всех элементов этого массива, за которым следуют минимальное количество вхождений 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

возвращает

пару итерируемых коллекций: первая содержит значения, возвращенные 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

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

возвращает

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

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

def permutations: Iterator[Seq[A]]

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

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

возвращает

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

Классы-определения
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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reverse: Seq[A]

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

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

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

returns

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

Definition Classes
SeqOps

def reverseIterator: Iterator[A]

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

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

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

returns

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

Definition Classes
SeqOps

def reversed: collection.Iterable[A]

Attributes
protected
Definition Classes
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
Примечание

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

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
Примечание

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

См. также

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
См. также

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]

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

Сортировка устойчива. То есть элементы, которые равны (как определено 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

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

возвращает

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

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

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

def startsWith[B >: A](that: IterableOnce[B], offset: Int = 0): Boolean

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

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

that

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

offset

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

возвращает

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

Определяющие классы
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 могут быть преобразованы только в последовательные потоки.

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

def stringPrefix: String

Атрибуты
protected[this]
Определяющие классы
Seq → Iterable
Аннотации
@deprecatedOverriding("Совместимое переопределение", "2.13.0")

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

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

B

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

num

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

возвращает

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

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

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

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

def tail: Seq[A]

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

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

def tails: Iterator[Seq[A]]

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

возвращает

итератор по всем хвостам этой итерируемой коллекции

Определяющие классы
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 отрицательное, возвращает пустую итерируемую коллекцию.

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

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

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

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

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

n

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

returns

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

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

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

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

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

p

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

returns

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

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

def tapEach[U](f: (A) => U): Seq[A]

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

U

тип возвращаемого значения f

f

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

returns

Та же логическая коллекция, что и эта

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

def to[C1](factory: Factory[A, C1]): C1

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

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

def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

Преобразовать коллекцию в массив.

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

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

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

def toIndexedSeq: immutable.IndexedSeq[A]

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

final def toIterable: Seq.this.type

returns

Эта коллекция как Iterable[A]. Новая коллекция не будет создана, если this уже является Iterable[A].

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

def toList: immutable.List[A]

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

def toMap[K, V](implicit ev: <:<[A, (K, V)]): immutable.Map[K, V]

Definition Classes
IterableOnceOps

def toSeq: immutable.Seq[A]

returns

Этот набор элементов как Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Definition Classes
IterableOnceOps

def toSet[B >: A]: immutable.Set[B]

Definition Classes
IterableOnceOps

def toString(): String

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

returns

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

Definition Classes
Seq → Function1 → Iterable → AnyRef → Any

def toVector: immutable.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.

returns

двумерное итерируемое множество итерируемых множеств, в котором n-я строка соответствует n-му столбцу этого итерируемого множества.

Definition Classes
IterableOps
Exceptions thrown

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/mutable/Seq.html

Spec-Zone.ru

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