Objeck Documentation

SetHash

Unordered set of generic objects

# insert elements
set_hash := Collection.SetHash->New()<String>;
set_hash->Insert("San Francisco");
set_hash->Insert("Oakland");
set_hash->Insert("East Bay");

# get size
set_hash->Size()->PrintLine();

# get value by key
set_hash->Has("Oakland")->PrintLine();

Operations

New
Empty
GetKeys
Has
Insert
IsEmpty
Remove
Size
ToString

Empty

Clears the set

method : public : Empty() ~ Nil

GetKeys

Get a collection of keys

method : public : GetKeys() ~ Vector<K>

Return

Type	Description
Vector<K>	vector of keys

Has

Checks for key in set

method : public : Has(key:K) ~ Bool

Parameters

Name	Type	Description
key	K	search key

Return

Type	Description
Bool	true if found, false otherwise

Insert

Inserts a key into the set

method : public : Insert(key:K) ~ Nil

Parameters

Name	Type	Description
key	K	key

IsEmpty

Checks to see if the set is empty

method : public : IsEmpty() ~ Bool

Return

Type	Description
Bool	true if empty, false otherwise

New

Default constructor

New()

Remove

Removes a key from the set

method : public : Remove(key:K) ~ Bool

Parameters

Name	Type	Description
key	K	key for value to remove

Return

Type	Description
Bool	true if removed, false otherwise

Size

Size of map

method : public : Size() ~ Int

Return

Type	Description
Int	size of queue

ToString

Formats the collection into a string. If an element implements the 'Stringify' interface, it's 'ToString()' is called.

method : public : ToString() ~ String

Return

Type	Description
String	string representation