`class Vector<ValueType>`

This class stores an ordered list of values similar to an array. It supports traditional array selection using square brackets, but also supports inserting and deleting elements.

Constructor
Vector() Vector(n, value)	Initializes a new vector.
Methods
size()	Returns the number of elements in this vector.
isEmpty()	Returns `true` if this vector contains no elements.
clear()	Removes all elements from this vector.
get(index)	Returns the element at the specified index in this vector.
set(index, value)	Replaces the element at the specified index in this vector with a new value.
insertAt(0, value)	Inserts the element into this vector before the specified index.
removeAt(index)	Removes the element at the specified index from this vector.
add(value)	Adds a new value to the end of this vector.
mapAll(fn) mapAll(fn, data)	Calls the specified function on each element of the vector in ascending index order.
Operators
vec[index]	Overloads `[]` to select elements from this vector.
v1 + v2	Concatenates two vectors.
v1 += v2;	Adds all of the elements from `v2` (or the single specified value) to `v1`.
Macro
foreach(ValueType value in vec)	Iterates over the elements of the vector in ascending index order.

Constructor detail

Vector();
Vector(int n, ValueType value = ValueType());

Initializes a new vector. The default constructor creates an empty vector. The second form creates an array with n elements, each of which is initialized to value; if value is missing, the elements are initialized to the default value for the type.

Usage:

Vector<ValueType> vec;
Vector<ValueType> vec(n, value);

Method detail

int size();

Returns the number of elements in this vector.

Usage:

int nElems = vec.size();

bool isEmpty();

Returns true if this vector contains no elements.

Usage:

if (vec.isEmpty()) . . .

void clear();

Removes all elements from this vector.

Usage:

vec.clear();

ValueType get(int index);

Returns the element at the specified index in this vector. This method signals an error if the index is not in the array range.

Usage:

ValueType val = vec.get(index);

void set(int index, ValueType value);

Replaces the element at the specified index in this vector with a new value. The previous value at that index is overwritten. This method signals an error if the index is not in the array range.

Usage:

vec.set(index, value);

void insertAt(int index, ValueType value);

Inserts the element into this vector before the specified index. All subsequent elements are shifted one position to the right. This method signals an error if the index is outside the range from 0 up to and including the length of the vector.

Usage:

vec.insertAt(0, value);

void removeAt(int index);

Removes the element at the specified index from this vector. All subsequent elements are shifted one position to the left. This method signals an error if the index is outside the array range.

Usage:

vec.removeAt(index);

void add(ValueType value);
void push_back(ValueType value);

Adds a new value to the end of this vector. To ensure compatibility with the vector class in the Standard Template Library, this method is also called push_back.

Usage:

vec.add(value);

void mapAll(void (*fn)(ValueType value));
void mapAll(void (*fn)(ValueType value, ClientDataType & data),
            ClientDataType & data);

Calls the specified function on each element of the vector in ascending index order. The second form of the call allows the client to pass a data value of any type to the callback function.

Usage:

vec.mapAll(fn);
vec.mapAll(fn, data);

Operator detail

ValueType & operator[](int index);

Overloads [] to select elements from this vector. This extension enables the use of traditional array notation to get or set individual elements. This method signals an error if the index is outside the array range.

Usage:

vec[index]

Vector operator+(Vector v2);

Concatenates two vectors.

Usage:

v1 + v2

Vector & operator+=(Vector v2);
Vector & operator+=(ValueType value);

Adds all of the elements from v2 (or the single specified value) to v1. As a convenience, the Vector package also overloads the comma operator so that it is possible to initialize a vector like this:

   Vector digits;
   digits += 0, 1, 2, 3, 4, 5, 6, 7, 8, 9;

Usage:

v1 += v2;
v1 += value;

Macro detail

foreach (ValueType value in vec) . . .

Iterates over the elements of the vector in ascending index order.