Set¶

1

import "std/data/set";

Set<V> struct¶

Implements: IIterable<V>

A set in Spice is a commonly used data structure, which can be used to represent a list of unique values.

Time complexity:
Insert: O(log n)
Delete: O(log n)
Lookup: O(log n)

Methods¶

insert¶

1

public p Set.insert(const V& value)

Insert a value into the set. If the value already exists, nothing happens.

Parameters

contains¶

1

public f<bool> Set.contains(const V& value)

Check if the set contains the given value.

Parameters

Returns: bool — true if the value is in the set, false otherwise

remove¶

1

public p Set.remove(const V& value)

Remove a value from the set. If the value does not exist, nothing happens.

Parameters

clear¶

1

public p Set.clear()

Clear all values from the set.

getSize¶

1

public f<unsigned long> Set.getSize()

Get the number of elements in the set.

Returns: unsigned long — The number of elements in the set

isEmpty¶

1

public f<bool> Set.isEmpty()

Check if the set is empty.

Returns: bool — true if the set is empty, false otherwise

toLinkedList¶

1

public f<LinkedList<V>> Set.toLinkedList()

Get all elements in the set as a list.

Returns: LinkedList<V> — A linked list of all elements in the set

getIterator¶

1

public f<SetIterator<V>> Set.getIterator()

Retrieve a forward iterator for the set

Returns: SetIterator<V>

SetIterator<V> struct¶

Implements: IIterator<const V&>

Iterator to iterate over an set data structure

Constructors¶

ctor¶

1

public p SetIterator.ctor<V>(Set<V>& set)

Construct a set iterator over the given set

Parameters

Methods¶

get¶

1

public inline f<const V&> SetIterator.get()

Returns the current value of the set

Returns: const V& — Current value

getIdx¶

1

public inline f<Pair<unsigned long, const V&>> SetIterator.getIdx()

Returns the current index and the current item of the set

Returns: Pair<unsigned long, const V&> — Pair of current index and current key/value pair

isValid¶

1

public inline f<bool> SetIterator.isValid()

Check if the iterator is valid

Returns: bool — true or false

next¶

1

public inline p SetIterator.next()

Moves the cursor to the next key/value pair

Operators¶

operator++¶

1

public inline p operator++<V>(SetIterator<V>& it)

Advances the cursor by one

Parameters