Класс scala.Option

@SerialVersionUID(-114498752079829388L)

sealed abstract class Option[+A] extends IterableOnce[A] with Product with Serializable

Представляет необязательные значения. Экземпляры Option являются либо экземпляром scala.Some, либо объектом None.

Наиболее удобный способ использования экземпляра scala.Option — это рассматривать его как коллекцию или монаду и использовать map, flatMap, filter, или foreach:

val name: Option[String] = request getParameter "name"
val upper = name map { _.trim } filter { _.length != 0 } map { _.toUpperCase }
println(upper getOrElse "")

Обратите внимание, что это эквивалентно

val upper = for {
  name <- request getParameter "name"
  trimmed <- Some(name.trim)
  upper <- Some(trimmed.toUpperCase) if trimmed.length != 0
} yield upper
println(upper getOrElse "")

Из-за того, как работает понимание цикла for, если None возвращается из request.getParameter, всё выражение результатом будет None

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

Вот полезные методы, которые существуют как для scala.Some, так и для None. - isDefined — True, если не пусто - isEmpty — True, если пусто - nonEmpty — True, если не пусто - orElse — Вычислить и вернуть альтернативное необязательное значение, если пусто - getOrElse — Вычислить и вернуть альтернативное значение, если пусто - get — Возвращает значение, бросает исключение, если пусто - fold — Применить функцию к необязательному значению, вернуть значение по умолчанию, если пусто - map — Применить функцию к необязательному значению - flatMap — То же, что и map, но функция должна возвращать необязательное значение - foreach — Применить процедуру к значению Option - collect — Применить частичное сопоставление шаблонов к необязательному значению - filter — Необязательное значение удовлетворяет предикату - filterNot — Необязательное значение не удовлетворяет предикату - exists — Применить предикат к необязательному значению или false, если пусто - forall — Применить предикат к необязательному значению или true, если пусто - contains — Проверяет, равно ли значение необязательному значению, или false, если пусто - zip — Объединяет два необязательных значения, чтобы получить парное необязательное значение - unzip — Разделяет пару необязательных значений на два необязательных значения - unzip3 — Разделяет тройку необязательных значений на три необязательных значения - toList — Одноэлементный список необязательного значения, в противном случае пустой список

Менее удобный способ использования значений scala.Option — через сопоставление шаблонов:

val nameMaybe = request getParameter "name"
nameMaybe match {
  case Some(name) =>
    println(name.trim.toUppercase)
  case None =>
    println("No name value")
}

Взаимодействие с кодом, который иногда может возвращать null, можно безопасно обернуть в scala.Option, чтобы получить None и scala.Some в противном случае.

val abc = new java.util.HashMap[Int, String]
abc.put(1, "A")
bMaybe = Option(abc.get(2))
bMaybe match {
 case Some(b) =>
   println(s"Found $b")
 case None =>
   println("Not found")
}

Класс-подобные объекты

Исходный код

Класс WithFilter(p: A => Boolean)

Нам нужен целый класс WithFilter, чтобы сохранить контракт «не создает новую коллекцию», даже если это, кажется, мало что меняет в коллекции с максимальным размером 1.

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

Исходный код

def get: A

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

Это эквивалентно:

option match {
 case Some(x) => x
 case None    => throw new Exception
}

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

Исходный код@inline

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

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

// Returns Some(HTTP) because the partial function covers the case.
Some("http") collect {case "http" => "HTTP"}
// Returns None because the partial function doesn't cover the case.
Some("ftp") collect {case "http" => "HTTP"}
// Returns None because the option is empty. There is no value to pass to the partial function.
None collect {case value => value}

Исходный код

final def contains[A1 >: A](elem: A1): Boolean

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

Это эквивалентно:

option match {
 case Some(x) => x == elem
 case None    => false
}

// Returns true because Some instance contains string "something" which equals "something".
Some("something") contains "something"
// Returns false because "something" != "anything".
Some("something") contains "anything"
// Returns false when method called on None.
None contains "anything"

Исходный код@inline

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

Возвращает true, если этот Option не пуст, и предикат p возвращает true, когда применяется к значению этого scala.Option. В противном случае возвращает false.

Это эквивалентно:

option match {
 case Some(x) => p(x)
 case None    => false
}

Исходный код@inline

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

Возвращает этот scala.Option, если он не пуст, и применение предиката p к значению этого scala.Option возвращает true. В противном случае вернуть None.

Это эквивалентно:

option match {
 case Some(x) if p(x) => Some(x)
 case _               => None
}

Исходный код@inline

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

Возвращает этот scala.Option, если он не пуст, и применение предиката p к значению этого scala.Option возвращает false. В противном случае вернуть None.

Это эквивалентно:

option match {
 case Some(x) if !p(x) => Some(x)
 case _                => None
}

Исходный код@inline

final def flatMap[B](f: A => Option[B]): Option[B]

Возвращает результат применения f к значению этого scala.Option, если этот scala.Option не пуст. Возвращает None если этот scala.Option пуст. Несколько отличается от map в том, что f ожидается, что вернёт scala.Option (который может быть None).

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => None
}

Исходный код

def flatten[B](implicit ev: A <:< Option[B]): Option[B]

Возвращает вложенное значение scala.Option, если оно не пусто. В противном случае возвращает None.

Это эквивалентно:

option match {
 case Some(Some(b)) => Some(b)
 case _             => None
}

Some(Some("something")).flatten

Исходный код@inline

final def fold[B](ifEmpty: => B)(f: A => B): B

Возвращает результат применения f к значению этого scala.Option, если scala.Option не пуст. В противном случае вычисляет выражение ifEmpty.

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => ifEmpty
}

Это также эквивалентно:

option map f getOrElse ifEmpty

Исходный код@inline

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

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

Это эквивалентно:

option match {
 case Some(x) => p(x)
 case None    => true
}

Исходный код@inline

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

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

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => ()
}

Исходный код@inline

final def getOrElse[B >: A](default: => B): B

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

Это эквивалентно:

option match {
 case Some(x) => x
 case None    => default
}

Исходный код

final def isDefined: Boolean

Возвращает true, если параметр является экземпляром scala.Some, в противном случае — false.

Это эквивалентно:

option match {
 case Some(_) => true
 case None    => false
}

Исходный код

final def isEmpty: Boolean

Возвращает true, если параметр None, в противном случае — false.

Это эквивалентно:

option match {
 case Some(_) => false
 case None    => true
}

Исходный код

def iterableFactory: IterableFactory[Iterable]

Исходный код

def iterator: Iterator[A]

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

Исходный код

final override def knownSize: Int

Исходный код

def lazyZip[B](that: Iterable[B]): LazyZip2[A, B, Iterable[A]]

Аналогично 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)

Исходный код@inline

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

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

Это эквивалентно:

option match {
 case Some(x) => Some(f(x))
 case None    => None
}

Исходный код

final def nonEmpty: Boolean

Возвращает false, если параметр None, в противном случае — true.

Это эквивалентно:

option match {
 case Some(_) => true
 case None    => false
}

Исходный код@inline

final def orElse[B >: A](alternative: => Option[B]): Option[B]

Возвращает этот scala.Option, если он не пустой, в противном случае возвращает результат вычисления alternative.

Это эквивалентно:

option match {
 case Some(x) => Some(x)
 case None    => alternative
}

Исходный код@inline

final def orNull[A1 >: A](implicit ev: Null <:< A1): A1

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

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

Это эквивалентно:

option match {
 case Some(x) => x
 case None    => null
}

val initialText: Option[String] = getInitialText
val textField = new JComponent(initialText.orNull,20)

Исходный код@inline

final def toLeft[X](right: => X): Either[A, X]

Возвращает scala.util.Right, содержащий заданный аргумент right , если параметр пустой, или scala.util.Left, содержащий значение этого scala.Option, если этот scala.Option не пустой.

Это эквивалентно:

option match {
 case Some(x) => Left(x)
 case None    => Right(right)
}

Исходный код

def toList: List[A]

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

Это эквивалентно:

option match {
 case Some(x) => List(x)
 case None    => Nil
}

Source@inline

final def toRight[X](left: => X): Either[X, A]

Возвращает scala.util.Left, содержащий переданный аргумент left, если этот scala.Option пустой, или scala.util.Right, содержащий значение этого scala.Option, если он непустой.

Это эквивалентно:

option match {
 case Some(x) => Right(x)
 case None    => Left(left)
}

Source

final def unzip[A1, A2](implicit asPair: A <:< (A1, A2)): (Option[A1], Option[A2])

Преобразует Option пары в Option первого элемента и Option второго элемента.

Это эквивалентно:

option match {
  case Some((x, y)) => (Some(x), Some(y))
  case _            => (None,    None)
}

Source

final def unzip3[A1, A2, A3](implicit asTriple: A <:< (A1, A2, A3)): (Option[A1], Option[A2], Option[A3])

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

Это эквивалентно:

option match {
  case Some((x, y, z)) => (Some(x), Some(y), Some(z))
  case _               => (None,    None,    None)
}

Source@inline

final def withFilter(p: A => Boolean): WithFilter

Необходим для предотвращения неявного преобразования scala.Option в scala.collection.Iterable в for выражениях.

Source

final def zip[A1 >: A, B](that: Option[B]): Option[(A1, B)]

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

Это эквивалентно:

(option1, option2) match {
  case (Some(x), Some(y)) => Some((x, y))
  case _                  => None
}

// Returns Some(("foo", "bar")) because both options are nonempty.
Some("foo") zip Some("bar")
// Returns None because `that` option is empty.
Some("foo") zip None
// Returns None because `this` option is empty.
None zip Some("bar")

Наследованные методы

Source@inline

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

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

Source@inline

final def addString(b: StringBuilder): 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

Source@inline

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

Добавляет все элементы этой коллекции в 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

Source

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

Добавляет все элементы этой коллекции в 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)

Source

def canEqual(that: Any): Boolean

Метод, который следует вызывать из каждого хорошо спроектированного метода equals, который может быть переопределён в подклассе. См. Programming in Scala, Глава 28 для обсуждения и проектирования.

Source

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

Source

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

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

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

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

Источник

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

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

Источник

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

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

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

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

Источник@deprecatedOverriding("Это всегда должно перенаправлять вызов на 3-аргументную версию этого метода", since = "2.13.4")

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

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

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

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

Источник@deprecatedOverriding("Это всегда должно перенаправлять вызов на 3-аргументную версию этого метода", since = "2.13.4")

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

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

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

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

Источник

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

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

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

Источник

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

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

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

Источник

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

Источник

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

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

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

Source

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

Source

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

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

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

Source

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

Source

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

Source

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

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

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

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

Source

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

Source

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

Source

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

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

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

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

Source

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

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

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

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

Source

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

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

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

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

Source

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

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

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

Source

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

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

Источник

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

Источник

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

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

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

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

Источник

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

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

Источник

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[Iterable[A]]

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

Источник

def head: A

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

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

Источник

def headOption: Option[A]

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

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

Источник

def init: Iterable[A]

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

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

Источник

def inits: Iterator[Iterable[A]]

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

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

Источник

def isEmpty: Boolean

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

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

Источник

def iterator: Iterator[A]

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

Источник

def knownSize: Int

Исходный код

def last: A

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

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

Исходный код

def lastOption: Option[A]

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

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

Исходный код

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

Исходный код

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

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

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

Исходный код

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

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

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

Исходный код

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

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

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

Источник

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

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

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

Источник

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

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

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

Источник

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

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

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

Источник

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

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

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

Source

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

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

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

Source@inline

final def mkString: String

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

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

Source@inline

final def mkString(sep: String): String

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

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

Source

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

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

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

Source

protected def newSpecificBuilder: Builder[A, Iterable[A]]

Source@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

def nonEmpty: Boolean

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

Source

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

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

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

Source

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))

Source

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

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

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

Source

def productArity: Int

Размер этого произведения.

Source

def productElement(n: Int): Any

n-ый элемент этого произведения, нумерация с 0. Другими словами, для произведения A(x1, ..., xk), возвращает x(n+1), где 0 <= n < k.

Исходный код

def productElementName(n: Int): String

Имя n-го элемента этого произведения, нумерация с 0. В стандартной реализации — пустая строка.

Исходный код

def productElementNames: Iterator[String]

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

Исходный код

def productIterator: Iterator[Any]

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

Исходный код

def productPrefix: String

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

Исходный код

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

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

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

Исходный код

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

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

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

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

Источник

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

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

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

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

Источник

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

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

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

Источник

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

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

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

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

Источник

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

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

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

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

Источник

protected def reversed: Iterable[A]

Источник

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

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

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

Источник

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

Источник

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

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

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

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

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

Пример:

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

Источник

def size: Int

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

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

Источник

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

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

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

Источник

def sizeCompare(otherSize: Int): Int

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

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

Источник@inline

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): Iterable[A]

Источник

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

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

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

Источник

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

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

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

Источник

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

Источник

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. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Steppers могут преобразовываться только в последовательные потоки.

Источник

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. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Steppers могут преобразовываться только в последовательные потоки.

Источник

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

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

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

Источник

def tail: Iterable[A]

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

Источник

def tails: Iterator[Iterable[A]]

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

Источник

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

Источник

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

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

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

Источник

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

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

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

Источник

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

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

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

Источник

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

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

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

Источник@inline

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

Источник

def toIndexedSeq: IndexedSeq[A]

Источник

def toList: List[A]

Источник

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

Источник

def toSeq: Seq[A]

Источник

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

Источник

def toVector: Vector[A]

Источник

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

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

Источник

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))

Источник

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))

Источник

def view: View[A]

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

Исходный код

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

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

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

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

Исходный код

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

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

Исходный код

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

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

Исходный код

def zipWithIndex: Iterable[(A, Int)]