goog.structs.Set

Provided By	`goog.structs.Set`
All Implemented Interfaces	`Iterable<T>` `goog.structs.Collection<T>`

Deprecated	This type is misleading: use ES6 Set instead.

A set that can contain both primitives and objects. Adding and removing elements is O(1). Primitives are treated as identical if they have the same type and convert to the same string. Objects are treated as identical only if they are references to the same object. WARNING: A goog.structs.Set can contain both 1 and (new Number(1)), because they are not the same. WARNING: Adding (new Number(1)) twice will yield two distinct elements, because they are two different objects. WARNING: Any object that is added to a goog.structs.Set will be modified! Because goog.getUid() is used to identify objects, every object in the set will be mutated.

new Set`<T>`( `opt_values` )

Parameters

`opt_values`	`(Array<(T\|null)>\|Object<?, (T\|null)>\|null)=`
	Initial values to start with.

Instance Methods

Returns an iterator that iterates over the elements in this set.

Deprecated	Call `values` and use native iteration, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`opt_keys`	`boolean=`
	This argument is ignored.

Returns

goog.iter.Iterator

An iterator over the elements in this set.

Add a primitive or an object to the set.

Overrides

goog.structs.Set

Specified by

goog.structs.Collection

Parameters

`element`	`(T\|null)`
	The primitive or object to add.

Adds all the values in the given collection to this set.

Deprecated	Use `goog.collections.sets.addAll(thisSet, col)` instead, converting Objects to their values using `Object.values`, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Array<(T\|null)>\|goog.structs.Collection<(T\|null)>\|Object<?, (T\|null)>\|null)`
	A collection containing the elements to add.

Removes all elements from this set.

Overrides	`goog.structs.Set`
Parameters	None.

Creates a shallow clone of this set.

Deprecated	Use `new Set(thisSet.values())` for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

None.

Returns

goog.structs.Set<(T|null)>

A new set containing all the same elements as this set.

Tests whether this set contains the given element.

Deprecated	Use `has` instead, for alignment with ES6 Set.

Overrides

goog.structs.Set

Specified by

goog.structs.Collection

Parameters

`element`	`(T\|null)`
	The primitive or object to test for.

Returns

boolean

True if this set contains the given element.

Tests whether this set contains all the values in a given collection. Repeated elements in the collection are ignored, e.g. (new goog.structs.Set([1, 2])).containsAll([1, 1]) is True.

Deprecated	Use `goog.collections.sets.hasAll(thisSet, col)`, converting Objects to arrays using Object.values, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Object\|null)`
	A collection-like object.

Returns

boolean

True if the set contains all elements.

Removes the given element from this set.

Overrides

goog.structs.Set

Parameters

`element`	`(T\|null)`
	The primitive or object to remove.

Returns

boolean

Whether the element was found and removed.

Finds all values that are present in this set and not in the given collection.

Overrides

goog.structs.Set

Parameters

`col`	`(Array<(T\|null)>\|goog.structs.Collection<(T\|null)>\|Object<?, (T\|null)>\|null)`
	A collection.

Returns

goog.structs.Set

A new set containing all the values (primitives or objects) present in this set but not in the given collection.

Tests whether the given collection consists of the same elements as this set, regardless of order, without repetition. Primitives are treated as equal if they have the same type and convert to the same string; objects are treated as equal if they are references to the same object. This operation is O(n).

Deprecated	Use `goog.collections.equals(thisSet, col)`, converting Objects to arrays using Object.values, instead for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Object\|null)`
	A collection.

Returns

boolean

True if the given collection consists of the same elements as this set, regardless of order, without repetition.

Deprecated	Use the `size` property instead, for alignment with ES6 Set.

Overrides

goog.structs.Set

Specified by

goog.structs.Collection

Parameters

None.

Returns

number

The number of elements in the set.

Returns an array containing all the elements in this set.

Deprecated	Use `Array.from(set.values())` instead, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

None.

Returns

Array<(T|null)>

An array containing all the elements in this set.

Tests whether this set contains the given element.

Overrides

goog.structs.Set

Parameters

`element`	`(T\|null)`
	The primitive or object to test for.

Returns

boolean

True if this set contains the given element.

Finds all values that are present in both this set and the given collection.

Deprecated	Use `goog.collections.sets.intersection(thisSet, col)`, converting Objects to arrays using Object.values, instead for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Array<(S\|null)>\|Object<?, (S\|null)>\|null)`
	A collection.

Returns

goog.structs.Set<(T|null)>

A new set containing all the values (primitives or objects) present in both this set and the given collection.

Tests whether this set is empty.

Deprecated	Use the size property and compare against 0, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

None.

Returns

boolean

True if there are no elements in this set.

Tests whether the given collection contains all the elements in this set. Primitives are treated as equal if they have the same type and convert to the same string; objects are treated as equal if they are references to the same object. This operation is O(n).

Deprecated	Use `goog.collections.isSubsetOf(thisSet, col)`, converting Objects to arrays using Object.values, instead for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Object\|null)`
	A collection.

Returns

boolean

True if this set is a subset of the given collection.

Removes the given element from this set.

Deprecated	Use `delete`, for alignment with ES6 Set.

Overrides

goog.structs.Set

Specified by

goog.structs.Collection

Parameters

`element`	`(T\|null)`
	The primitive or object to remove.

Returns

boolean

Whether the element was found and removed.

Removes all values in the given collection from this set.

Deprecated	Use `goog.collections.sets.removeAll(thisSet, col)` instead, converting Objects to their values using `Object.values`, for alignment with ES6 Set.

Overrides

goog.structs.Set

Parameters

`col`	`(Array<(T\|null)>\|goog.structs.Collection<(T\|null)>\|Object<?, (T\|null)>\|null)`
	A collection containing the elements to remove.

Overrides

goog.structs.Set

Parameters

None.

Returns

IteratorIterable<(T|null)>

Instance Properties

No information.

The number of items in this set.

Overrides	`goog.structs.Set`