Spec-Zone.ru › Scala 2.13 Library

Трейт scala.collection.immutable.Set

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

трейт Set[A] extends Iterable[A] with collection.Set[A] with SetOps[A, Set, Set[A]] with IterableFactoryDefaults[A, Set]

Базовый трейт для неизменяемых коллекций множеств

Source
Set.scala
Линейные супертипы
SetOps[A, Set, Set[A]], collection.Set[A], Equals, collection.SetOps[A, [_]Set[_], Set[A]], (A) => Boolean, Iterable[A], collection.Iterable[A], IterableFactoryDefaults[A, [x]Set[x]], IterableOps[A, [_]Set[_], Set[A]], IterableOnceOps[A, [_]Set[_], Set[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
Множество значений, Абстрактное множество, Множество битов, Множество хэшей, Множество списков, Узел, Неизменяемое множество ключей, Множество 1, Множество 2, Множество 3, Множество 4, Неизменяемое отсортированное множество ключей, Отсортированное множество, Множество деревьев, Множество битов 1, Множество битов 2, Множество битов N

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

abstract def contains(elem: A): Boolean

Definition Classes
SetOps

abstract def excl(elem: A): Set[A]

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

elem

элемент, который нужно удалить

returns

новый набор, содержащий все элементы этого набора, но не содержащий elem.

Definition Classes
SetOps

abstract def incl(elem: A): Set[A]

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

elem

элемент, который нужно добавить

returns

новый набор, содержащий все элементы этого набора и также содержащий elem.

Definition Classes
SetOps

abstract def iterator: Iterator[A]

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

Definition Classes
IterableOnce

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

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

final def &(that: collection.Set[A]): Set[A]

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

Definition Classes
SetOps
Annotations
@inline()

final def &~(that: collection.Set[A]): Set[A]

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

Definition Classes
SetOps
Annotations
@inline()

final def +(elem: A): Set[A]

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

Definition Classes
SetOps → SetOps

final def ++(that: IterableOnce[A]): Set[A]

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

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

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

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

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

final def -(elem: A): Set[A]

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

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

final def --(that: IterableOnce[A]): Set[A]

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

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

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

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

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def addString(b: mutable.StringBuilder): mutable.StringBuilder

Добавляет все элементы этого набора в строковый буфер. Записываемый текст состоит из строковых представлений (с учётом метода toString) всех элементов этого набора без разделителя.

Пример:

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

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

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

Пример:

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

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

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

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

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps

def andThen[A](g: (Boolean) => A): (A) => A

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

A

тип результата функции g

g

функция R => A

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

final def apply(elem: A): Boolean

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

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

elem

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

returns

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

Definition Classes
SetOps → Function1
Annotations
@inline()

final def asInstanceOf[T0]: T0

Приводит объект-получатель к типу T0.

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

returns

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

Definition Classes
Any
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

значение, проверяемое на возможное равенство

returns

true, если этот экземпляр может быть равен that, иначе false

Definition Classes
Set → Equals

def className: String

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

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

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

returns

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

Attributes
protected[this]
Definition Classes
Iterable

def clone(): AnyRef

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

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

returns

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

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

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

final def coll: Set.this.type

returns

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

Attributes
protected
Definition Classes
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

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

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

A

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

g

функция A => T1

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

def concat(that: IterableOnce[A]): Set[A]

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

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

Пример:

scala> val a = Set(1, 2) concat Set(2, 3)
a: scala.collection.immutable.Set[Int] = Set(1, 2, 3)
that

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

returns

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

Definition Classes
SetOps

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

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

B

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

suffix

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

Definition Classes
IterableOnceOps
Note

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

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

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

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

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

B

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

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

xs

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

that

другой набор

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

def diff(that: collection.Set[A]): Set[A]

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

that

множество элементов, которые нужно исключить.

returns

множество, содержащее те элементы этого множества, которые также не содержатся в заданном множестве that.

Definition Classes
SetOps → SetOps

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

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def empty: Set[A]

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

returns

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

Definition Classes
IterableFactoryDefaults → IterableOps

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

def equals(that: Any): Boolean

Метод универсального сравнения равенства, определённый в AnyRef.

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

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

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

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

p

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

возвращает

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

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

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

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

возвращает

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

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

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

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

pred

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

возвращает

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

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

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

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

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

asIterable

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

def formatted(fmtstr: String): String

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

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

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

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

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

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

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

,

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

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

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

returns

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

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

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

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

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

K

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

f

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

возвращает

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

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

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

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

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

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

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

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

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

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

K

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

B

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

key

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

f

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

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

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

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

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

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

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

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Set → AnyRef → Any

def head: A

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

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

returns

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

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

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

def init: Set[A]

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

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

Definition Classes
IterableOps

def inits: Iterator[Set[A]]

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

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

returns

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

Definition Classes
IterableOps
Пример:

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

def intersect(that: collection.Set[A]): Set[A]

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

that

набор для пересечения.

returns

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

Definition Classes
SetOps

def isEmpty: Boolean

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

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

returns

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

Definition Classes
IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Set]

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

Definition Classes
Set → Set → Iterable → Iterable → IterableOps
Note

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

def knownSize: Int

returns

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

Definition Classes
IterableOnce

def last: A

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

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

def lastOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

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

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

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

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

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

that

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

returns

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

Definition Classes
Iterable

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

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

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

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

sep

разделитель.

returns

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

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

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

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

returns

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

def nonEmpty: Boolean

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

returns

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

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

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

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

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

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

Definition Classes
IterableOps

def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (Set[A1], Set[A2])

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

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

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

A2

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

f

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

returns

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

Definition Classes
IterableOps

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

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

B

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

num

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

возвращает

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

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

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

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

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

B

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

op

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

возвращает

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

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

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

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

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

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

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

B

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

op

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

возвращает

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

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

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

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

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

B

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

op

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

returns

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def removedAll(that: IterableOnce[A]): Set[A]

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

that

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

returns

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

Definition Classes
SetOps

def reversed: collection.Iterable[A]

Attributes
protected
Definition Classes
IterableOnceOps

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

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

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

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

def size: Int

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

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

returns

количество элементов в этой коллекции.

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

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

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

that

Iterable, размер которой сравнивается с размером этой итерируемой коллекции.

returns

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

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

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

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

def sizeCompare(otherSize: Int): Int

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

otherSize

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

returns

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

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

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

Definition Classes
IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

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

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

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

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

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

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

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

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

def stringPrefix: String

Атрибуты
protected[this]
Классы определений
Set → Iterable
Аннотации
@deprecatedOverriding("Compatibility override", "2.13.0")

def subsetOf(that: collection.Set[A]): Boolean

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

that

множество для проверки.

returns

true, если это множество является подмножеством that, т.е. если каждый элемент этого множества также является элементом that.

Definition Classes
SetOps

def subsets(): Iterator[Set[A]]

Итератор по всем подмножествам этого множества.

returns

итератор.

Definition Classes
SetOps

def subsets(len: Int): Iterator[Set[A]]

Итератор по всем подмножествам этого множества заданного размера. Если запрошенный размер невозможен, возвращается пустой итератор.

len

размер подмножеств.

returns

итератор.

Definition Classes
SetOps

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

Вычисляет сумму элементов этого набора.

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
AnyRef

def tail: Set[A]

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

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

def tails: Iterator[Set[A]]

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

returns

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

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

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

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

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

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

n

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

returns

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

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

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

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

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

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

n

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

returns

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

То же логическое множество, что и это

Definition Classes
IterableOps → IterableOnceOps

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

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

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[A]

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

final def toIterable: Set.this.type

возвращает

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

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

def toList: List[A]

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

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

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

def toSeq: Seq[A]

возвращает

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

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

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

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

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

возвращает

строковое представление объекта.

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

def toVector: Vector[A]

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

def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): Set[Set[B]]

Транспонирует это итерируемое множество итерируемых множеств в итерируемое множество итерируемых множеств.

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

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

B

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

asIterable

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

возвращает

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

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

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

final def union(that: collection.Set[A]): Set[A]

Вычисляет объединение множества и другого множества.

that

множество для объединения.

возвращает

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

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

def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (Set[A1], Set[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

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

A2

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

asPair

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

returns

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

Definition Classes
IterableOps

def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (Set[A1], Set[A2], Set[A3])

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

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

тип первого элемента троек

A2

тип второго элемента троек

A3

тип третьего элемента троек

asTriple

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

returns

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

Definition Classes
IterableOps

def view: View[A]

Вид на элементы этой коллекции.

Definition Classes
IterableOps

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

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

Создаёт нестрогий фильтр для этой коллекции.

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

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

p

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

returns

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

Definition Classes
IterableOps

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

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

B

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

that

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

returns

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

Definition Classes
IterableOps

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

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

def zipWithIndex: Set[(A, Int)]

Объединяет эту итерируемую коллекцию с её индексами.

returns

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

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

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

Note

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

final def |(that: collection.Set[A]): Set[A]

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

Definition Classes
SetOps
Annotations
@inline()

Затенённые неявные члены значения

def +(other: String): String

Неявный
Этот член добавлен с помощью неявного преобразования из Set[A] в any2stringadd[Set[A]], выполненного методом any2stringadd в scala.Predef.
Затенение
Этот неявно унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типов:
(set: any2stringadd[Set[A]]).+(other)
Определяющие классы
any2stringadd

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

Spec-Zone.ru

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