Spec-Zone.ru › Scala 2.13 Library

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

final класс Cons[A] extends Stream[A]

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

Конструкторы экземпляров

new Cons(head: A, tl: => Поток[A])

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

final def !=(arg0: Any): Boolean

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

возвращает

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

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

final def ##(): Int

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

возвращает

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

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

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

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

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

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

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

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

def #:::[B >: A](prefix: Поток[B]): Поток[B]

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

Неявный
Этот член добавлен неявным преобразованием из Cons[A] в Deferrer[A] с помощью метода toDeferrer в scala.collection.immutable.Stream.
Классы определений
Deferrer

def #:::[B >: A](prefix: Поток[B]): Поток[B]

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

Неявный
Этот член добавлен неявным преобразованием из Cons[A] в Deferrer[A] с помощью метода toDeferrer в scala.collection.immutable.Stream.
Классы определений
Deferrer

def +(other: Строка): Строка

Неявный
Этот член добавлен неявным преобразованием из Cons[A] в any2stringadd[Cons[A]] с помощью метода any2stringadd в scala.Predef.
Классы определений
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): (Cons[A], B)

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

Definition Classes
SeqOps

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

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

B

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

suffix

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

возвращает

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

Definition Classes
SeqOps

def apply(n: Int): A

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

Definition Classes
LinearSeqOps → SeqOps
Annotations
@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
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Seq → Equals

def className: String

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

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

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

returns

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

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

def clone(): AnyRef

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

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

returns

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

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

не определено SLS как член AnyRef

final def coll: Cons.this.type

returns

Эта коллекция как C.

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

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

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

B

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

pf

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

returns

новая неизменяемая последовательность, полученная путём применения данной частичной функции 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

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

возвращает

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

Definition Classes
PartialFunction

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

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

A

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

g

функция A => T1

возвращает

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

Definition Classes
Function1
Annotations
@unspecialized()

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

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

B

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

suffix

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

возвращает

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

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

returns

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

Definition Classes
SeqOps

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
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: (Cons[A]) => Boolean, msg: => Any): Cons[A]

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

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

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

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

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

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

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

возвращает

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

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

def equals(that: Any): Boolean

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

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

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

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

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

p

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

возвращает

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

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

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

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps

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

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

pred

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

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

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

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

p

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

returns

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

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

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

op

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

returns

результат применения оператора свертки 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

def force: Cons.this.type

Принудительно выполняет оценку всего Stream и возвращает его.

возвращает

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

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

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

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

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

f

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

Определяющие классы
Stream → LinearSeqOps → IterableOnceOps
Аннотации
@tailrec()
Примечание

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

,

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

def formatted(fmtstr: String): String

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

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

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

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

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

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

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

,

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

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

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

возвращает

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

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

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

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

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

K

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

f

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

возвращает

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

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

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

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

val head: A

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

returns

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

Definition Classes
Cons → LinearSeqOps → IterableOps
Exceptions thrown

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) instead - indexOf(elem) calls indexOf(elem, 0)", "2.13.0")

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

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

B

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

elem

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

from

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

returns

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

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) instead - indexOfSlice(that) calls indexOfSlice(that, 0)", "2.13.0")

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

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

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

that

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

from

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

returns

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

Definition Classes
SeqOps

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

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

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

p

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

from

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

возвращает

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

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

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

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

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

p

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

возвращает

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

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

def indices: Range

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

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

возвращает

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

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

def init: Stream[A]

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

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

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

def inits: Iterator[Stream[A]]

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

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

возвращает

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

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

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: SeqFactory[Stream]

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

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

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

def iterator: Iterator[A]

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

Definition Classes
LinearSeqOps → IterableOnce

def knownSize: Int

returns

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

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

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

Definition Classes
Stream

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

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

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

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

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

that

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

возвращает

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

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

def length: Int

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

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

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

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

that

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

возвращает

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

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

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

Определяющие классы
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
Definition Classes
SeqOps
Annotations
@inline()

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

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

returns

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

Definition Classes
PartialFunction
See also

Function.unlift

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

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

B

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

f

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

returns

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

Definition Classes
Stream → IterableOps → IterableOnceOps
Note

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

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

returns

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

def nonEmpty: Boolean

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

returns

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

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

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

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

Attributes
protected[scala.collection]
Definition Classes
SeqOps

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

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

A1

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

B1

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

that

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

returns

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

Definition Classes
PartialFunction

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

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

B

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

len

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

elem

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

returns

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

Definition Classes
SeqOps

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

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

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

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

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

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

returns

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

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

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

returns

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

Definition Classes
Stream → SeqOps

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

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

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

B

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

prefix

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

returns

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

Definition Classes
SeqOps

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

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

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

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reverse: Stream[A]

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

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

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

возвращает

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

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

def reverseIterator: Iterator[A]

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

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

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

возвращает

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

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

def reversed: collection.Iterable[A]

Атрибуты
protected
Классы определений
IterableOnceOps

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

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

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

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

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

action

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

возвращает

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

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

2.10

См. также

applyOrElse.

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

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

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

the 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]

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

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

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

возвращает

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

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

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

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

lazy val tail: Stream[A]

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

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

def tailDefined: Boolean

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

def tails: Iterator[Stream[A]]

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

returns

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

Definition Classes
LinearSeqOps → IterableOps
Example:

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

def take(n: Int): Stream[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 к своим элементам немедленно, в то время как ленивые наборы, такие как представления и LazyLists, будут применять f к каждому элементу только при его оценке, и каждый раз, когда этот элемент оценивается.

U

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

f

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

возвращает

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

Definition Classes
IterableOps → IterableOnceOps

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

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

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: Cons.this.type

returns

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

Definition Classes
Iterable → IterableOps

def toList: List[A]

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

final def toSeq: Cons.this.type

returns

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

Definition Classes
Seq → IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

возвращает

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

    "Stream(_, <not computed>)", непустой поток, чья головка ещё не вычислена; "Stream(_, 1, _, <not computed>)", поток с как минимум тремя элементами, второй из которых уже вычислен; "Stream(1, 2, 3, <cycle>)", бесконечный поток, содержащий цикл с четвёртого элемента.
Классы-определения
Stream → Seq → Function1 → Iterable → AnyRef → Any

def toVector: Vector[A]

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

возвращает

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

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

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

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

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

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

def unlift: PartialFunction[Int, B]

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

Неявное
Этот член добавляется неявным преобразованием из Cons[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): collection.WithFilter[A, Stream]

A collection.WithFilter которая позволяет GC головы потока во время обработки

p

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

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этой неизменяемой последовательности, которые удовлетворяют предикату p.

Definition Classes
Stream → IterableOps

def writeReplace(): AnyRef

Attributes
protected[this]
Definition Classes
Stream

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$$Cons.html

Spec-Zone.ru

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