Spec-Zone.ru › Scala 2.13 Library

Объект scala.collection.immutable.Stream.Empty

объект Empty extends Stream[Nothing]

Источник
Stream.scala
Линейные супертипы
Поток[Nothing], java.io.Serializable, ЛинейнаяПоследовательность[Nothing], LinearSeqOps[Nothing, [X]Поток[X], Поток[Nothing]], collection.ЛинейнаяПоследовательность[Nothing], collection.LinearSeqOps[Nothing, [X]Поток[X], Поток[Nothing]], АбстрактнаяПоследовательность[Nothing], Последовательность[Nothing], SeqOps[Nothing, [_]Поток[_], Поток[Nothing]], Итерируемый[Nothing], collection.АбстрактнаяПоследовательность[Nothing], collection.Последовательность[Nothing], Equals, collection.SeqOps[Nothing, [_]Поток[_], Поток[Nothing]], ЧастичнаяФункция[Int, Nothing], (Int) => Nothing, АбстрактныйИтерируемый[Nothing], collection.Итерируемый[Nothing], IterableFactoryDefaults[Nothing, [x]Поток[x]],
IterableOps[Nothing, [_]Stream[_], Stream[Nothing]], IterableOnceOps[Nothing, [_]Stream[_], Stream[Nothing]], IterableOnce[Nothing], AnyRef, Any

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

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

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

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

Definition Classes
IterableOps
Annotations
@inline()

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

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

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

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

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

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

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

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

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

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

final def :++[B >: Nothing](suffix: IterableOnce[B]): Stream[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

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

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

Неопределённые элементы представлены как "_", неопределённый хвост представлен как "<not computed>", а циклы представлены как "<cycle>".

sb

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

start

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

sep

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

end

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

returns

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

Definition Classes
Stream → IterableOnceOps

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

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

Пример:

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

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

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

Пример:

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

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

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

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

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction → Function1

def appended[B >: Nothing](elem: B): Stream[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 >: Nothing](suffix: IterableOnce[B]): Stream[B]

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

B

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

suffix

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

returns

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

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

def apply(n: Int): Nothing

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

Классы-определения
LinearSeqOps → SeqOps
Аннотации
@throws(scala.this.throws.<init>$default$1[IndexOutOfBoundsException])

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

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

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

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

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

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

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

x

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

default

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

returns

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

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

2.10

final def asInstanceOf[T0]: T0

Привести объект-приемник к типу T0.

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

returns

объект-приемник.

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

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Seq → Equals

def className: String

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

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

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

returns

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

Attributes
protected[this]
Definition Classes
Stream → Iterable

def clone(): AnyRef

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

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

returns

копия объекта-приемника.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Примечание

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

final def coll: Empty.this.type

returns

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

Attributes
protected
Definition Classes
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

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

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

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

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

возвращает

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

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

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

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

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

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

R

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

k

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

возвращает

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

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

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

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

A

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

g

функция A => T1

возвращает

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

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

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

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

B

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

suffix

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

returns

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

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

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

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

elem

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

that

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

returns

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

Definition Classes
SeqOps

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

Definition Classes
IterableOnceOps
Note

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

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

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

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

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

B

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

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

xs

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

that

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

p

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

возвращает

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

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

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

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

B

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

that

другой набор

p

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

возвращает

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

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

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

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

p

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

возвращает

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

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

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

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

that

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

возвращает

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

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

def distinct: Stream[Nothing]

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

returns

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

Definition Classes
SeqOps

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

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

B

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

f

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

returns

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

Definition Classes
SeqOps

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[Int, Nothing]

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

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

def empty: Stream[Nothing]

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

returns

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

Definition Classes
IterableFactoryDefaults → IterableOps

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

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

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

that

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

returns

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

Definition Classes
SeqOps

final def eq(arg0: AnyRef): Boolean

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

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

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

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

returns

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

Definition Classes
AnyRef

def equals(that: Any): Boolean

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

Definition Classes
Stream → Seq → Equals → AnyRef → Any

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → IterableOnceOps

def filter(pred: (Nothing) => Boolean): Stream[Nothing]

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps

def filterNot(pred: (Nothing) => Boolean): Stream[Nothing]

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

pred

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

returns

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

Definition Classes
Stream → 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: (Nothing) => Boolean): Option[Nothing]

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

final def flatMap[B](f: (Nothing) => IterableOnce[B]): Stream[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
Stream → IterableOps → IterableOnceOps
Note

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

def flatten[B](implicit asIterable: (Nothing) => IterableOnce[B]): Stream[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

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

Специализация Stream для foldLeft, которая позволяет сборщику мусора собирать ресурсы по ходу.

B

Тип накапливаемого значения.

z

Начальное значение, используемое в функции op.

op

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

returns

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

Definition Classes
Stream → LinearSeqOps → IterableOnceOps
Annotations
@tailrec()

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → IterableOnceOps

def force: Empty.this.type

Вынуждает вычисление всей Stream и возвращает ее.

returns

Полностью реализованная Stream.

Definition Classes
Empty → Stream
Note

Часто мы используем Stream для представления бесконечного множества или ряда. Если это верно для вашей конкретной Stream, то эта функция никогда не вернется и, вероятно, вызовет сбой JVM с исключением OutOfMemory. Однако эта функция не будет зависать на конечном цикле.

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

Применяет данную функцию f к каждому элементу этой линейной последовательности (учитывая порядок элементов).

f

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

Definition Classes
Stream → LinearSeqOps → IterableOnceOps
Annotations
@tailrec()
Note

Переопределено здесь как final для вызова хвостовой рекурсии, которая заменяет 'this' на 'tail' на каждой итерации. Это абсолютно необходимо для разрешения сборки мусора подлежащего Stream по мере потребления элементов.

,

Эта функция вынуждает реализацию всего Stream, если f не вызывает исключение.

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

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

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

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

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

,

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

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

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

возвращает

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

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

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

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

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

K

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

f

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

возвращает

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

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

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

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

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

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

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

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

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

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

K

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

B

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

key

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

f

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

Definition Classes
IterableOps

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

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

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

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

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

Definition Classes
IterableOps

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

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

размер

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

возвращает

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

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

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

def hashCode(): Int

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

возвращает

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

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

def head: Nothing

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

возвращает

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

Определяющие классы
Empty → LinearSeqOps → IterableOps
Исключения

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

def headOption: Option[Nothing]

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

возвращает

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

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

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

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

B

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

elem

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

возвращает

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

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

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

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

B

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

elem

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

that

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

returns

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

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

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

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

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

that

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

p

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

returns

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

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

def indices: Range

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

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

returns

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

Definition Classes
SeqOps

def init: Stream[Nothing]

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

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

Definition Classes
IterableOps

def inits: Iterator[Stream[Nothing]]

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

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

returns

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

Definition Classes
IterableOps
Пример:

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

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

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

that

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

returns

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

Definition Classes
SeqOps

def isDefinedAt(x: Int): Boolean

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

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

def isEmpty: Boolean

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

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

returns

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

Definition Classes
Empty → LinearSeqOps → SeqOps → IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: SeqFactory[Stream]

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

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

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

def iterator: Iterator[Nothing]

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

Definition Classes
LinearSeqOps → IterableOnce

def knownSize: Int

returns

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

Definition Classes
Empty → IterableOnce

def last: Nothing

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

returns

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

Definition Classes
LinearSeqOps → IterableOps
Exceptions thrown

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

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

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

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

B

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

elem

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

end

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

returns

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

Definition Classes
SeqOps

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

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

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

that

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

returns

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

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

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

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

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

that

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

end

индекс конца

returns

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

Definition Classes
SeqOps

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

p

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

returns

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

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

def lastOption: Option[Nothing]

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

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

returns

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

Definition Classes
IterableOps

def lazyAppendedAll[B >: Nothing](suffix: => IterableOnce[B]): Stream[B]

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

suffix

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

returns

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

Definition Classes
Stream

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[Nothing, B, Empty.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 length: Int

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

Definition Classes
LinearSeqOps → SeqOps

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

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

that

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

returns

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

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

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

возвращает

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

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

Function.unlift

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

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

B

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

f

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

возвращает

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

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

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

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

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

B

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

ord

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

возвращает

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

разделитель.

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

returns

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

def nonEmpty: Boolean

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

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

Attributes
protected[scala.collection]
Definition Classes
SeqOps

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

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

A1

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

B1

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

that

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

returns

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

Definition Classes
PartialFunction

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

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

B

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

len

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

elem

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

returns

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

Definition Classes
SeqOps

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

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

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

Definition Classes
Stream → IterableOps

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

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

Пример:

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

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

A2

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

f

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

returns

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

Definition Classes
IterableOps

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

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

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

B

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

from

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

other

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

replaced

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

returns

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

Definition Classes
SeqOps

def permutations: Iterator[Stream[Nothing]]

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

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

returns

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

Definition Classes
SeqOps
Пример:

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

final def prepended[B >: Nothing](elem: B): Stream[B]

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

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

Пример:

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

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

scala> println(x)
List(1)
B

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

elem

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

returns

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

Definition Classes
Stream → SeqOps

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

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

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

B

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

prefix

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

returns

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

Definition Classes
SeqOps

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

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

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

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

Специализация Stream для reduceLeft, которая позволяет GC собирать мусор по ходу.

B

Тип накапливаемого значения.

f

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

returns

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

Definition Classes
Stream → IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reverse: Stream[Nothing]

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

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

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

возвращает

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

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

def reverseIterator: Iterator[Nothing]

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

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

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

возвращает

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

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

def reversed: collection.Iterable[Nothing]

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

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

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

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

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

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

action

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

возвращает

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

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

2.10

См. также

applyOrElse.

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

elem

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

from

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

to

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

ord

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

returns

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

Definition Classes
SeqOps
Note

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

See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

elem

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

ord

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

returns

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

Definition Classes
SeqOps
See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

p

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

returns

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

Definition Classes
SeqOps

final def size: Int

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

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

returns

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

Definition Classes
SeqOps → IterableOnceOps

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

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

that

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

returns

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

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

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

Definition Classes
SeqOps → IterableOps

final def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

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

sizeIs

final def sizeIs: SizeCompareOps

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

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

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

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def sliding(size: Int, step: Int): Iterator[Stream[Nothing]]

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

def sliding(size: Int): Iterator[Stream[Nothing]]

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def sortBy[B](f: (Nothing) => B)(implicit ord: Ordering[B]): Stream[Nothing]

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

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

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

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

B

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

f

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

ord

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

returns

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

Definition Classes
SeqOps
Пример:
    val words = "The quick brown fox jumped over the lazy dog".split(' ')
    // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
    words.sortBy(x => (x.length, x.head))
    res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
См. также

scala.math.Ordering

def sortWith(lt: (Nothing, Nothing) => Boolean): Stream[Nothing]

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

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

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

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

lt

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

returns

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

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

def sorted[B >: Nothing](implicit ord: Ordering[B]): Stream[Nothing]

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

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

ord

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

возвращает

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

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

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

def span(p: (Nothing) => Boolean): (Stream[Nothing], Stream[Nothing])

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

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

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

p

предикат проверки

возвращает

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

Классы определения
IterableOps → IterableOnceOps
Примечание

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

def splitAt(n: Int): (Stream[Nothing], Stream[Nothing])

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

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

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

n

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

возвращает

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

Классы определения
IterableOps → IterableOnceOps
Примечание

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

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

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

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

that

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

offset

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

returns

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

Definition Classes
SeqOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[Nothing, S]): S

Возвращает Stepper для элементов этого набора.

Stepper позволяет создать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элемента этой коллекции.

    Для коллекций Int, Short, Byte или Char, возвращается IntStepper. Для коллекций Double или Float, возвращается DoubleStepper. Для коллекций Long, возвращается LongStepper. Для любого другого типа элемента возвращается AnyStepper.

Обратите внимание, что этот метод переопределяется в подклассах, а тип возвращаемого значения уточняется до S with EfficientSplit, например, IndexedSeqOps.stepper. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Stepper могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

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

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

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

B

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

num

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

возвращает

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

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

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

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

def tail: Stream[Nothing]

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

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

def tailDefined: Boolean

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

def tails: Iterator[Stream[Nothing]]

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

returns

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

Definition Classes
LinearSeqOps → IterableOps
Example:

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

def take(n: Int): Stream[Nothing]

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

n

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

def takeRight(n: Int): Stream[Nothing]

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

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

n

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

returns

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

Definition Classes
IterableOps

def takeWhile(p: (Nothing) => Boolean): Stream[Nothing]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def tapEach[U](f: (Nothing) => U): Stream[Nothing]

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

U

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[Nothing]

Definition Classes
IterableOnceOps

final def toIterable: Empty.this.type

returns

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

Definition Classes
Iterable → IterableOps

def toList: List[Nothing]

Definition Classes
IterableOnceOps

def toMap[K, V](implicit ev: <:<[Nothing, (K, V)]): Map[K, V]

Definition Classes
IterableOnceOps

final def toSeq: Empty.this.type

returns

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

Definition Classes
Seq → IterableOnceOps

def toSet[B >: Nothing]: Set[B]

Definition Classes
IterableOnceOps

def toString(): String

возвращает

строковое представление этого набора. Неопределённые элементы представлены как "_", неопределённый хвост представлен как "<not computed>", а циклы представлены как "<cycle>" Примеры:

    "Stream(_, <not computed>)", неполый поток, у которого голова не была оценена; "Stream(_, 1, _, <not computed>)", поток с как минимум тремя элементами, второй из которых был оценён; "Stream(1, 2, 3, <cycle>)", бесконечный поток, содержащий цикл в четвёртом элементе.
Определяющие классы
Stream → Seq → Function1 → Iterable → AnyRef → Any

def toVector: Vector[Nothing]

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

def transpose[B](implicit asIterable: (Nothing) => collection.Iterable[B]): Stream[Stream[B]]

Транспонирует этот итерируемый набор итерируемых наборов в итерируемый набор итерируемых наборов.

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

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

B

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

asIterable

явное преобразование, которое утверждает, что тип элемента этого итерируемого набора является Iterable.

возвращает

двухмерный итерируемый набор итерируемых наборов, у которого n-я строка является n-м столбцом этого итерируемого набора.

Определяющие классы
IterableOps
Исключения

IllegalArgumentException, если все наборы в этом итерируемом наборе не имеют одинаковый размер.

def unapply(a: Int): Option[Nothing]

Попытка извлечь B из A в выражении сопоставления с образцом.

Определяющие классы
PartialFunction

def unzip[A1, A2](implicit asPair: (Nothing) => (A1, A2)): (Stream[A1], Stream[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: (Nothing) => (A1, A2, A3)): (Stream[A1], Stream[A2], Stream[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 >: Nothing](index: Int, elem: B): Stream[B]

Копия этого последовательности с одним заменённым элементом.

B

тип элементов возвращаемой последовательности.

index

позиция замены

elem

заменяющий элемент

returns

новая последовательность, являющаяся копией этой последовательности с элементом в позиции index заменённым на elem.

Definition Classes
SeqOps
Исключения

IndexOutOfBoundsException если index не удовлетворяет 0 <= index < length. В случае ленивой коллекции это исключение может быть выброшено в более позднее время или вообще не выброшено (если конец коллекции никогда не оценивается).

def view: SeqView[Nothing]

Просмотр элементов этой коллекции.

Definition Classes
SeqOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException]) @native()

final def withFilter(p: (Nothing) => Boolean): collection.WithFilter[Nothing, Stream]

A collection.WithFilter which allows GC of the head of stream during processing

p

the predicate used to test elements.

returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable sequence which satisfy the predicate p.

Definition Classes
Stream → IterableOps

def writeReplace(): AnyRef

Attributes
protected[this]
Definition Classes
Stream

final def zip[B](that: IterableOnce[B]): Stream[(Nothing, B)]

Возвращает неизменяемую последовательность, образованную из этой неизменяемой последовательности и другой итерируемой коллекции, объединяя соответствующие элементы в пары. Если одна из двух коллекций длиннее другой, её оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

Итерируемый объект, предоставляющий вторую половину каждой пары результата

returns

новая неизменяемая последовательность, содержащая пары, состоящие из соответствующих элементов этой неизменяемой последовательности и that. Длина возвращаемой коллекции равна минимуму из длин этой неизменяемой последовательности и that.

Definition Classes
Stream → IterableOps

def zipAll[A1 >: Nothing, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Stream[(A1, B)]

Возвращает итерируемую коллекцию, образованную из этой итерируемой коллекции и другой итерируемой коллекции, объединяя соответствующие элементы парами. Если одна из двух коллекций короче другой, элементы-заполнители используются для расширения более короткой коллекции до длины более длинной.

that

итерируемый объект, предоставляющий вторую половину каждой пары результатов

thisElem

элемент, используемый для заполнения результата, если эта итерируемая коллекция короче that.

thatElem

элемент, используемый для заполнения результата, если that короче этой итерируемой коллекции.

returns

новая коллекция типа That, содержащая пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции равна максимальной из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче that, значения thisElem используются для заполнения результата. Если that короче этой итерируемой коллекции, значения thatElem используются для заполнения результата.

Definition Classes
IterableOps

final def zipWithIndex: Stream[(Nothing, Int)]

Склеивает этот неизменяемый последовательность со своими индексами.

returns

Новая неизменяемая последовательность, содержащая пары, состоящие из всех элементов этой неизменяемой последовательности, спаренных с их индексом. Индексы начинаются с 0.

Definition Classes
Stream → IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

Повторное использование: после вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только итератор, который был возвращен. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе тоже.

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/Stream$$Empty$.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API