Update the documentation for vector.h and fix a bug in vector.c.

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@5723 4a71c877-e1ca-e34f-864e-861f7616d084
master
Freddie Witherden 2008-08-01 12:02:18 +00:00
parent 415f4555dc
commit b45fad3ee0
2 changed files with 29 additions and 7 deletions

View File

@ -68,7 +68,7 @@ void *vectorAt(vector *v, int index)
void *vectorHead(vector *v) void *vectorHead(vector *v)
{ {
return vectorAt(v, v->head); return vectorAt(v, v->head - 1);
} }
void *vectorSetAt(vector *v, int index, void *object) void *vectorSetAt(vector *v, int index, void *object)

View File

@ -29,12 +29,20 @@ void vectorDestroy(vector *v);
void *vectorAdd(vector *v, void *object); void *vectorAdd(vector *v, void *object);
/** /**
* Returns a pointer to the object at offset index for the vector v.
* *
* @param v The vector to return the item from.
* @param index The index of the desired item.
* @return A pointer to the object/item, or NULL if no such item exists.
*/ */
void *vectorAt(vector *v, int index); void *vectorAt(vector *v, int index);
/** /**
* A convenience method that returns the most recently added item to the vector
* v. It is functionally equivalent to: vectorAt(v, vectorSize(v)).
* *
* @param v The vector to return the last item of.
* @return The last item in the vector.
*/ */
void *vectorHead(vector *v); void *vectorHead(vector *v);
@ -44,22 +52,36 @@ void *vectorHead(vector *v);
void *vectorSetAt(vector *v, int index, void *object); void *vectorSetAt(vector *v, int index, void *object);
/** /**
* Removes the item at index from the vector v.
* *
* @param v The vector to remove the item from.
* @param index The index of the item to remove.
*/ */
void vectorRemoveAt(vector *v, int index); void vectorRemoveAt(vector *v, int index);
/** /**
* Iterates through each item in the vector v calling cb(vectorAt(v, index)).
* *
* @param v The vector to map/iterate over.
* @param cb The function to call.
*/ */
void vectorMap(vector *v, mapCallback cb); void vectorMap(vector *v, mapCallback cb);
/** /**
* Invokes vectorMap(v, cb) followed by vectorDestroy(v). This allows for the
* elements in the vector to be free'ed/destroyed in order to prevent memory
* leaks.
* *
* @param v The vector to map over and destroy.
* @param cb The function to call.
*/ */
void vectorMapAndDestroy(vector *v, mapCallback cb); void vectorMapAndDestroy(vector *v, mapCallback cb);
/** /**
* Returns the number of elements in the vector v.
* *
* @param v The vector to get the number of elements of.
* @return The number of elements in the vector.
*/ */
int vectorSize(vector *v); int vectorSize(vector *v);