Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.mutable.AbstractIterable

абстрактный класс AbstractIterable[A] extends collection.AbstractIterable[A] with Iterable[A]

Явное создание экземпляра Iterable для уменьшения размера файла класса в дочерних классах.

Аннотации
@SerialVersionUID()
Источник
Iterable.scala
Линейные супертипы
Iterable[A], collection.AbstractIterable[A], collection.Iterable[A], IterableFactoryDefaults[A, [x]Iterable[x]], IterableOps[A, [_]Iterable[_], Iterable[A]], IterableOnceOps[A, [_]Iterable[_], Iterable[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
PriorityQueue

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

new AbstractIterable()

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

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

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

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

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

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 +(other: String): String

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

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

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

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

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

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

final def ==(arg0: Any): Boolean

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

возвращает

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

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

final def addString(b: StringBuilder): StringBuilder

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

Пример:

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

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

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

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

возвращает

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

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

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

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

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps

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 className: String

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

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

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

returns

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

Attributes
protected[this]
Definition Classes
Iterable

def clone(): AnyRef

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

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

returns

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

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

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

final def coll: AbstractIterable.this.type

returns

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

Attributes
protected
Definition Classes
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

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

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

B

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

suffix

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

returns

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

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

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

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

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

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

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

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

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

B

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

xs

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

start

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

returns

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

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

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

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

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

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

B

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

xs

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

returns

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

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

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

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

B

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

that

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

p

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

returns

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

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

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

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

p

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

returns

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

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def empty: Iterable[A]

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

returns

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

Definition Classes
IterableFactoryDefaults → IterableOps

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

def equals(arg0: AnyRef): Boolean

Метод равенства для ссылочных типов. Реализация по умолчанию делегирует в eq.

См. также equals в scala.Any.

возвращает

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

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

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

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

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

p

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

возвращает

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

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

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

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

возвращает

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

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

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

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

pred

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

возвращает

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

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

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

возвращает

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

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

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

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

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

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

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

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

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

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

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

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

asIterable

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

returns

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

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

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

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

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

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

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

A1

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

z

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

op

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

returns

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

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

p

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

returns

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

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

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

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

Definition Classes
IterableOnceOps

def formatted(fmtstr: String): String

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

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

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

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

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

Атрибуты
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Примечание

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

,

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

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def groupBy[K](f: (A) => K): immutable.Map[K, Iterable[A]]

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

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

K

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

f

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

returns

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

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

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

Definition Classes
IterableOps

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

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

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

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

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

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

K

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

B

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

key

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

f

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

Definition Classes
IterableOps

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

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

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

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

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

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

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

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

size

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

возвращает

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

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

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

def hashCode(): Int

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

возвращает

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

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

def head: A

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

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

возвращает

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

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

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

def headOption: Option[A]

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

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

возвращает

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

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

def init: Iterable[A]

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

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

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

def inits: Iterator[Iterable[A]]

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

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

возвращает

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

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

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

def isEmpty: Boolean

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

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

возвращает

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

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

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

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

Definition Classes
Iterable → Iterable → IterableOps
Note

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

def knownSize: Int

returns

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

Definition Classes
IterableOnce

def last: A

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

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

returns

Последний элемент этой итерируемой коллекции.

Definition Classes
IterableOps
Exceptions thrown

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

def lastOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

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

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

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

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

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

that

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

returns

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

Definition Classes
Iterable

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[A, Iterable[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 partition(p: (A) => Boolean): (Iterable[A], Iterable[A])

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

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

Definition Classes
IterableOps

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

необязательное значение, содержащее результат 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 reversed: collection.Iterable[A]

Attributes
protected
Definition Classes
IterableOnceOps

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

Definition Classes
IterableOps

def size: Int

Размер этого набора.

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

возвращает

количество элементов в этом наборе.

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

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

Сравнивает размер этого итерируемого набора с размером другого Iterable.

that

Iterable, размер которого сравнивается с размером этого итерируемого набора.

возвращает

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

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

def sizeCompare(otherSize: Int): Int

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

otherSize

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

возвращает

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

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

sizeIs

final def sizeIs: SizeCompareOps

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

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

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Классы определений
IterableOps
Аннотации
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

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

возвращает

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

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

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

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

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

size

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

step

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

возвращает

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

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

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

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

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

size

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

возвращает

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

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

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

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

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

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

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

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
Iterable
Annotations
@deprecatedOverriding("Override className instead", "2.13.0")

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
AnyRef

def tail: Iterable[A]

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

Definition Classes
IterableOps

def tails: Iterator[Iterable[A]]

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

returns

итератор по всем хвостам этого итерируемого набора

Definition Classes
IterableOps
Example:

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: immutable.IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: AbstractIterable.this.type

возвращает

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

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

def toList: immutable.List[A]

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

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

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

def toSeq: immutable.Seq[A]

возвращает

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

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

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

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

def toString(): String

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

возвращает

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

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

def toVector: immutable.Vector[A]

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

def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): Iterable[Iterable[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 unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (Iterable[A1], Iterable[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)): (Iterable[A1], Iterable[A2], Iterable[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 view: View[A]

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

Definition Classes
IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withFilter(p: (A) => Boolean): WithFilter[A, [_]Iterable[_]]

Создаёт нестрогое фильтрование этого итерируемого набора.

Примечание: разница между c filter p и c withFilter p заключается в том, что первый создаёт новый набор, а второй лишь ограничивает область действия последующих map, flatMap, foreach и withFilter операций.

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

p

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

returns

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

Definition Classes
IterableOps

def zip[B](that: IterableOnce[B]): Iterable[(A, B)]

Возвращает итерируемый набор, сформированный из этого итерируемого набора и другого итерируемого набора путём объединения соответствующих элементов в пары. Если один из двух наборов длиннее другого, оставшиеся элементы игнорируются.

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableOps

def zipAll[A1 >: A, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

that

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

thisElem

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

thatElem

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

returns

новый набор типа That, содержащий пары, состоящие из соответствующих элементов этого итерируемого набора и that. Длина возвращаемого набора — это максимум из длин этого итерируемого набора и that. Если этот итерируемый набор короче that, в результате используются значения thisElem. Если that короче этого итерируемого набора, в результате используются значения thatElem.

Definition Classes
IterableOps

def zipWithIndex: Iterable[(A, Int)]

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Пример:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Примечание

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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/mutable/AbstractIterable.html

Spec-Zone.ru

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