Пакет scala.collection.mutable

package mutable

Источник: package.scala
Линейные супертипы: AnyRef, Any

Члены типа

abstract class AbstractBuffer[A] extends AbstractSeq[A] with Buffer[A]

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

Аннотации: @SerialVersionUID()

abstract class AbstractIterable[A] extends collection.AbstractIterable[A] with Iterable[A]

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

Аннотации: @SerialVersionUID()

abstract class AbstractMap[K, V] extends collection.AbstractMap[K, V] with Map[K, V]

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

Аннотации: @SerialVersionUID()

abstract class AbstractSeq[A] extends collection.AbstractSeq[A] with Seq[A]

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

Аннотации: @SerialVersionUID()

abstract class AbstractSet[A] extends collection.AbstractSet[A] with Set[A]

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

Аннотации: @SerialVersionUID()

class AnyRefMap[K <: AnyRef, V] extends AbstractMap[K, V] with MapOps[K, V, Map, AnyRefMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, AnyRefMap[K, V]] with Serializable

Этот класс реализует изменяемые отображения с ключами AnyRef на основе хэш-таблицы с открытой адресацией.

Базовые операции отображения над отдельными записями, включая contains и get, как правило, значительно быстрее с AnyRefMap чем HashMap. Обратите внимание, что числа и символы не обрабатываются специально в AnyRefMap; только простые equals и hashCode используются в сравнениях.

Методы, которые обходят или пересоздают отображение, включая foreach и map, как правило, не быстрее, чем с HashMap. Однако методы foreachKey, foreachValue, mapValuesNow и transformValues быстрее, чем альтернативные способы достижения той же функциональности.

Отображения с открытой адресацией могут стать менее эффективными при поиске после многократного добавления/удаления элементов. Хотя AnyRefMap делает неплохую попытку оставаться эффективным независимо от этого, вызов repack для отображения, в котором больше не будут удаляться элементы, но которое будет интенсивно использоваться, может сэкономить как время, так и место в памяти.

Это отображение не предназначено для хранения более 2²⁹ записей (приблизительно 500 миллионов). Максимальная емкость составляет 2³⁰, но производительность резко ухудшится по мере приближения к 2³⁰.

класс ArrayBuffer[A] extends AbstractBuffer[A] with IndexedBuffer[A] with IndexedSeqOps[A, ArrayBuffer, ArrayBuffer[A]] with StrictOptimizedSeqOps[A, ArrayBuffer, ArrayBuffer[A]] with IterableFactoryDefaults[A, ArrayBuffer] with DefaultSerializable

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

A: тип элементов данного массива.

Since: 1
См. также: Обзор библиотеки коллекций Scala в разделе Array Buffers для получения дополнительной информации.

final класс ArrayBufferView[A] extends AbstractIndexedSeqView[A]

абстрактный запечатанный класс ArrayBuilder[T] extends ReusableBuilder[T, Array[T]] with Serializable

Класс-билдер для массивов.

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

Аннотации: @SerialVersionUID()
Since: 2.8

класс ArrayDeque[A] extends AbstractBuffer[A] with IndexedBuffer[A] with IndexedSeqOps[A, ArrayDeque, ArrayDeque[A]] with StrictOptimizedSeqOps[A, ArrayDeque, ArrayDeque[A]] with IterableFactoryDefaults[A, ArrayDeque] with ArrayDequeOps[A, ArrayDeque, ArrayDeque[A]] with Cloneable[ArrayDeque[A]] with DefaultSerializable

Реализация двусторонней очереди, использующей перестраиваемый кольцевой буфер. Добавление, удаление и доступ по индексу занимают амортизированное постоянное время. В целом, удаление и вставка на i-ом индексе имеет сложность O(min(i, n-i)), поэтому вставка и удаление с начала/конца быстры.

A: тип элементов данного ArrayDeque.

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

Трейт ArrayDequeOps[A, +CC[_], +C <: AnyRef] extends StrictOptimizedSeqOps[A, CC, C]

sealed abstract class ArraySeq[T] extends AbstractSeq[T] with IndexedSeq[T] with IndexedSeqOps[T, ArraySeq, ArraySeq[T]] with StrictOptimizedSeqOps[T, ArraySeq, ArraySeq[T]] with Serializable

Коллекция, представляющая Array[T]. В отличие от ArrayBuffer она всегда использует один и тот же базовый Array, поэтому она не может расти или уменьшаться.

T: тип элементов в этом обернутом массиве.

Annotations: @SerialVersionUID()
Since: 2.8

class BitSet extends AbstractSet[Int] with SortedSet[Int] with SortedSetOps[Int, SortedSet, BitSet] with StrictOptimizedIterableOps[Int, Set, BitSet] with StrictOptimizedSortedSetOps[Int, SortedSet, BitSet] with collection.BitSet with BitSetOps[BitSet] with Serializable

Класс для изменяемых битовых множеств.

Битовые множества — это множества неотрицательных целых чисел, которые представлены массивами переменной длины бит, упакованными в 64-битные слова. Занимаемая память битового множества определяется наибольшим в нем числом.

См. также: "Обзор библиотеки коллекций Scala" раздела о Mutable Bitsets для получения дополнительной информации.

trait Buffer[A] extends Seq[A] with SeqOps[A, Buffer, Buffer[A]] with Growable[A] with Shrinkable[A] with IterableFactoryDefaults[A, Buffer]

trait Builder[-A, +To] extends Growable[A]

Базовое свойство для создателей коллекций.

После вызова result() поведение Builder (который также не является scala.collection.mutable.ReusableBuilder) не определено. Больше методов вызывать нельзя. Для изменяемых коллекций часто используется собственный непереиспользуемый Builder, в этом случае result() просто возвращает this.

См. также: scala.collection.mutable.ReusableBuilder для Builders, которые могут быть повторно использованы после вызова result()

trait Clearable extends AnyRef

trait Cloneable[+C <: AnyRef] extends scala.Cloneable

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

C: Тип коллекции, ковариантный и с типом-границей ссылочного типа.

Since: 2.8

final class CollisionProofHashMap[K, V] extends AbstractMap[K, V] with MapOps[K, V, Map, CollisionProofHashMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, CollisionProofHashMap[K, V]] with StrictOptimizedMapOps[K, V, Map, CollisionProofHashMap[K, V]]

Этот класс реализует изменяемые отображения, используя хеш-таблицу с красно-чёрными деревьями в корзинах для хорошей производительности в худшем случае при столкновениях хешей. Для типа элемента требуется Ordering. Равенство, определяемое Ordering, должно быть согласовано с equals и hashCode. Универсальное равенство числовых типов не поддерживается (аналогично AnyRefMap).

Since: 2.13
See also: "Обзор библиотеки коллекций Scala" раздел по Hash Tables для получения дополнительной информации.

trait Growable[-A] extends Clearable

class GrowableBuilder[Elem, To <: Growable[Elem]] extends Builder[Elem, To]

Канонический билдер для коллекций, которые могут расти, т.е. которые поддерживают эффективный метод += для добавления элемента в коллекцию.

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

Since: 2.8

class HashMap[K, V] extends AbstractMap[K, V] with MapOps[K, V, HashMap, HashMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, HashMap[K, V]] with StrictOptimizedMapOps[K, V, HashMap, HashMap[K, V]] with MapFactoryDefaults[K, V, HashMap, Iterable] with Serializable

Этот класс реализует изменяемые отображения, используя хеш-таблицу.

K: тип ключей, содержащихся в этой хеш-карте.
V: тип значений, присвоенных ключам в этой хеш-карте.

Annotations: @deprecatedInheritance("HashMap wil be made final; use .withDefault for the common use case of computing a default value", "2.13.0")
Since: 1
See also: "Обзор библиотеки коллекций Scala" раздел по Hash Tables для получения дополнительной информации.

final class HashSet[A] extends AbstractSet[A] with SetOps[A, HashSet, HashSet[A]] with StrictOptimizedIterableOps[A, HashSet, HashSet[A]] with IterableFactoryDefaults[A, HashSet] with Serializable

Этот класс реализует изменяемые множества, используя хеш-таблицу.

Since: 1
См. также: "Обзор библиотеки коллекций Scala" раздел по Hash Tables для получения дополнительной информации.

abstract class ImmutableBuilder[-A, C <: IterableOnce[_]] extends ReusableBuilder[A, C]

trait IndexedBuffer[A] extends IndexedSeq[A] with IndexedSeqOps[A, IndexedBuffer, IndexedBuffer[A]] with Buffer[A] with IterableFactoryDefaults[A, IndexedBuffer]

trait IndexedSeq[T] extends Seq[T] with collection.IndexedSeq[T] with IndexedSeqOps[T, IndexedSeq, IndexedSeq[T]] with IterableFactoryDefaults[T, IndexedSeq]

trait IndexedSeqOps[A, +CC[_], +C <: AnyRef] extends collection.IndexedSeqOps[A, CC, C] with SeqOps[A, CC, C]

trait Iterable[A] extends collection.Iterable[A] with IterableOps[A, Iterable, Iterable[A]] with IterableFactoryDefaults[A, Iterable]

класс LinkedHashMap[K, V] extends AbstractMap[K, V] with SeqMap[K, V] with MapOps[K, V, LinkedHashMap, LinkedHashMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, LinkedHashMap[K, V]] with StrictOptimizedMapOps[K, V, LinkedHashMap, LinkedHashMap[K, V]] with MapFactoryDefaults[K, V, LinkedHashMap, Iterable] with DefaultSerializable

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

K: тип ключей, содержащихся в этой хеш-карте.
V: тип значений, назначенных ключам в этой хеш-карте.

класс LinkedHashSet[A] extends AbstractSet[A] with SetOps[A, LinkedHashSet, LinkedHashSet[A]] with StrictOptimizedIterableOps[A, LinkedHashSet, LinkedHashSet[A]] with IterableFactoryDefaults[A, LinkedHashSet] with DefaultSerializable

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

A: тип элементов, содержащихся в этом множестве.

Since: 1

класс ListBuffer[A] extends AbstractBuffer[A] with SeqOps[A, ListBuffer, ListBuffer[A]] with StrictOptimizedSeqOps[A, ListBuffer, ListBuffer[A]] with ReusableBuilder[A, immutable.List[A]] with IterableFactoryDefaults[A, ListBuffer] with DefaultSerializable

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

A: тип элементов этого буфера.

Since: 1
См. также: Раздел "Обзор библиотеки коллекций Scala" по буферам списка для получения дополнительной информации.

final class LongMap[V] extends AbstractMap[Long, V] with MapOps[Long, V, Map, LongMap[V]] with StrictOptimizedIterableOps[(Long, V), Iterable, LongMap[V]] with Serializable

Этот класс реализует изменяемые отображения с ключами типа Long, основанные на хеш-таблице с открытым адресацией.

Базовые операции над отдельными записями, включая contains и get, обычно значительно быстрее с LongMap по сравнению с HashMap. Методы, действующие над всем отображением, включая foreach и map обычно не ожидаются быть быстрее, чем с обычным отображением, за исключением случаев, когда они используют особенности внутренней структуры отображения: foreachKey, foreachValue, mapValuesNow, и transformValues.

Отображения с открытой адресацией могут стать менее эффективными при поиске после многократного добавления/удаления элементов. Хотя LongMap делает все возможное, чтобы оставаться эффективным, независимо от этого, вызов repack для отображения, элементы которого больше не будут удаляться, но будут часто использоваться, может сэкономить как время, так и занимаемую память.

Это отображение не предназначено для хранения более чем 2²⁹ элементов (приблизительно 500 миллионов). Максимальная емкость составляет 2³⁰, но производительность быстро ухудшается, по мере приближения к 2³⁰.

trait Map[K, V] extends Iterable[(K, V)] with collection.Map[K, V] with MapOps[K, V, Map, Map[K, V]] with Growable[(K, V)] with Shrinkable[K] with MapFactoryDefaults[K, V, Map, Iterable]

trait MapOps[K, V, +CC[X, Y] <: MapOps[X, Y, CC, _], +C <: MapOps[K, V, CC, C]] extends IterableOps[(K, V), Iterable, C] with collection.MapOps[K, V, CC, C] with Cloneable[C] with Builder[(K, V), C] with Growable[(K, V)] with Shrinkable[K]

trait MultiMap[K, V] extends Map[K, Set[V]]

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

Этот класс обычно используется как миксин. Он преобразует отображения, сопоставляющие K с объектами Set[V], в многоотображения, которые сопоставляют K с объектами V.

Пример:

// first import all necessary types from package `collection.mutable`
import collection.mutable.{ HashMap, MultiMap, Set }

// to create a `MultiMap` the easiest way is to mixin it into a normal
// `Map` instance
val mm = new HashMap[Int, Set[String]] with MultiMap[Int, String]

// to add key-value pairs to a multimap it is important to use
// the method `addBinding` because standard methods like `+` will
// overwrite the complete key-value pair instead of adding the
// value to the existing key
mm.addBinding(1, "a")
mm.addBinding(2, "b")
mm.addBinding(1, "c")

// mm now contains `Map(2 -> Set(b), 1 -> Set(c, a))`

// to check if the multimap contains a value there is method
// `entryExists`, which allows to traverse the including set
mm.entryExists(1, _ == "a") == true
mm.entryExists(1, _ == "b") == false
mm.entryExists(2, _ == "b") == true

// to remove a previous added value there is the method `removeBinding`
mm.removeBinding(1, "a")
mm.entryExists(1, _ == "a") == false

sealed class PriorityQueue[A] extends AbstractIterable[A] with Iterable[A] with IterableOps[A, Iterable, PriorityQueue[A]] with StrictOptimizedIterableOps[A, Iterable, PriorityQueue[A]] with Builder[A, PriorityQueue[A]] with Cloneable[PriorityQueue[A]] with Growable[A] with Serializable

Этот класс реализует очереди с приоритетом, используя кучу. Для определения приоритета элементов типа A должна быть доступна неявная Ordering[A] при создании.

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

Только методы dequeue и dequeueAll будут возвращать элементы в порядке приоритета (при удалении элементов из кучи). Стандартные методы коллекции, включая drop, iterator и toString, удаляют или обходят кучу в порядке, который кажется наиболее удобным.

Следовательно, вывод PriorityQueue не покажет порядок приоритетов элементов, хотя элемент с наивысшим приоритетом будет выведен первым. Для вывода элементов в порядке необходимо дублировать PriorityQueue (например, с использованием clone) и затем декьюить их:

A: тип элементов в этой очереди с приоритетом.

Since: 1

class Queue[A] extends ArrayDeque[A] with IndexedSeqOps[A, Queue, Queue[A]] with StrictOptimizedSeqOps[A, Queue, Queue[A]] with IterableFactoryDefaults[A, Queue] with ArrayDequeOps[A, Queue, Queue[A]] with Cloneable[Queue[A]] with DefaultSerializable

Объекты Queue реализуют структуры данных, которые позволяют вставлять и извлекать элементы в порядке «первым вошел — первым вышел» (FIFO).

Since: 2.13

trait ReusableBuilder[-Elem, +To] extends Builder[Elem, To]

ReusableBuilder — это маркерный интерфейс, указывающий, что Builder может быть повторно использован для создания более чем одного экземпляра коллекции. В частности, вызов result() за которым следует clear() создаст коллекцию и сбросит билдер, чтобы начать создание новой коллекции того же типа.

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

Elem: тип элементов, которые добавляются в билдер.
To: тип коллекции, которая была создана.

Since: 2.12

trait Seq[A] extends Iterable[A] with collection.Seq[A] with SeqOps[A, Seq, Seq[A]] with IterableFactoryDefaults[A, Seq]

интерфейс SeqMap[K, V] extends Map[K, V] with collection.SeqMap[K, V] with MapOps[K, V, SeqMap, SeqMap[K, V]] with MapFactoryDefaults[K, V, SeqMap, Iterable]

Обобщённый интерфейс для упорядоченных изменяемых карт. Конкретные классы должны предоставлять функциональность для абстрактных методов в SeqMap.

Обратите внимание, что при проверке на равенство SeqMap не учитывает порядок.

K: тип ключей, содержащихся в этой связанной карте.
V: тип значений, связанных с ключами в этой связанной карте.

Версия: 2.13
С тех пор: 2.13

интерфейс SeqOps[A, +CC[_], +C <: AnyRef] extends collection.SeqOps[A, CC, C] with Cloneable[C]

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

интерфейс SetOps[A, +CC[X], +C <: SetOps[A, CC, C]] extends collection.SetOps[A, CC, C] with IterableOps[A, CC, C] with Cloneable[C] with Builder[A, C] with Growable[A] with Shrinkable[A]

интерфейс Shrinkable[-A] extends AnyRef

Этот интерфейс является частью коллекций, которые могут быть уменьшены с помощью оператора -=.

С тех пор: 2.8

интерфейс SortedMap[K, V] extends collection.SortedMap[K, V] with Map[K, V] with SortedMapOps[K, V, SortedMap, SortedMap[K, V]] with SortedMapFactoryDefaults[K, V, SortedMap, Iterable, Map]

trait SortedMapOps[K, V, +CC[X, Y] <: Map[X, Y] with SortedMapOps[X, Y, CC, _], +C <: SortedMapOps[K, V, CC, C]] extends collection.SortedMapOps[K, V, CC, C] with MapOps[K, V, Map, C]

trait SortedSet[A] extends Set[A] with collection.SortedSet[A] with SortedSetOps[A, SortedSet, SortedSet[A]] with SortedSetFactoryDefaults[A, SortedSet, Set]

trait SortedSetOps[A, +CC[X] <: SortedSet[X], +C <: SortedSetOps[A, CC, C]] extends SetOps[A, Set, C] with collection.SortedSetOps[A, CC, C]

class Stack[A] extends ArrayDeque[A] with IndexedSeqOps[A, Stack, Stack[A]] with StrictOptimizedSeqOps[A, Stack, Stack[A]] with IterableFactoryDefaults[A, Stack] with ArrayDequeOps[A, Stack, Stack[A]] with Cloneable[Stack[A]] with DefaultSerializable

Стек реализует структуру данных, которая позволяет хранить и извлекать объекты в порядке LIFO (последним вошел — первым вышел).

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

Annotations: @migration
Migration: (Изменено в версии 2.13.0) Стек теперь основан на ArrayDeque вместо связанного списка
Since: 2.13

final class StringBuilder extends AbstractSeq[Char] with ReusableBuilder[Char, String] with IndexedSeq[Char] with IndexedSeqOps[Char, IndexedSeq, StringBuilder] with IterableFactoryDefaults[Char, IndexedSeq] with CharSequence with Serializable

Строитель для изменяемой последовательности символов. Этот класс предоставляет API, в основном совместимый с java.lang.StringBuilder, за исключением случаев конфликтов с API коллекций Scala (например, метод reverse).

Этот строитель может быть повторно использован после вызова result() без промежуточного вызова clear(), чтобы создать несколько связанных результатов.

Аннотации: @SerialVersionUID()
С тех пор: 2.7

sealed class TreeMap[K, V] extends AbstractMap[K, V] with SortedMap[K, V] with SortedMapOps[K, V, TreeMap, TreeMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, TreeMap[K, V]] with StrictOptimizedMapOps[K, V, Map, TreeMap[K, V]] with StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]] with SortedMapFactoryDefaults[K, V, TreeMap, Iterable, Map] with DefaultSerializable

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

K: тип ключей, содержащихся в этом словаре.
V: тип значений, связанных с ключами.

С тех пор: 2.12

sealed class TreeSet[A] extends AbstractSet[A] with SortedSet[A] with SortedSetOps[A, TreeSet, TreeSet[A]] with StrictOptimizedIterableOps[A, Set, TreeSet[A]] with StrictOptimizedSortedSetOps[A, TreeSet, TreeSet[A]] with SortedSetFactoryDefaults[A, TreeSet, Set] with DefaultSerializable

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

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

С тех пор: 2.10

sealed класс UnrolledBuffer[T] extends AbstractBuffer[T] with Buffer[T] with Seq[T] with SeqOps[T, UnrolledBuffer, UnrolledBuffer[T]] with StrictOptimizedSeqOps[T, UnrolledBuffer, UnrolledBuffer[T]] with EvidenceIterableFactoryDefaults[T, UnrolledBuffer, ClassTag] with Builder[T, UnrolledBuffer[T]] with DefaultSerializable

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

Неразвёрнутые связанные списки хранят элементы в связанных массивах фиксированного размера.

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

Однако они обеспечивают O(n/m) сложность случайного доступа, где n — число элементов, а m — размер блоков внутреннего массива.

Идеально использовать, когда:

concat

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

Аннотации: @SerialVersionUID()

класс WeakHashMap[K, V] extends JMapWrapper[K, V] with JMapWrapperLike[K, V, WeakHashMap, WeakHashMap[K, V]] with MapFactoryDefaults[K, V, WeakHashMap, Iterable]

Хэш-таблица с ссылками на записи, которые слабо достижимы. Записи удаляются из этой таблицы, когда на ключ больше нет (сильной) ссылки. Этот класс оборачивает java.util.WeakHashMap.

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

Аннотации: @SerialVersionUID()
Since: 2.8
См. также: Раздел "Обзор библиотеки коллекций Scala" по Weak Hash Maps для получения дополнительной информации.