Spec-Zone.ru › Scala 3.2

Трейт IterableOps.IterableOps

Объект-компаньон • Исходный код

trait IterableOps[+A, +CC[_], +C] extends IterableOnce[A] with IterableOnceOps[A, CC, C]

Базовый трейт для операций с Iterable

VarianceNote

Для всех дочерних классов Iterable требуется, чтобы вариативность дочернего класса и вариативность параметра C , переданного в IterableOps, были одинаковыми. Мы не можем выразить это, так как у нас нет полиморфизма вариативности. Поэтому нам приходится в некоторых местах использовать C[A @uncheckedVariance].

Параметры типа
C

тип коллекции (например, List[Int], String, BitSet). Операции, возвращающие коллекцию с тем же типом элемента (например, drop, filter), возвращают C.

CC

конструктор типа коллекции (например, List, Set). Операции, возвращающие коллекцию с другим типом элемента B (например, map), возвращают CC[B].

Надтипы
Трейт IterableOnceOps[A, CC, C]
Трейт IterableOnce[A]
Класс Any
Известные подтипы
244 типа
trait EvidenceIterableFactoryDefaults[A, CC, Ev]
class МассивSeq[A]
class булево
class байт
class символ
class двойное
class с плавающей точкой
class целое
class длинное
class ссылка[T]
class короткое
class единица
class РазвёрнутыйБуфер[T]
trait Итерируемый[A]
class АбстрактныйИтерируемый[A]
class АбстрактныйСловарь[K, V]
class АбстрактныйСловарь[K, V]
class ХэшТаблица[K, V]
class ЦелочисленныйСловарь[T]
class СписокСловарь[K, V]
class ДлинныйСловарь[T]
class Словарь1[K, V]
class Словарь2[K, V]
class Словарь3[K, V]
class Словарь4[K, V]
class СДефолтом[K, V]
class СДефолтом[K, V]
class ДеревоСловарь[K, V]
class ДеревоСписокСловарь[K, V]
class ВекторСловарь[K, V]
class ИзменяемыйСловарь[K, V]
class TrieСловарь[K, V]
class ЛюбойссылкаСловарь[K, V]
class НеколлизионнаяХэшТаблица[K, V]
class ИзменяемаяХэшТаблица[K, V]
class СвязаннаяХэшТаблица[K, V]
class СписокСловарь[K, V]
class ДлинныйСловарь[V]
class СДефолтом[K, V]
class СДефолтом[K, V]
class ОткрытаяХэшТаблица[Key, Value]
class ИзменяемоеДеревоСловарь[K, V]
class СвойстваСистемы
class АбстрактнаяПоследовательность[A]
class НеизменяемаяПоследовательность[A]
class ЛенивыйСписок[A]
class Список[A]
class ::[A]
object Nil.type
class ЧисловойДиапазон[T]
class Исключительный[T]
class Включительно[T]
class Очередь[A]
class Диапазон
class Исключительный
class Включительно
class Поток[A]
class Cons[A]
object Пустой.type
class Вектор[A]
class ОбёрнутаяСтрока
class ИзменяемаяПоследовательность[A]
class ИзменяемыйБуфер[A]
class МассивБуфер[A]
class ДвухстороннийОчередь[A]
class ИзменяемаяОчередь[A]
class Стек[A]
class СписокБуфер[A]
class МассивПоследовательность[T]
class булево
class байт
class символ
class двойное
class с плавающей точкой
class целое
class длинное
class ссылка[T]
class короткое
class единица
class СтрокаПостроитель
class АбстрактноеМножество[A]
class НеизменяемоеМножество[A]
class МножествоЗначений
class НеизменяемыйКлючевойНабор
class БитовыйМассив
class БитовыйМассив1
class БитовыйМассив2
class БитовыйМассивN
class ХэшМножество[A]
class СписокМножество[A]
class Множество1[A]
class Множество2[A]
class Множество3[A]
class Множество4[A]
class НеизменяемыйОтсортированныйКлючевойНабор
class ДеревоМножество[A]
class ИзменяемоеМножество[A]
class ИзменяемыйБитовыйМассив
class ИзменяемоеХэшМножество[A]
class СвязанноеХэшМножество[A]
class ИзменяемоеДеревоМножество[A]
class АбстрактныйПросмотр[A]
class АбстрактныйПросмотрСловаря[K, V]
class Фильтр[K, V]
class ФильтрКлючей[K, V]
class Идентификатор[K, V]
class ЗначенияСловаря[K, V, W]
class ПрименитьККаждому[K, V, U]
class АбстрактныйПросмотрПоследовательности[A]
class АбстрактныйПросмотрИндексируемойПоследовательности[A]
class Срез[A]
class ПросмотрСтроки
class ПросмотрМассивБуфера[A]
class Идентификатор[A]
class Идентификатор[A]
class ОбратныйПорядок[A]
class ОбратныйПорядок[A]
class ДобавитьВКонец[A]
class ДобавитьВКонец[A]
class ДобавитьВКонец[A]
class Собрать[A, B]
class Объединить[A]
class Объединить[A]
class Объединить[A]
class РазныеПо[A, B]
class ОставитьСНачала[A]
class ОставитьСНачала[A]
class ОставитьСНачала[A]
class ОставитьСКонца[A]
class ОставитьСКонца[A]
class ОставитьСКонца[A]
class ОставитьПока[A]
class Элементы[A]
object Пустой.type
class Заполнить[A]
class Фильтр[A]
class ПлоскийМап[A, B]
class Итерировать[A]
class СлеваРазделённый[A, A1, A2]
class Мап[A, B]
class Мап[A, B]
class Мап[A, B]
class ЗаполнитьДо[A]
class ДобавитьВНачало[A]
class ДобавитьВНачало[A]
class ДобавитьВНачало[A]
class RightPartitionMapped[A, A1, A2]
class ScanLeft[A, B]
class Single[A]
class Tabulate[A]
class Take[A]
class Take[A]
class Take[A]
class TakeRight[A]
class TakeRight[A]
class TakeRight[A]
class TakeWhile[A]
class Unfold[A, S]
class Updated[A]
class Zip[A, B]
class ZipAll[A, B]
class ZipWithIndex[A]
class AbstractIterable[A]
class PriorityQueue[A]
trait Map[K, V]
trait DefaultMap[K, V]
trait SeqMap[K, V]
trait SeqMap[K, V]
trait SeqMap[K, V]
trait SortedMap[K, V]
trait SortedMap[K, V]
trait SortedMap[K, V]
trait Map[K, V]
trait Map[K, V]
trait Map[K, V]
trait MultiMap[K, V]
trait Seq[A]
trait IndexedSeq[A]
trait IndexedSeq[A]
trait IndexedSeq[T]
trait IndexedBuffer[A]
trait LinearSeq[A]
trait LinearSeq[A]
trait Seq[A]
trait Seq[A]
trait Buffer[A]
class Accumulator[A, CC, C]
class AnyAccumulator[A]
class DoubleAccumulator
class IntAccumulator
class LongAccumulator
trait Set[A]
trait SortedSet[A]
trait BitSet
trait SortedSet[A]
trait SortedSet[A]
trait Set[A]
trait Set[A]
trait View[A]
trait MapView[K, V]
trait SeqView[A]
trait IndexedSeqView[A]
class Sorted[A, B]
trait Iterable[A]
trait Iterable[A]
trait IterableFactoryDefaults[A, CC]
trait MapFactoryDefaults[K, V, CC, WithFilterCC]
class WeakHashMap[K, V]
trait MapOps[K, V, CC, C]
trait SortedMapFactoryDefaults[K, V, CC, WithFilterCC, UnsortedCC]
trait SortedMapOps[K, V, CC, C]
trait StrictOptimizedSortedMapOps[K, V, CC, C]
trait StrictOptimizedSortedMapOps[K, V, CC, C]
trait SortedMapOps[K, V, CC, C]
trait SortedMapOps[K, V, CC, C]
trait StrictOptimizedMapOps[K, V, CC, C]
trait StrictOptimizedMapOps[K, V, CC, C]
trait MapOps[K, V, CC, C]
trait MapOps[K, V, CC, C]
trait SeqOps[A, CC, C]
trait IndexedSeqOps[A, CC, C]
trait IndexedSeqOps[A, CC, C]
trait IndexedSeqOps[A, CC, C]
trait LinearSeqOps[A, CC, C]
trait StrictOptimizedLinearSeqOps[A, CC, C]
trait LinearSeqOps[A, CC, C]
trait StrictOptimizedSeqOps[A, CC, C]
trait StrictOptimizedSeqOps[A, CC, C]
trait ArrayDequeOps[A, CC, C]
trait SeqOps[A, CC, C]
trait SeqOps[A, CC, C]
trait SetOps[A, CC, C]
trait SortedSetOps[A, CC, C]
trait BitSetOps[C]
trait SortedSetFactoryDefaults[A, CC, WithFilterCC]
trait StrictOptimizedSortedSetOps[A, CC, C]
trait StrictOptimizedSortedSetOps[A, CC, C]
trait SortedSetOps[A, CC, C]
trait SortedSetOps[A, CC, C]
trait StrictOptimizedSetOps[A, CC, C]
trait StrictOptimizedSetOps[A, CC, C]
trait SetOps[A, CC, C]
trait SetOps[A, CC, C]
trait StrictOptimizedIterableOps[A, CC, C]

Абстрактные методы

Источник
def iterableFactory: IterableFactory[CC]

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

Примечание

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

Конкретные методы

Источник
final def ++[B >: A](suffix: IterableOnce[B]): CC[B]

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

Источник
def collect[B](pf: PartialFunction[A, B]): CC[B]

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

Параметры типа
B

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

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

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

Источник
def concat[B >: A](suffix: IterableOnce[B]): CC[B]

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

Параметры типа
B

тип элемента возвращаемой коллекции.
Параметры значения
suffix

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

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

Источник
def drop(n: Int): C

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

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

Параметры значения
n

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

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

Источник
def dropRight(n: Int): C

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

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

Параметры значения
n

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

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

Источник
def dropWhile(p: A => Boolean): C

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

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

Параметры значения
p

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

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

Источник
def empty: C

Пустой итерируемый набор того же типа, что и этот итерируемый набор.

Возвращает

пустой итерируемый набор типа C.

Источник
def filter(pred: A => Boolean): C

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

Параметры значения
p

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

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

Источник
def filterNot(pred: A => Boolean): C

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

Параметры значения
pred

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

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

Источник
def flatMap[B](f: A => IterableOnce[B]): CC[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

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

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

Источник
def flatten[B](implicit asIterable: A => IterableOnce[B]): CC[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.
Возвращает

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

Источник
def groupBy[K](f: A => K): Map[K, C]

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

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

Параметры типа
K

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

функция-дискриминатор.
Возвращает

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

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

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

Источник
def groupMap[K, B](key: A => K)(f: A => B): Map[K, CC[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)

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

Параметры типа
B

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

K

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

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

key

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

Источник
def groupMapReduce[K, B](key: A => K)(f: A => B)(reduce: (B, B) => B): Map[K, B]

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

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

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

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

Источник
def grouped(size: Int): Iterator[C]

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

Параметры значения
size

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

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

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

Источник
def head: A

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

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

Возвращает

первый элемент этого итерируемого набора.
Исключения
NoSuchElementException

если итерируемый набор пуст.

Источник
def headOption: Option[A]

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

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

class="attributes">
Возвращает

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

Исходный код
def init: C

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

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

Исходный код
def inits: Iterator[C]

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

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

class="attributes">
Возвращает

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

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

Исходный код
override def isTraversableAgain: Boolean

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

class="attributes">
Возвращает

true если её можно многократно пройти, false в противном случае.
Определяющие классы IterableOnceOps

Исходный код
def last: A

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

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

class="attributes">
Возвращает

Последний элемент этой итерируемой коллекции.
Исключения
NoSuchElementException

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

Исходный код
def lastOption: Option[A]

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

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

class="attributes">
Возвращает

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

Исходный код
def map[B](f: A => B): CC[B]

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

class="attributes">
Параметры типа
B

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

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

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

Исходный код
def partition(p: A => Boolean): (C, C)

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

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

Исходный код
def partitionMap[A1, A2](f: A => Either[A1, A2]): (CC[A1], CC[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))
class="attributes">
Параметры типа
A1

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

A2

тип элементов второй результирующей коллекции
Параметры значения
f

функция «разбиения», отображающая элементы этой итерируемой коллекции в scala.util.Either
Возвращает

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

Исходный код
def scan[B >: A](z: B)(op: (B, B) => B): CC[B]

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

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

class="attributes">
Параметры типа
B

тип элементов результирующей коллекции
Параметры значения
op

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

z

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

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

Исходный код
def scanLeft[B](z: B)(op: (B, A) => B): CC[B]

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

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

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

class="attributes">
Параметры типа
B

тип элементов в результирующей коллекции
Параметры значения
op

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

z

начальное значение
Возвращает

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

Исходный код
def scanRight[B](z: B)(op: (A, B) => B): CC[B]

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

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

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

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
class="attributes">
Параметры типа
B

тип элементов в результирующей коллекции
Параметры значения
op

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

z

начальное значение
Возвращает

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

Исходный код
def sizeCompare(otherSize: Int): Int

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

class="attributes">
Параметры значения
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.

См. также

sizeIs

Исходный код
def sizeCompare(that: Iterable[_]): Int

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

Параметры значения
that

the Iterable whose size is compared with this iterable collection's size.
Возвращает

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

Исходный код
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

Исходный код
def slice(from: Int, until: Int): C

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

from <= indexOf(x) < until

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

Параметры значения
from

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

until

наименьший индекс, который следует ИСКЛЮЧИТЬ из этой итерируемой коллекции.
Возвращает

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

Исходный код
def sliding(size: Int): Iterator[C]

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

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

Параметры значения
size

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

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

scala.collection.Iterator, метод sliding
Пример

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Исходный код
def sliding(size: Int, step: Int): Iterator[C]

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

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

Параметры значения
size

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

step

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

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

scala.collection.Iterator, метод sliding
Пример

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Исходный код
def span(p: A => Boolean): (C, C)

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

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

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

Параметры значения
p

предикат проверки
Возвращает

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

Исходный код
override def splitAt(n: Int): (C, C)

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

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

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

Параметры значения
n

позиция разделения.
Возвращает

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

Исходный код
def tail: C

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

Исходный код
def tails: Iterator[C]

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

Возвращает

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

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

Исходный код
def take(n: Int): C

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

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

Параметры значения
n

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

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

Исходный код
def takeRight(n: Int): C

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

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

Параметры значения
n

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

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

Исходный код
def takeWhile(p: A => Boolean): C

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

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

Параметры значения
p

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

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

Исходный код
override def tapEach[U](f: A => U): C

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

Тип параметров
U

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

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

Тот же логический набор, что и этот
Классы определений IterableOnceOps

Источник
def transpose[B](implicit asIterable: A => Iterable[B]): CC[CC[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-м столбцом этого итерируемого набора.
Исключения
IllegalArgumentException

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

Источник
def unzip[A1, A2](implicit asPair: A => (A1, A2)): (CC[A1], CC[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Тип параметров
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов
Параметры значения
asPair

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

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

Источник
def unzip3[A1, A2, A3](implicit asTriple: A => (A1, A2, A3)): (CC[A1], CC[A2], CC[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

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

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

Источник
def view: View[A]

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

Источник
def withFilter(p: A => Boolean): WithFilter[A, CC]

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

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

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

Параметры значения
p

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

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

Источник
def zip[B](that: IterableOnce[B]): CC[(A, B)]

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

Тип параметров
B

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

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

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

Источник
def zipAll[A1 >: A, B](that: Iterable[B], thisElem: A1, thatElem: B): CC[(A1, B)]

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

Параметры значения
that

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

thatElem

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

thisElem

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

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

Источник
def zipWithIndex: CC[(A, Int)]

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

Возвращает

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

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

Наследуемые методы

Источник
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

Источник
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

Source
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

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

end

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

sep

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

start

начальная строка.
Возвращает

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

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

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

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

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

Параметры значений
pf

частичная функция
Возвращает

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

Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Унаследовано от IterableOnceOps

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

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

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

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

Параметры типов
B

тип элементов массива.
Параметры значений
len

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

start

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

xs

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

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

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

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

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

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

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

Параметры типов
B

тип элементов массива.
Параметры значений
start

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

xs

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

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

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

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

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

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

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

Параметры типа
B

тип элементов массива.
Параметры значения
xs

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

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

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

Источник
def corresponds[B](that: IterableOnce[B])(p: (A, B) => Boolean): Boolean

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

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

Параметры типа
B

тип элементов that
Параметры значения
p

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

that

другой набор
Возвращает

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

Источник
def count(p: A => Boolean): Int

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

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

Параметры значения
p

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

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

Источник
def exists(p: A => Boolean): Boolean

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

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

Параметры значения
p

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

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

Источник
def find(p: A => Boolean): Option[A]

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

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

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

Параметры значения
p

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

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

Источник
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

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

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

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

class="attributes">
Параметры типа
A1

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

Параметры значения
op

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

z

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

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

Источник
def foldLeft[B](z: B)(op: (B, A) => B): B

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

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

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

class="attributes">
Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

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

z

начальное значение.
Возвращает

результат вставки op между последовательными элементами этой коллекции слева направо с начальным значением z слева: op(...op(z, x1), x2, ..., xn), где x1, ..., xn - элементы этой коллекции. Возвращает z если эта коллекция пустая.
Унаследовано от IterableOnceOps

Источник
def foldRight[B](z: B)(op: (A, B) => B): B

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

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

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

class="attributes">
Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

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

z

начальное значение.
Возвращает

результат вставки op между последовательными элементами этой коллекции справа налево с начальным значением z справа: op(x1, op(x2, ... op(xn, z)...)), где x1, ..., xn - элементы этой коллекции. Возвращает z если эта коллекция пустая.
Унаследовано от IterableOnceOps

Источник
def forall(p: A => Boolean): Boolean

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

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

class="attributes">
Параметры значения
p

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

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

Источник
def foreach[U](f: A => U): Unit

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

class="attributes">
Унаследовано от IterableOnceOps

Источник
def isEmpty: Boolean

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

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

class="attributes">
Возвращает

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

Источник
def iterator: Iterator[A]

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

class="attributes">
Унаследовано от IterableOnce

Источник
def knownSize: Int

class="attributes">
Возвращает

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

Источник
def max[B >: A](implicit ord: Ordering[B]): A

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

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

class="attributes">
Параметры типа
B

Тип, по которому определено упорядочение.
Параметры значения
ord

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

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

если эта коллекция пуста.
Унаследовано от IterableOnceOps

Источник
def maxBy[B](f: A => B)(implicit cmp: Ordering[B]): A

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

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

class="attributes">
Параметры типа
B

Тип результата функции f.
Параметры значения
cmp

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

f

Функция измерения.
Возвращает

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

если эта коллекция пуста.
Унаследовано от IterableOnceOps

Источник
def maxByOption[B](f: A => B)(implicit cmp: Ordering[B]): Option[A]

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

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

class="attributes">
Параметры типа
B

Тип результата функции f.
Параметры значения
cmp

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

f

Функция измерения.
Возвращает

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

Источник
def maxOption[B >: A](implicit ord: Ordering[B]): Option[A]

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

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

Параметры типа
B

Тип, по которому определяется порядок.
Параметры значения
ord

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

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

Унаследовано от IterableOnceOps

Источник
def min[B >: A](implicit ord: Ordering[B]): A

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

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

Параметры типа
B

Тип, по которому определяется порядок.
Параметры значения
ord

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

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

Исключения
UnsupportedOperationException

если этот набор пуст.
Унаследовано от IterableOnceOps

Источник
def minBy[B](f: A => B)(implicit cmp: Ordering[B]): A

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

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

Параметры типа
B

Тип результата функции f.
Параметры значения
cmp

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

f

Функция измерения.
Возвращает

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

Исключения
UnsupportedOperationException

если этот набор пуст.
Унаследовано от IterableOnceOps

Источник
def minByOption[B](f: A => B)(implicit cmp: Ordering[B]): Option[A]

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

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

Параметры типа
B

Тип результата функции f.
Параметры значения
cmp

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

f

Функция измерения.
Возвращает

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

Унаследовано от IterableOnceOps

Источник
def minOption[B >: A](implicit ord: Ordering[B]): Option[A]

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

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

Параметры типа
B

Тип, по которому определяется порядок.
Параметры значения
ord

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

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

Унаследовано от IterableOnceOps

Источник
final def mkString: String

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

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

END_OF_DOCUMENT_MARKER
Возвращает

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

Исходный код
final def mkString(sep: String): String

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

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

Параметры значения
sep

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

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

Пример

List(1, 2, 3).mkString("|") = "1|2|3"
Унаследовано от IterableOnceOps

Исходный код
final def mkString(start: String, sep: String, end: String): String

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

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

Параметры значения
end

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

sep

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

start

начальная строка.
Возвращает

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

Пример

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Унаследовано от IterableOnceOps

Исходный код
def nonEmpty: Boolean

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

Возвращает

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

Исходный код
def product[B >: A](implicit num: Numeric[B]): B

Перемножает элементы этого набора.

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

Параметры типа
B

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

Параметры значения
num

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

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

Унаследовано от IterableOnceOps

Исходный код
def reduce[B >: A](op: (B, B) => B): B

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

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

Параметры типа
B

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

Параметры значения
op

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

Результат применения оператора reduce op ко всем элементам, если набор не пуст.
Исключения
UnsupportedOperationException

если этот набор пуст.
Унаследовано от IterableOnceOps

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

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

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

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

Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

бинарный оператор.
Возвращает

результат вставки op между последовательными элементами этой коллекции, слева направо: op( op( ... op(x1, x2) ..., xn-1), xn) где x1, ..., xn — элементы этой коллекции.
Выбрасывает
UnsupportedOperationException

если эта коллекция пуста.
Унаследовано от IterableOnceOps

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

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

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

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

Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

бинарный оператор.
Возвращает

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

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

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

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

Параметры типа
B

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

Параметры значения
op

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

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

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

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

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

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

Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

бинарный оператор.
Возвращает

результат вставки op между последовательными элементами этой коллекции, справа налево: op(x1, op(x2, ..., op(xn-1, xn)...)) где x1, ..., xn — элементы этой коллекции.
Выбрасывает
UnsupportedOperationException

если эта коллекция пуста.
Унаследовано от IterableOnceOps

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

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

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

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

Параметры типа
B

тип результата бинарного оператора.
Параметры значения
op

бинарный оператор.
Возвращает

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

Source
protected def reversed: Iterable[A]

Унаследовано от IterableOnceOps

Source
def size: Int

Размер этой коллекции.

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

Возвращает

количество элементов в этой коллекции.
Унаследовано от IterableOnceOps

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

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

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

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

  • Для коллекций Int, Short, Byte или Char, возвращается scala.collection.IntStepper

  • Для коллекций Double или Float, возвращается scala.collection.DoubleStepper

  • Для коллекций Long возвращается scala.collection.LongStepper

  • Для любого другого типа элементов возвращается scala.collection.AnyStepper

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

Унаследовано от IterableOnce

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

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

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

Параметры типа
B

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

Параметры значения
num

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

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

Унаследовано от IterableOnceOps

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

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

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

Унаследовано от IterableOnceOps

Source
def toArray[B >: A : ClassTag]: Array[B]

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

Примечание к реализации: НЕ вызывайте Array.from из этого метода.

Унаследовано от IterableOnceOps

Исходный код
final def toBuffer[B >: A]: Buffer[B]

Унаследовано от IterableOnceOps

Исходный код
def toIndexedSeq: IndexedSeq[A]

Унаследовано от IterableOnceOps

Исходный код
def toList: List[A]

Унаследовано от IterableOnceOps

Исходный код
def toMap[K, V](implicit ev: A <:< (K, V)): Map[K, V]

Унаследовано от IterableOnceOps

Исходный код
def toSeq: Seq[A]

Возвращает

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

Исходный код
def toSet[B >: A]: Set[B]

Унаследовано от IterableOnceOps

Исходный код
def toVector: Vector[A]

Унаследовано от IterableOnceOps

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.2.0/scala/collection/IterableOps.html

Spec-Zone.ru

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