Spec-Zone.ru › Scala 2.13 Library

Трейт scala.collection.mutable.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]], Shrinkable[A], Builder[A, Set[A]], Growable[A], Clearable, Cloneable[Set[A]], java.lang.Cloneable, 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
Известные подклассы
AbstractSet, BitSet, HashSet, LinkedHashSet, SortedSet, TreeSet

Члены-значения (Abstract)

abstract def addOne(elem: A): Set.this.type

Добавляет один элемент в это изменяемое множество.

elem

элемент для добавления.

returns

само изменяемое множество

Definition Classes
Growable

abstract def clear(): Unit

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

Definition Classes
Builder → Clearable

abstract def contains(elem: A): Boolean

Definition Classes
SetOps

abstract def iterator: Iterator[A]

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

Definition Classes
IterableOnce

abstract def subtractOne(elem: A): Set.this.type

Удаляет один элемент из этого изменяемого множества.

elem

элемент для удаления.

returns

само изменяемое множество

Definition Classes
Shrinkable

Конкретные члены значения

final def !=(arg0: Any): Boolean

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

returns

true if !(this == that), false otherwise.

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

final def ##(): Int

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

returns

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

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

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

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

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

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

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

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

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

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

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

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

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

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

final def ++=(xs: IterableOnce[A]): Set.this.type

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

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

final def +=(elem: A): Set.this.type

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

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

final def --=(xs: IterableOnce[A]): Set.this.type

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

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

def -=(elem1: A, elem2: A, elems: A*): Set.this.type

Удаляет два или более элементов из этой изменяемой коллекции.

elem1

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

elem2

второй элемент для удаления.

elems

остальные элементы для удаления.

returns

сама изменяемая коллекция

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

final def -=(elem: A): Set.this.type

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

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

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

возвращает

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

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

def add(elem: A): Boolean

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

def addAll(xs: IterableOnce[A]): Set.this.type

Добавляет все элементы, полученные от IterableOnce, в это изменяемое множество.

xs

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

возвращает

само изменяемое множество.

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

final def addString(b: StringBuilder): StringBuilder

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

Пример:

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

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

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

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

возвращает

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

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

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

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

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

возвращает

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

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

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Set → Equals

def className: String

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

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

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

returns

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

Атрибуты
protected[this]
Definition Classes
Iterable

def clone(): Set[A]

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

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

returns

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

Definition Classes
SetOps → Cloneable → AnyRef
Примечание

не специфицировано SLS как член AnyRef

final def coll: Set.this.type

returns

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

Атрибуты
protected
Definition Classes
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

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

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

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

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

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

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

pf

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

def 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
Примечание

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

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]

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

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

Неявное
Этот член добавлен неявным преобразованием из Set[A] в Ensuring[Set[A]], выполненное методом Ensuring в scala.Predef.
Определяющие классы
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 реализует отношение эквивалентности на не-нулевых экземплярах AnyRef, и обладает тремя дополнительными свойствами:

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

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

returns

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

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

def equals(that: Any): Boolean

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

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

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

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

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

p

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

returns

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

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

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

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

returns

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

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

def filterInPlace(p: (A) => Boolean): Set.this.type

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

p

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

Definition Classes
SetOps

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

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

pred

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

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

Implicit
Этот член добавлен неявным преобразованием из Set[A] в StringFormat[Set[A]], выполненное методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

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

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

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

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

K

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

f

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

returns

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

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

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

Definition Classes
IterableOps

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

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

Definition Classes
IterableOps

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

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

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

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

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

Definition Classes
IterableOps

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Set → AnyRef → Any

def head: A

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

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

def init: Set[A]

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

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

Definition Classes
IterableOps

def inits: Iterator[Set[A]]

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

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

returns

итератор, перебирающий все начальные фрагменты (inits) этого итерируемого набора

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 для Iterable и 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 в противном случае. По умолчанию возвращает -1.

Definition Classes
SetOps → Growable → 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 mapResult[NewTo](f: (Set[A]) => NewTo): Builder[A, NewTo]

Билд, полученный из этого билдера путём отображения результата с помощью f.

Definition Classes
Builder

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

значений, содержащее наименьший элемент этого набора относительно порядка 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()
Note

не определён 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

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

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

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

B

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

op

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

returns

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

Определяющие классы
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 — элементы этой коллекции.

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

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

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

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

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

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

B

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

op

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

returns

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

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

def remove(elem: A): Boolean

Удаляет элемент из этого множества.

elem

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

returns

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

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

def result(): Set[A]

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

Определяющие классы
SetOps → Builder

def reversed: collection.Iterable[A]

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

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

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

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

B

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

z

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

op

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

returns

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

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

sizeIs

final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit

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

coll

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

delta

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

Definition Classes
Builder

def sizeHint(size: Int): Unit

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

size

подсказка о количестве добавляемых элементов.

Definition Classes
Builder

final def sizeHintBounded(size: Int, boundingColl: collection.Iterable[_]): Unit

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

size

подсказка о количестве добавляемых элементов.

boundingColl

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

Definition Classes
Builder

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
Аннотации
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

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

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
См. также

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
Примечание

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

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

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

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

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

n

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

returns

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

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

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

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

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

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

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

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

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

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
Set → Iterable
Annotations
@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 subtractAll(xs: IterableOnce[A]): Set.this.type

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

xs

итератор, генерирующий элементы для удаления.

returns

сам сжимаемый набор.

Definition Classes
Shrinkable

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]

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

Definition Classes
IterableOps

def tails: Iterator[Set[A]]

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

returns

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

Definition Classes
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 отрицательно, возвращается пустая коллекция итерируемых элементов.

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

возвращает

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

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

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

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

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

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

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

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

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

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

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

def toIndexedSeq: immutable.IndexedSeq[A]

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

final def toIterable: Set.this.type

возвращает

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

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

def toList: immutable.List[A]

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

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

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

def toSeq: immutable.Seq[A]

возвращает

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

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

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

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

def toString(): String

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

возвращает

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

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

def toVector: immutable.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.

returns

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

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

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

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

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

that

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

returns

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

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

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

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

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

def update(elem: A, included: Boolean): Unit

Обновляет наличие одного элемента в этом множестве.

Этот метод позволяет добавлять или удалять элемент elem из этого множества в зависимости от значения параметра included. Обычно используется следующий синтаксис:

set(elem) = true  // adds element
set(elem) = false // removes element
elem

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

included

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

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

def view: View[A]

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

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

final def wait(): Unit

Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

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

Определяющие классы
AnyRef
Аннотации
@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
Example:

    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/mutable/Set.html

Spec-Zone.ru

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