Integer Vectors

Overview

The IntVector class is designed to hold an arbitrarily large, extensible series of integer numbers. The class functions allow the user to set and query individual integer numbers in a vector using an integer index key. The integer numbers are guaranteed to be contiguous in memory with respect to the integer index key.

Definition
- define() - Define initial maximum index
- inquire() - Inquire current maximum index
Set and query values
- append() - Append value at end of vector
- clear() - Clear all integers to zero
- count() - Get number of nonzero integers
- match() - Check for matching objects
- initializeIterator() - Prepare to successively visit each nonzero
- nextItem() - Return the index of the next nonzero
- set() - Set a integer value at an index
- get() - Get a integer value at an index
- setIntegerParameter() - Set integer vector operation parameters
- expand() - Expand to a given index
- unique() - Append value at end of vector if not already present
- getStartingIndex() - Get the starting index of a IntVector object
- increment() - Increment a integer value at an index
General functions
- getErrorCode() - Return the current error code
- print() - Print object information
- copy() - copy a IntVector

Once a IntVector object is instanced, an approximate number of integers to be stored may be defined using define(). This allocates an internal array for the storage of integer values. As integer values are set the IntVector module will adjust memory as required. The actual maximum index referenced or defined may be determined by calling inquire(). The individual integers are addressed by an index which is greater than or equal to zero. The validity of the zero index may be toggled using setIntegerParameter().

Integer values are initially zero. Integer values may be set by calling set(). A integer value may be returned for a given index using get(). The total number of nonzero integer values contained in the vector may be found by calling count().

The index of each nonzero integer value in the vector may be returned with an “iterator” construct. The pair of methods initializeIterator() and nextItem() are used to visit each nonzero value using a loop. Call the first method before the body of the loop to prepare the IntVector object for the iteration. Within the loop body, call nextItem(). It will return the index to the next nonzero value each time it is called. It will return an index of -1 when all of the nonzero values have been processed.

Class Members Descriptions

The currently available IntVector enumerations and functions are described in detail in this section.

class IntVector

Integer Vectors.

Public Types

enum class IntegerParameter

Integer parameters for IntVector.

Values:

enumerator INCLUDE_ZERO: Validity of zero index.

Public Functions

ErrorCode getErrorCode()

Return the current ErrorCode of the IntVector object.

Returns:	`ErrorCode` - The current error code, or `NONE` if no error.

Status define(int length)

Suggest the maximum index to be stored in the IntVector. This is used to allocate the initial array of storage which is used to hold the vector. If an index is accessed greater than this initial estimate, storage space is dynamically expanded to hold the extra integer values. This function clears any previously set values to zero.

Parameters:	length – Estimated maximum index addressed
Returns:	Status

Parameters:	maxIndex – [out] Maximum index
Returns:	Status

Parameters:	parameter – `IntegerParameter` of parameter to set value – Specifies the integer value that type will be set to
Returns:	Status

Parameters:	itemCount – [out] Number of nonzero integer values
Returns:	Status

Integer Vectors

Overview

Class Members Descriptions

Hello! I'm HOOPSY