MutableIntSet

Artifact: androidx.collection:collection

Added in 1.4.0

Kotlin |Java

Cmn
```
class MutableIntSet : IntSet
```

kotlin.Any
↳	androidx.collection.IntSet
	↳	androidx.collection.MutableIntSet

MutableIntSet is a container with a MutableSet-like interface based on a flat hash table implementation. The underlying implementation is designed to avoid all allocations on insertion, removal, retrieval, and iteration. Allocations may still happen on insertion when the underlying storage needs to grow to accommodate newly added elements to the set.

This implementation makes no guarantee as to the order of the elements stored, nor does it make guarantees that the order remains constant over time.

This implementation is not thread-safe: if multiple threads access this container concurrently, and one or more threads modify the structure of the set (insertion or removal for instance), the calling code must provide the appropriate synchronization. Concurrent reads are however safe.

Summary

Public constructors
`MutableIntSet(initialCapacity: Int)` Creates a new `MutableIntSet`	Cmn

Public functions
`Boolean`	`add(element: Int)` Adds the specified element to the set.	Cmn
`Boolean`	`addAll(elements: IntArray)` Adds all the `elements` into this set.	Cmn
`Boolean`	`addAll(elements: IntSet)` Adds all the elements in the `elements` set into this set.	Cmn
`Unit`	`clear()` Removes all elements from this set.	Cmn
`operator Unit`	`minusAssign(element: Int)` Removes the specified `element` from the set if it is present.	Cmn
`operator Unit`	`minusAssign(elements: IntArray)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`minusAssign(elements: IntSet)` Removes the specified `elements` from the set, if present.	Cmn
`operator Unit`	`plusAssign(element: Int)` Adds the specified element to the set.	Cmn
`operator Unit`	`plusAssign(elements: IntArray)` Adds all the `elements` into this set.	Cmn
`operator Unit`	`plusAssign(elements: IntSet)` Adds all the elements in the `elements` set into this set.	Cmn
`Boolean`	`remove(element: Int)` Removes the specified `element` from the set.	Cmn
`Boolean`	`removeAll(elements: IntArray)` Removes the specified `elements` from the set, if present.	Cmn
`Boolean`	`removeAll(elements: IntSet)` Removes the specified `elements` from the set, if present.	Cmn
`@IntRange(from = 0) Int`	`trim()` Trims this `MutableIntSet`'s storage so it is sized appropriately to hold the current elements.	Cmn

Inherited functions

From androidx.collection.IntSet

`inline Boolean`	`all(predicate: (element: Int) -> Boolean)` Returns true if all elements match the given `predicate`.	Cmn
`Boolean`	`any()` Returns `true` if this set has at least one element.	Cmn
`inline Boolean`	`any(predicate: (element: Int) -> Boolean)` Returns true if at least one element matches the given `predicate`.	Cmn
`operator Boolean`	`contains(element: Int)` Returns `true` if the specified `element` is present in this set, `false` otherwise.	Cmn
`@IntRange(from = 0) Int`	`count()` Returns the number of elements in this set.	Cmn
`inline @IntRange(from = 0) Int`	`count(predicate: (element: Int) -> Boolean)` Returns the number of elements matching the given `predicate`.	Cmn
`open operator Boolean`	`equals(other: Any?)` Compares the specified object `other` with this set for equality.	Cmn
`inline Int`	`first()` Returns the first element in the collection.	Cmn
`inline Int`	`first(predicate: (element: Int) -> Boolean)` Returns the first element in the collection for which `predicate` returns `true`.	Cmn
`inline Unit`	`forEach(block: (element: Int) -> Unit)` Iterates over every element stored in this set by invoking the specified `block` lambda.	Cmn
`open Int`	`hashCode()` Returns the hash code value for this set.	Cmn
`Boolean`	`isEmpty()` Indicates whether this set is empty.	Cmn
`Boolean`	`isNotEmpty()` Returns `true` if this set is not empty.	Cmn
`String`	`joinToString( separator: CharSequence, prefix: CharSequence, postfix: CharSequence, limit: Int, truncated: CharSequence )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.	Cmn
`inline String`	`joinToString( separator: CharSequence, prefix: CharSequence, postfix: CharSequence, limit: Int, truncated: CharSequence, crossinline transform: (Int) -> CharSequence )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.	Cmn
`Boolean`	`none()` Returns `true` if this set has no elements.	Cmn
`open String`	`toString()` Returns a string representation of this set.	Cmn

Inherited properties

From androidx.collection.IntSet

`Int`	`capacity` Returns the number of elements that can be stored in this set without requiring internal storage reallocation.	Cmn
`Int`	`size` Returns the number of elements in this set.	Cmn

Public constructors

MutableIntSet

Cmn

Added in 1.4.0

MutableIntSet(initialCapacity: Int = DefaultScatterCapacity)

Creates a new MutableIntSet

Parameters
`initialCapacity: Int = DefaultScatterCapacity`	The initial desired capacity for this container. The container will honor this value by guaranteeing its internal structures can hold that many elements without requiring any allocations. The initial capacity can be set to 0.

Public functions

add

Cmn

Added in 1.4.0

fun add(element: Int): Boolean

Adds the specified element to the set.

Parameters
`element: Int`	The element to add to the set.

Returns
`Boolean`	`true` if the element has been added or `false` if the element is already contained within the set.

addAll

Cmn

Added in 1.4.0

fun addAll(elements: IntArray): Boolean

Adds all the elements into this set.

Parameters
`elements: IntArray`	An array of elements to add to the set.

Returns
`Boolean`	`true` if any of the specified elements were added to the collection, `false` if the collection was not modified.

addAll

Cmn

Added in 1.4.0

fun addAll(elements: IntSet): Boolean

Adds all the elements in the elements set into this set.

Parameters
`elements: IntSet`	A `IntSet` of elements to add to this set.

Returns
`Boolean`	`true` if any of the specified elements were added to the collection, `false` if the collection was not modified.

clear

Cmn

Added in 1.4.0

fun clear(): Unit

Removes all elements from this set.

minusAssign

Cmn

Added in 1.4.0

operator fun minusAssign(element: Int): Unit

Removes the specified element from the set if it is present.

Parameters
`element: Int`	The element to remove from the set.

minusAssign

Cmn

Added in 1.4.0

operator fun minusAssign(elements: IntArray): Unit

Removes the specified elements from the set, if present.

Parameters
`elements: IntArray`	An array of elements to be removed from the set.

minusAssign

Cmn

Added in 1.4.0

operator fun minusAssign(elements: IntSet): Unit

Removes the specified elements from the set, if present.

Parameters
`elements: IntSet`	An `IntSet` of elements to be removed from the set.

plusAssign

Cmn

Added in 1.4.0

operator fun plusAssign(element: Int): Unit

Adds the specified element to the set.

Parameters
`element: Int`	The element to add to the set.

plusAssign

Cmn

Added in 1.4.0

operator fun plusAssign(elements: IntArray): Unit

Adds all the elements into this set.

Parameters
`elements: IntArray`	An array of elements to add to the set.

plusAssign

Cmn

Added in 1.4.0

operator fun plusAssign(elements: IntSet): Unit

Adds all the elements in the elements set into this set.

Parameters
`elements: IntSet`	A `IntSet` of elements to add to this set.

remove

Cmn

Added in 1.4.0

fun remove(element: Int): Boolean

Removes the specified element from the set.

Parameters
`element: Int`	The element to remove from the set.

Returns
`Boolean`	`true` if the `element` was present in the set, or `false` if it wasn't present before removal.

removeAll

Cmn

Added in 1.4.0

fun removeAll(elements: IntArray): Boolean

Removes the specified elements from the set, if present.

Parameters
`elements: IntArray`	An array of elements to be removed from the set.

Returns
`Boolean`	`true` if the set was changed or `false` if none of the elements were present.

removeAll

Cmn

Added in 1.4.0

fun removeAll(elements: IntSet): Boolean

Removes the specified elements from the set, if present.

Parameters
`elements: IntSet`	An `IntSet` of elements to be removed from the set.

Returns
`Boolean`	`true` if the set was changed or `false` if none of the elements were present.

trim

Cmn

Added in 1.4.0

fun trim(): @IntRange(from = 0) Int

Trims this MutableIntSet's storage so it is sized appropriately to hold the current elements.

Returns the number of empty elements removed from this set's storage. Returns 0 if no trimming is necessary or possible.