Spec-Zone.ru › Scala 2.13 Library

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

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

закрытый абстрактный класс Stream[+A] extends AbstractSeq[A] с LinearSeq[A] с LinearSeqOps[A, Stream, Stream[A]] с IterableFactoryDefaults[A, Stream] с Serializable

Аннотации
@deprecated @SerialVersionUID()
Устаревший

(С версии 2.13.0) Используйте LazyList (полностью ленивый) вместо Stream (у которого ленивый только хвост)

Источник
Stream.scala
Линейные супертипы
java.io.Serializable, LinearSeq[A], LinearSeqOps[A, [X]Stream[X], Stream[A]], collection.LinearSeq[A], collection.LinearSeqOps[A, [X]Stream[X], Stream[A]], AbstractSeq[A], Seq[A], SeqOps[A, [_]Stream[_], Stream[A]], Iterable[A], collection.AbstractSeq[A], collection.Seq[A], Equals, collection.SeqOps[A, [_]Stream[_], Stream[A]], PartialFunction[Int, A], (Int) => A, AbstractIterable[A], collection.Iterable[A], IterableFactoryDefaults[A, [x]Stream[x]], IterableOps[A, [_]Stream[_], Stream[
A]], IterableOnceOps[A, [_]Stream[_], Stream[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
Cons, Empty

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

abstract def force: Stream.this.type

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

возвращает

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

Примечание

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

abstract def tailDefined: Boolean

Атрибуты
protected

Члены конкретных значений

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

def #::[B >: A](elem: B): Stream[B]

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

Неявный
Этот член добавляется неявным преобразованием из Stream[A] в Deferrer[A], выполненное методом toDeferrer в scala.collection.immutable.Stream.
Definition Classes
Deferrer

def #:::[B >: A](prefix: Stream[B]): Stream[B]

Создаёт поток, состоящий из конкатенации данного потока и другого потока.

Неявный
Этот член добавляется неявным преобразованием из Stream[A] в Deferrer[A], выполненное методом toDeferrer в scala.collection.immutable.Stream.
Definition Classes
Deferrer

def +(other: String): String

Implicit
This member is added by an implicit conversion from Stream[A] toany2stringadd[Stream[A]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

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

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

Definition Classes
IterableOps
Annotations
@inline()

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

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

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

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

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

Definition Classes
SeqOps
Annotations
@inline()

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

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

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

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

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

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

final def :++[B >: A](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[A, C]): PartialFunction[Int, C]

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction → Function1

def appended[B >: A](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

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

возвращает

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

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

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

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

B

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

suffix

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

возвращает

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

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

def apply(n: Int): A

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

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

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

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

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

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

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

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

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

x

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

default

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

returns

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

Definition Classes
PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

Преобразует получаемый объект в тип T0.

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

returns

получаемый объект.

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

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Seq → Equals

def className: String

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

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

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

возвращает

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

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

def clone(): AnyRef

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

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

возвращает

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

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

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

final def coll: Stream.this.type

возвращает

Эту коллекцию в качестве C.

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

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

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

B

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

pf

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

возвращает

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

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

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

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

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

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

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

returns

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

Definition Classes
SeqOps
Пример:

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

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

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

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

R

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

k

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

returns

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

Definition Classes
PartialFunction

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

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

A

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

g

функция A => T1

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

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

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

B

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

suffix

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

returns

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

Definition Classes
SeqOps → IterableOps
Annotations
@inline()

def contains[A1 >: A](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 >: A](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 >: A](xs: Array[B], start: Int): Int

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

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

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

B

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

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

xs

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

that

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

p

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

returns

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

Definition Classes
SeqOps

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

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

B

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

that

другой набор

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

that

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

returns

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

Definition Classes
SeqOps

def distinct: Stream[A]

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

returns

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

Definition Classes
SeqOps

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

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

B

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

f

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

возвращает

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[Int, A]

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

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

def empty: Stream[A]

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

returns

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

Definition Classes
IterableFactoryDefaults → IterableOps

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

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

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

that

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

returns

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

Definition Classes
SeqOps

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

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

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

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

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

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

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

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

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: (A) => Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → IterableOnceOps

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

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

возвращает

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

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

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

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

pred

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

возвращает

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

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

def finalize(): Unit

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

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

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

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

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

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

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

p

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

возвращает

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

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

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

final def flatMap[B](f: (A) => 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: (A) => 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 >: A](z: A1)(op: (A1, A1) => A1): A1

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → IterableOnceOps

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

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

f

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

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

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

,

Эта функция заставит реализовать весь поток, если f не выбросит исключение.

def formatted(fmtstr: String): String

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

Неявный
Этот член добавлен неявным преобразованием из Stream[A] в StringFormat[Stream[A]], выполненное методом StringFormat в scala.Predef.
Определяющие классы
StringFormat
Аннотации
@inline()

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

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

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

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

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

,

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

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

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

возвращает

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

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

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

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

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

K

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

f

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

returns

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

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

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

Definition Classes
IterableOps

def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, 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: (A) => K)(f: (A) => B)(reduce: (B, B) => B): Map[K, B]

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

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

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

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

Definition Classes
IterableOps

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Seq → AnyRef → Any

def head: A

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

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

returns

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

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

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

def headOption: Option[A]

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

returns

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

Definition Classes
LinearSeqOps → IterableOps

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

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

B

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

elem

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

returns

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

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexOf(elem, from) вместо этого - indexOf(elem) вызывает indexOf(elem, 0)", "2.13.0")

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

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

B

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

elem

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

that

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

returns

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

Definition Classes
SeqOps
Annotations
@deprecatedOverriding("Override indexOfSlice(that, from) вместо этого - indexOfSlice(that) вызывает indexOfSlice(that, 0)", "2.13.0")

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

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

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

that

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

def indexWhere(p: (A) => 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[A]

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

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

Definition Classes
IterableOps

def inits: Iterator[Stream[A]]

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

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

returns

итератор по всем начальным фрагментам (inits) этого итерируемого набора

Definition Classes
IterableOps
Пример:

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

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

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

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
SeqOps → IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def isTraversableAgain: Boolean

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

возвращает

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

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

def iterableFactory: SeqFactory[Stream]

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

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

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

def iterator: Iterator[A]

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

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

def knownSize: Int

возвращает

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

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

def last: A

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

returns

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

Definition Classes
LinearSeqOps → IterableOps
Exceptions thrown

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

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

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

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

B

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

elem

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

end

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

returns

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

Definition Classes
SeqOps

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

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

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

that

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

returns

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

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

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

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

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

that

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

end

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

returns

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

Definition Classes
SeqOps

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

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

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

p

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

p

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

returns

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

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

def lastOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

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

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

suffix

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

returns

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

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[A, B, Stream.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

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

возвращает

Значение 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.

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

lengthIs

final def lengthIs: SizeCompareOps

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

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

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

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

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

возвращает

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

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

Function.unlift

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

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

B

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

f

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

возвращает

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

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

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

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

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

B

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

ord

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

возвращает

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

Атрибуты
protected
Классы-определения
IterableFactoryDefaults → IterableOps
Примечание

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

,

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

def nonEmpty: Boolean

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

возвращает

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

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

final def notify(): Unit

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

Классы-определения
AnyRef
Аннотации
@native()
Примечание

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

final def notifyAll(): Unit

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

Классы-определения
AnyRef
Аннотации
@native()
Примечание

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

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

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

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

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

A1

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

B1

тип возвращаемого значения вспомогательной функции

that

вспомогательная функция

возвращает

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

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

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

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

B

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

len

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

elem

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

возвращает

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

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

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

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

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

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

def partitionMap[A1, A2](f: (A) => 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 >: A](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[A]]

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

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

возвращает

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

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

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

final def prepended[B >: A](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

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

возвращает

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

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

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

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

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

B

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

prefix

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

возвращает

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

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

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

Произведение элементов этого набора.

B

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

num

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

возвращает

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

returns

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

Definition Classes
Stream → IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

где x1, ..., xn — элементы этого набора.

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reverse: Stream[A]

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

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

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

returns

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

Definition Classes
SeqOps

def reverseIterator: Iterator[A]

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

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

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

returns

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

Definition Classes
SeqOps

def reversed: collection.Iterable[A]

Attributes
protected
Definition Classes
IterableOnceOps

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

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

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

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

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

action

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

returns

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

Definition Classes
PartialFunction
Since

2.10

See also

applyOrElse.

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

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

def scanRight[B](z: B)(op: (A, 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 >: A](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult

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

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

elem

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

from

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

to

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

ord

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

returns

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

Definition Classes
SeqOps
Note

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

See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

elem

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

ord

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

returns

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

Definition Classes
SeqOps
See also

scala.collection.IndexedSeq

scala.math.Ordering

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

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

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

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

p

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

from

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

returns

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

Definition Classes
LinearSeqOps → SeqOps

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

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

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

p

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

returns

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

Definition Classes
SeqOps

final def size: Int

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

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

returns

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

Definition Classes
SeqOps → IterableOnceOps

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

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

that

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

returns

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

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

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

Definition Classes
SeqOps → IterableOps

final def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

Definition Classes
SeqOps → IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

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

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

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

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

from <= indexOf(x) < until

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

from

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

until

наименьший индекс для ИСКЛЮЧЕНИЯ из этого итерируемого набора.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

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

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

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

B

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

f

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

ord

порядок, предполагаемый для области B.

returns

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

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

scala.math.Ordering

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

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

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

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

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

lt

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

returns

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

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

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

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

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

ord

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

returns

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

Definition Classes
SeqOps
See also

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

n

позиция разделения.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

that

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

offset

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

returns

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

Definition Classes
SeqOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Возвращает Stepper для элементов этой коллекции.

Stepper позволяет создавать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элементов этой коллекции.

    Для коллекций Int, Short, Byte или Char, возвращается IntStepper. Для коллекций Double или Float, возвращается DoubleStepper. Для коллекций Long, возвращается LongStepper. Для любого другого типа элементов, возвращается AnyStepper.

Обратите внимание, что этот метод переопределен в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например, IndexedSeqOps.stepper. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Stepper могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

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

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

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

B

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

num

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

returns

сумма всех элементов этого набора по отношению к оператору + в num.

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

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

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

def tail: Stream[A]

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

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

def tails: Iterator[Stream[A]]

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

returns

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

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

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

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

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

n

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

Тот же логический набор, что и этот

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

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

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

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

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

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

Преобразовать набор в массив.

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

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

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

def toIndexedSeq: IndexedSeq[A]

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

final def toIterable: Stream.this.type

возвращает

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

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

def toList: List[A]

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

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

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

final def toSeq: Stream.this.type

возвращает

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

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

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

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

Definition Classes
IterableOnceOps

def transpose[B](implicit asIterable: (A) => 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.

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

def unapply(a: Int): Option[A]

Попытка извлечь B из A в выражении сопоставления с образцом.

Definition Classes
PartialFunction

def unlift: PartialFunction[Int, B]

Преобразует необязательную функцию в частичную функцию.

Неявная
Этот член добавлен неявным преобразованием из Stream[A] в UnliftOps[Int, B] с помощью метода UnliftOps в scala.Function1. Это преобразование произойдет только в том случае, если A является подклассом Option[B] (A <: Option[B]).
Определяющие классы
UnliftOps
Пример:

    В отличие от Function.unlift, этот метод UnliftOps.unlift может использоваться в экстракторах.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (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

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

возвращает

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

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

def unzip3[A1, A2, A3](implicit asTriple: (A) => (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 >: A](index: Int, elem: B): Stream[B]

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

B

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

index

позиция замены

elem

заменяющий элемент

returns

новый набор, являющийся копией этого набора с элементом в позиции index заменённым на elem.

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

IndexOutOfBoundsException если index не удовлетворяет 0 <= index < length. В случае ленивого набора это исключение может быть выброшено в более позднее время или вообще не выброшено (если конец набора никогда не оценивается).

def view: SeqView[A]

Вид на элементы этого набора.

Definition Classes
SeqOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

final def withFilter(p: (A) => Boolean): WithFilter[A, Stream]

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

p

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

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этой неизменяемой последовательности, которые удовлетворяют предикату p.

Definition Classes
Stream → IterableOps

def writeReplace(): AnyRef

Attributes
protected[this]

final def zip[B](that: IterableOnce[B]): Stream[(A, B)]

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

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
Stream → IterableOps

def zipAll[A1 >: A, 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[(A, 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.html

Spec-Zone.ru

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