std

The index of the first item

std.Array.Get first

Gets the first item in the array

Outputs

The first item

std.Array.Push first

Inserts an item at the start of the array

Inputs

Outputs

An index to the first item

std.Array.Pop first

Removes an item from the start of the array

Outputs

The removed item

std.Array.Last

Returns an index to the last item in the array

Outputs

An index

std.Array.Get last

Returns the last item in the array

Outputs

The item

std.Array.Pop

Removes the last item in the array

Outputs

The item that was removed

std.Array.Push

Inserts an item at the end of the array.

Inputs

The value to append

Outputs

The index of the pushed item

std.Array.Push last

Pushes (appends) an item on the end of the array

Inputs

The value to append

std.Array.Pop last

Removes and returns the last item in the array, or NULL

Outputs

The previous last item in the array

std.Array.End

Returns the end (size) of the array.

Outputs

A special index

std.Array.Next

Increments the index

Inputs

Outputs

An index, or End()

std.Array.Prev

Decrements the index

Inputs

Outputs

An index, or End()

std.Array.Get

Gets an item from the array

Inputs

key	The index (key) to retrieve

Outputs

The item matching the key (index)

std.Array.Resize

Resizes the array. Can grow or shrink it.

Inputs

n	The new size

std.Array.Size

Returns the number of items in the array.

Outputs

The number of items in the array

std.Array.Set

Sets an item in the array. Grows the array if necessary

Inputs

key	The index to set
value	The new value.

std.Array.For each

Visits each item in the array

Inputs

The functor that is called with each array item

std.Array.Get key

Gets the key for a particular index

Inputs

Outputs

The key (same as the index)

std.Array.Get index

Gets the index for a particular key

Inputs

The key

Outputs

The index (same as the key)

std.Array.Get value

Gets the value of a particular index (same as Get)

Inputs

The index

Outputs

The value at the index

std.Array.Contains

Returns true if the array contains the key (index)

Inputs

The key

Outputs

True if the index is valid

std.Array.Validate

Validates the array

Outputs

True

std.Array.Insert

Inserts an item at a position in the array

Inputs

pos	The position (index) to insert at
value	The value to insert

Outputs

std.Array.Remove

Removes at item at an index in the array

Inputs

pos	The index to remove

Outputs

The index of the removed item

std.Array.Remove all

Makes the array empty

std.Array.Remove index

Same as Remove

Inputs

i	The index to remove

Outputs

The index of the removed item

std.Array.Insert before

Same as Insert

Inputs

pos	The position to insert at
value	The value to insert

Outputs

std.Array.Insert after

Inserts an item after a particular index

Inputs

pos	The position to insert after
value	The value to insert

Outputs

std.Array.Remove range

Erases a range of elements from the array [NOT IMPLEMENTED]

Inputs

from	The first element to erase
to	The last element (exclusive) to erase

std.Array.Is empty

Returns true if the array is empty.

Outputs

Whether the array is empty

std.List

A container storing items in a doubly-linked list

Outputs

For each	Visits each item in the list
First	Gets the first index
Last	Gets the last item in the list
End	The end of the list
Push first	Inserts an item to the front of the list
Pop first	Removes and returns the item at the front of the list
Push last	Inserts an item at the back of the list
Pop last	Removes and returns the item at the back of the list
Push	Same as Push last
Pop	Same as Pop last
Remove index	Removes the item with the given index
Next	Finds the next index
Prev	Find the previous index value
Get value	Retrieves the data at the particular index
Set value	Sets the data at the index
Insert before	Inserts an item before the given index
Remove all	Makes the entire structure empty
Validate	Checks the data structure is okay and has not been damaged by bugs
Insert after	Insert an item after a given index
Get first	Gets the item at the start of the list
Get last	Gets the last item in the list
Size	Gets the number of items in the list
Is empty	Tests whether the structure is empty

std.List.For each

Visits each item in the list

Inputs

The functor that is called at each visit.

std.List.First

Gets the first index

Outputs

The index of the first item in the list

std.List.Last

Gets the last item in the list

Outputs

The index of the last item in the list

std.List.End

The end of the list

Outputs

A special index meaning "end of the list"

std.List.Push first

Inserts an item to the front of the list

Inputs

The value to insert

Outputs

The index of the new node

std.List.Pop first

Removes and returns the item at the front of the list

Outputs

std.List.Push last

Inserts an item at the back of the list

Inputs

The value to insert

Outputs

The index of the new node

std.List.Pop last

Removes and returns the item at the back of the list

Outputs

std.List.Push

Same as Push last

Inputs

Outputs

std.List.Pop

Same as Pop last

Outputs

std.List.Remove index

Removes the item with the given index

Inputs

std.List.Next

Finds the next index

Inputs

Outputs

std.List.Prev

Find the previous index value

Inputs

Outputs

std.List.Get value

Retrieves the data at the particular index

Inputs

Outputs

The value retrieved

std.List.Set value

Sets the data at the index

Inputs

std.List.Insert before

Inserts an item before the given index

Inputs

before	The index of the item to insert before
value	The new value to insert

Outputs

The index of the new item

std.List.Remove all

Makes the entire structure empty

std.List.Validate

Checks the data structure is okay and has not been damaged by bugs

Outputs

std.List.Insert after

Insert an item after a given index

Inputs

after

Outputs

The index of the new item

std.List.Get first

Gets the item at the start of the list

Outputs

The first item in the list

std.List.Get last

Gets the last item in the list

Outputs

The last item in the list

std.List.Size

Gets the number of items in the list

Outputs

The number of items

std.List.Is empty

Tests whether the structure is empty

Outputs

True if the structure is empty

std.Tree

A red-black tree. This is used as the base of several other containers.

Inputs

less	A comparison function, or null for the default <

Outputs

Insert node
For each	Visits each node in the tree
Validate	Validates the data structure for integrity
First	Gets the first (minimum) index
Last	Gets the last (maximum) index
End	Gets the nil (not found) index
Next	Finds the next index for a particular index
Prev	Finds the previous index
Find	Locate an index in the tree
Remove index	Deletes a node
Size	Computes the number of items in the tree
Is empty	Checks whether the data structure is empty
Get root	Retrieves the root of the tree
Remove all	This deletes every node in the tree.
Contains	Tests whether the tree contains the key
Node	An index in the tree

std.Tree.Insert node

Inputs

std.Tree.For each

Visits each node in the tree

Inputs

std.Tree.Validate

Validates the data structure for integrity

Outputs

std.Tree.First

Gets the first (minimum) index

Outputs

The index to the first (minimum) item, or End() if empty

std.Tree.Last

Gets the last (maximum) index

Outputs

The index of the last (maximum) item, or End() if empty

std.Tree.End

Gets the nil (not found) index

Outputs

An index meaning "not found"

std.Tree.Next

Finds the next index for a particular index

Inputs

The index

Outputs

The next index, or End()

std.Tree.Prev

Finds the previous index

Inputs

n	The index
Tree predecessor

Outputs

The index to the previous item, or End() if not found

std.Tree.Find

Locate an index in the tree

Inputs

Outputs

The index matching the given key, or End() if not found

std.Tree.Remove index

Deletes a node

Inputs

node

std.Tree.Size

Computes the number of items in the tree

Outputs

The number of items in the tree

std.Tree.Is empty

Checks whether the data structure is empty

Outputs

True if the structure is empty

std.Tree.Get root

Retrieves the root of the tree

Outputs

The root of the tree

std.Tree.Remove all

This deletes every node in the tree.

std.Tree.Contains

Tests whether the tree contains the key

Inputs

Outputs

True if the tree contains the key

std.Tree.Node

An index in the tree

Outputs

key	The stored key
value	The stored value
left	The node to the left
right	The node to the right
colour	The colour of the node
parent	The parent of the node

std.Map

An associative array: maps objects from one doman to another

Inputs

less	A comparison function, or null for the default <

Outputs

extends	Tree
Get	Gets the value for a particular key
Set	Sets or inserts a new member of the map.
Remove	Removes an item matching the given key.
Get first	Gets the first item in the map
Get last	Gets the last item in the map
For each	Visits each item in the map
Get key	Gets the key of a particular index
Get value	Gets the value of a particular index
Insert	Inserts an item in the map. This will insert duplicates
Get root	From Tree
End	From Tree

std.Map.Get

Gets the value for a particular key

Inputs

Outputs

The item found, or null if the key does not exist

std.Map.Set

Sets or inserts a new member of the map.

Inputs

Outputs

std.Map.Remove

Removes an item matching the given key.

Inputs

Outputs

The index of the removed item

std.Map.Get first

Gets the first item in the map

Outputs

The first item in the map, or null if empty

std.Map.Get last

Gets the last item in the map

Inputs

Outputs

The value item in the map, or null if empty

std.Map.For each

Visits each item in the map

Inputs

std.Map.Get key

Gets the key of a particular index

Inputs

Outputs

The key of the index

std.Map.Get value

Gets the value of a particular index

Inputs

Outputs

The value at the index

std.Map.Insert

Inserts an item in the map. This will insert duplicates

Inputs

key

Outputs

An index to the new item

std.Set

A set container that does not permit duplicates

Inputs

less

Outputs

extends	An extension of Tree
Insert	Inserts an item into the set. Ignores duplicates.
For each
First	Inherited
End	Inherited
Next	Inherited

std.Set.Insert

Inserts an item into the set. Ignores duplicates.

Inputs

k	The value to insert

Outputs

An index to the item

std.Set.For each

Inputs

Outputs

std.Set.For each.i

Outputs

key

std.Multiset

Provides a multiset container

Inputs

less	The less functor

Outputs

extends	An extension of std.Set
Insert	Inserts an item, allows duplicates
Node	From Set
Insert node	From Set

std.Multiset.Insert

Inserts an item, allows duplicates

Inputs

key	The key to insert

Outputs

An index to the newly inserted node.

std.Exit

Exits the program

Inputs

code	The exit code, default=0

std.Sort

Sorts an entire array

Inputs

vec	The array to sort
less	The functor used to compare two values

std.Sort range

Sorts a range of values in an array

Inputs

vec

less

std.Getenv

Gets an environment variable

Inputs

env	The variable to look up

Outputs

The value of the variable as a string

std.Start args

Re-reads all command-line args

std.Get arg

Gets one command-line argument

Outputs