STL Container IB Reference - Revision history

Justin at 21:46, 13 October 2023

2023-10-13T21:46:38Z

← Older revision		Revision as of 21:46, 13 October 2023
Line 45:		Line 45:
	'''stlBegin( <container-name> )''' sets the iterator position at the beginning		'''stlBegin( <container-name> )''' sets the iterator position at the beginning
	'''stlEnd( <container-name> )''' sets the iterator position at the end		'''stlEnd( <container-name> )''' sets the iterator position at the end
-	'''stlNext( <container-name> )''' moves the iterator position forward one element	+	'''stlNext( <container-name> ) [, EXCP=statement label]''' moves the iterator position forward one element
	'''stlPrev( <container-name> )''' moves the iterator position back one element		'''stlPrev( <container-name> )''' moves the iterator position back one element
	'''stlRead( <container-name> [,EXCP=statement label])''' gets the element at the current iterator position		'''stlRead( <container-name> [,EXCP=statement label])''' gets the element at the current iterator position

Barb: /* Utility Functions */

2020-07-14T23:37:01Z

Utility Functions

← Older revision		Revision as of 23:37, 14 July 2020
Line 61:		Line 61:
	These are basic functions that return information about the specified container.		These are basic functions that return information about the specified container.

-	'''stlSize( <container-name> )''' returns the size of the container	+	'''stlSize( <container-name> [,EXCP=statement label])''' returns the size of the container
-	'''stlEmpty( <container-name> )''' returns whether the container is empty	+	'''stlEmpty( <container-name> [,EXCP=statement label])''' returns whether the container is empty
	'''stlClear( <container-name> )''' empties the specified container		'''stlClear( <container-name> )''' empties the specified container
	'''stlReset( <container-name> )''' resets the container to its initial values		'''stlReset( <container-name> )''' resets the container to its initial values

Barb: /* Iteration Functions */

2020-07-14T23:33:15Z

Iteration Functions

← Older revision		Revision as of 23:33, 14 July 2020
Line 51:		Line 51:

	Maps only:		Maps only:
-	'''stlReadKey( <container-name> )''' gets the key at the current iterator position	+	'''stlReadKey( <container-name> [,EXCP=statement label])''' gets the key at the current iterator position

	Lists only:		Lists only:

Barb: /* Iteration Functions */

2020-07-14T23:29:48Z

Iteration Functions

← Older revision		Revision as of 23:29, 14 July 2020
Line 47:		Line 47:
	'''stlNext( <container-name> )''' moves the iterator position forward one element		'''stlNext( <container-name> )''' moves the iterator position forward one element
	'''stlPrev( <container-name> )''' moves the iterator position back one element		'''stlPrev( <container-name> )''' moves the iterator position back one element
-	'''stlRead( <container-name> )''' gets the element at the current iterator position	+	'''stlRead( <container-name> [,EXCP=statement label])''' gets the element at the current iterator position
	'''stlWrite( <container-name>, <data> )''' - sets the element at the current iterator position		'''stlWrite( <container-name>, <data> )''' - sets the element at the current iterator position

Barb: /* Stack/Queue */

2020-07-14T23:25:24Z

Stack/Queue

← Older revision		Revision as of 23:25, 14 July 2020
Line 31:		Line 31:
	'''stlPush( <container-name>, <data> )''' adds an element to the container		'''stlPush( <container-name>, <data> )''' adds an element to the container
	'''stlPop( <container-name> )''' removes the next element from the container		'''stlPop( <container-name> )''' removes the next element from the container
-	'''stlPeek( <container-name> )''' gets the next element from the container	+	'''stlPeek( <container-name> [,EXCP=statement label])''' gets the next element from the container
-	'''stlGet( <container-name>, <index> )''' gets the element at the index specified	+	'''stlGet( <container-name>, <index> [,EXCP=statement label])''' gets the element at the index specified
	'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified		'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified

Barb: /* List */

2020-07-14T23:19:59Z

List

← Older revision		Revision as of 23:19, 14 July 2020
Line 17:		Line 17:
	'''stlPushFront( <container-name>, <data> )''' adds an element to the beginning of the list		'''stlPushFront( <container-name>, <data> )''' adds an element to the beginning of the list
	'''stlPopFront( <container-name> )''' removes the element at the beginning of the list		'''stlPopFront( <container-name> )''' removes the element at the beginning of the list
-	'''stlFront( <container-name> )''' gets the element at the beginning of the list	+	'''stlFront( <container-name> [,EXCP=statement label])''' gets the element at the beginning of the list
-	'''stlBack( <container-name> )''' gets the element at the end of the list	+	'''stlBack( <container-name> [,EXCP=statement label])''' gets the element at the end of the list

	Lists are designed to be accessed sequentially, that is each element is associated with the preceding and following elements in the container. As such, the core functions provided are used to add, remove, and get the elements at the front and back of the list. The real power of lists is utilized during iteration - they are the most efficient container for inserting and erasing elements in the middle of the container.		Lists are designed to be accessed sequentially, that is each element is associated with the preceding and following elements in the container. As such, the core functions provided are used to add, remove, and get the elements at the front and back of the list. The real power of lists is utilized during iteration - they are the most efficient container for inserting and erasing elements in the middle of the container.

Barb: /* Map */

2020-07-14T23:12:06Z

Map

← Older revision		Revision as of 23:12, 14 July 2020
Line 23:		Line 23:

	====Map====		====Map====
-	'''stlGet( <container-name>, <key> )''' gets the element at the key specified	+	'''stlGet( <container-name>, <key> [,EXCP=statement label])''' gets the element at the key specified
	'''stlSet( <container-name> <key> <data>)''' sets the element at the key specified		'''stlSet( <container-name> <key> <data>)''' sets the element at the key specified

Barb: /* Vector */

2020-07-14T23:06:56Z

Vector

← Older revision		Revision as of 23:06, 14 July 2020
Line 5:		Line 5:
	'''stlPushBack( <container-name>, <data> )''' adds an element to the end of the vector		'''stlPushBack( <container-name>, <data> )''' adds an element to the end of the vector
	'''stlPopBack( <container-name> )''' removes the element at the end of the vector		'''stlPopBack( <container-name> )''' removes the element at the end of the vector
-	'''stlFront( <container-name> )''' gets the element at the front of the vector	+	'''stlFront( <container-name> [,EXCP=statement label])''' gets the element at the front of the vector
-	'''stlBack( <container-name> )''' gets the element at the end of the vector	+	'''stlBack( <container-name> [,EXCP=statement label])''' gets the element at the end of the vector
-	'''stlGet( <container-name>, <index> )''' gets the element at the index specified	+	'''stlGet( <container-name>, <index> [,EXCP=statement label])''' gets the element at the index specified
	'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified		'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified

Barb: /* Vector */

2011-11-29T21:38:08Z

Vector

← Older revision		Revision as of 21:38, 29 November 2011
Line 8:		Line 8:
	'''stlBack( <container-name> )''' gets the element at the end of the vector		'''stlBack( <container-name> )''' gets the element at the end of the vector
	'''stlGet( <container-name>, <index> )''' gets the element at the index specified		'''stlGet( <container-name>, <index> )''' gets the element at the index specified
-	'''stlSet <container-name> <index> <data>''' sets the element at the index specified	+	'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified

	Similar to arrays, vectors are mostly used to access data based on a numeric index, thus stlGet and stlSet are going to be your bread and butter functions for this container. stlPushBack is a great way to programatically build a vector - it will append the specified data to the end of the vector, and increase its size by 1. If you want to remove the last element, you would use stlPopBack. Then the stlFront and stlBack functions have been included as shortcuts for accessing the first and last elements respectively.		Similar to arrays, vectors are mostly used to access data based on a numeric index, thus stlGet and stlSet are going to be your bread and butter functions for this container. stlPushBack is a great way to programatically build a vector - it will append the specified data to the end of the vector, and increase its size by 1. If you want to remove the last element, you would use stlPopBack. Then the stlFront and stlBack functions have been included as shortcuts for accessing the first and last elements respectively.

Barb: /* Stack/Queue */

2011-11-29T21:37:43Z

Stack/Queue

← Older revision		Revision as of 21:37, 29 November 2011
Line 33:		Line 33:
	'''stlPeek( <container-name> )''' gets the next element from the container		'''stlPeek( <container-name> )''' gets the next element from the container
	'''stlGet( <container-name>, <index> )''' gets the element at the index specified		'''stlGet( <container-name>, <index> )''' gets the element at the index specified
-	'''stlSet <container-name> <index> <data>''' sets the element at the index specified	+	'''stlSet( <container-name> <index> <data>)''' sets the element at the index specified

	Both stacks and queues utilize the same set of functions, but perform differently depending on which container you have implemented. In general, the stlPush, stlPop, and stlPeek functions are going to be the most important of these functions. They perform the basic operations associated with these containers. For stacks, stlPush and stlPop adds and removes from the end of the container. For queues, stlPush adds to the end of the container, and stlPop removes from the front of the container. For both containers, stlPeek will get the "next" element in the container (i.e. the last element for stacks, the first element for queues).		Both stacks and queues utilize the same set of functions, but perform differently depending on which container you have implemented. In general, the stlPush, stlPop, and stlPeek functions are going to be the most important of these functions. They perform the basic operations associated with these containers. For stacks, stlPush and stlPop adds and removes from the end of the container. For queues, stlPush adds to the end of the container, and stlPop removes from the front of the container. For both containers, stlPeek will get the "next" element in the container (i.e. the last element for stacks, the first element for queues).