almixer_isolated: CircularQueue.h annotate

annotate CircularQueue.h @ 5:8cb13d89451a

Doxygen support and fixes.

author	Eric Wing <ewing . public \|-at-\| gmail . com>
date	Thu, 28 Oct 2010 01:26:11 -0700
parents	279d0427ef26
children	516da6d93534

rev	line source
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1 /*
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	2 CircularQueue
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	3 Copyright (C) 2002 Eric Wing <ewing . public @ playcontrol.net>
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	4
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	6 modify it under the terms of the GNU Library General Public
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	7 License as published by the Free Software Foundation; either
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	8 version 2 of the License, or (at your option) any later version.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	9
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	13 Library General Public License for more details.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	14
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	15 You should have received a copy of the GNU Library General Public
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	16 License along with this library; if not, write to the Free
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	18 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	19
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	20
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	21 #ifndef C_CIRCULAR_QUEUE_H
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	22 #define C_CIRCULAR_QUEUE_H
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	23
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	24 /* Set up for C function definitions, even when using C++ */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	25 #ifdef __cplusplus
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	26 extern "C" {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	27 #endif
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	28
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	29 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	30 * @file
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	31 * This is a C-based Circular queue class.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	32 * This class provides very simple circular queue functionality,
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	33 * with an API similar to the C++ STL queue class.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	34 * Currently, a queue cannot be resized.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	35 * Because C doesn't do templates and I really don't want
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	36 * to write my own polymorphism, you must select the proper queue
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	37 * for your data types.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	38 * I currently provide an unisigned int version
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	39 * and a void* version. The void* version will let you use any type,
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	40 * but remember that you are responsible for casting and maintaining
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	41 * your own type safety. I have found the unsigned int version to be
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	42 * very useful because if you have a map somewhere that associates
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	43 * unique identifier numbers to data (e.g. OpenGL displaylists/textures),
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	44 * then you can just deal with the id numbers and don't have to deal with
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	45 * the casting and typesafety issues. I recommend you don't overlook the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	46 * usefulness of this version.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	47 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	48 * @warning Do not mix the CircularQueues created from the different versions.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	49 * They are incompatible. Use only CircularQueueUnsignedInt objects with
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	50 * CircularQueueUnsignedInt_* functions, etc.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	51 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	52 * Example Usage:
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	53 * @code
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	54 * CircularQueueUnsignedInt* myqueue;
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	55 * unsigned int ret_val;
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	56 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	57 * myqueue = CircularQueueUnsignedInt_CreateQueue(3);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	58 * if(NULL == myqueue)
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	59 * {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	60 * fprintf(stderr, "Error, could not create queue\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	61 * return 0;
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	62 * }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	63 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	64 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	65 * ret_val = CircularQueueUnsignedInt_PushBack(myqueue, 1);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	66 * ret_val = CircularQueueUnsignedInt_PushBack(myqueue, 2);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	67 * ret_val = CircularQueueUnsignedInt_PushBack(myqueue, 3);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	68 * if(0 == ret_val)
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	69 * {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	70 * fprintf(stderr, "Error, Could not pushback\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	71 * exit(1);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	72 * }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	73 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	74 * ret_val = CircularQueueUnsignedInt_PopBack(myqueue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	75 * if(0 == ret_val)
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	76 * {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	77 * fprintf(stderr, "Error, Could not popback\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	78 * exit(2);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	79 * }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	80 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	81 * fprintf(stderr, "Testing queue, should have 1,2\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	82 * CircularQueueUnsignedInt_Print(myqueue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	83 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	84 * ret_val = CircularQueueUnsignedInt_PushFront(myqueue, 4);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	85 * if(0 == ret_val)
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	86 * {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	87 * fprintf(stderr, "Error, Could not pushfront\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	88 * exit(1);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	89 * }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	90 * fprintf(stderr, "Testing queue, should have 4,1,2\n");
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	91 * CircularQueueUnsignedInt_Print(myqueue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	92 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	93 * @endcode
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	94 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	95
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	96 /* This is a trick I picked up from Lua. Doing the typedef separately
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	97 * (and I guess before the definition) instead of a single
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	98 * entry: typedef struct {...} YourName; seems to allow me
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	99 * to use forward declarations. Doing it the other way (like SDL)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	100 * seems to prevent me from using forward declarions as I get conflicting
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	101 * definition errors. I don't really understand why though.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	102 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	103 typedef struct CircularQueueUnsignedInt CircularQueueUnsignedInt;
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	104 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	105 * This is the essentially the CircularQueue object.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	106 * This contains all the data associated with a CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	107 * This version is for unsigned int data types. In the future, I suppose
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	108 * I could add a void* data type at the very least and maybe some
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	109 * other data types.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	110 * This should be considered an opaque data type.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	111 */
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	112 struct CircularQueueUnsignedInt
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	113 {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	114 unsigned int maxSize; /*< Max size of the queue. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	115 unsigned int currentSize; /*< Current number of entries in the queue. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	116 unsigned int headIndex; /*< The index of where the current head is. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	117 unsigned int tailIndex; /*< The index of where the current tail is. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	118 unsigned int* internalQueue; /*< The array representing the queue. /
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	119 };
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	120
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	121 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	122 * This creates a new CircularQueue (for unsigned int) instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	123 * This will create a new circular queue instance which holds
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	124 * unsigned int's in its queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	125 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	126 * @note This implementation does not allow a circular queue to be resized.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	127 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	128 * @param max_size This specifies the maximum number of elements the circular
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	129 * can hold.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	130 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	131 * @return Returns a pointer to a CircularQueue which is the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	132 * instance variable (if successful) or NULL on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	133 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	134 * @see CircularQueueUnsignedInt_FreeQueue
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	135 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	136 CircularQueueUnsignedInt* CircularQueueUnsignedInt_CreateQueue(unsigned int max_size);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	137
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	138 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	139 * This destroys a CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	140 * This will destroy the memory associated with the circular queue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	141 * Whenever you create a CircularQueue instance, you should always to
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	142 * remember to balance it with a FreeQueue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	143 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	144 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	145 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	146 * @see CircularQueueUnsignedInt_CreateQueue
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	147 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	148 void CircularQueueUnsignedInt_FreeQueue(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	149
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	150 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	151 * This pushes a new value into the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	152 * If the queue is full, the function will fail and return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	153 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	154 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	155 * @param value The value you want to push into the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	156 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	157 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	158 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	159 unsigned int CircularQueueUnsignedInt_PushBack(CircularQueueUnsignedInt* queue, unsigned int value);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	160
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	161 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	162 * This pushes a new value into the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	163 * If the queue is full, the function will fail and return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	164 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	165 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	166 * @param value The value you want to push into the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	167 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	168 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	169 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	170 unsigned int CircularQueueUnsignedInt_PushFront(CircularQueueUnsignedInt* queue, unsigned int value);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	171
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	172 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	173 * This removes the value at the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	174 * If the queue is empty, the function will return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	175 * Note that this function does not return the value popped, but
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	176 * an error flag. If you need the value, you must call Front()
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	177 * to retrieve the value before popping it.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	178 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	179 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	180 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	181 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	182 * @see CircularQueueUnsignedInt_Front
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	183 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	184 unsigned int CircularQueueUnsignedInt_PopFront(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	185
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	186 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	187 * This removes the value at the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	188 * If the queue is empty, the function will return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	189 * Note that this function does not return the value popped, but
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	190 * an error flag. If you need the value, you must call Back()
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	191 * to retrieve the value before popping it.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	192 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	193 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	194 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	195 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	196 * @see CircularQueueUnsignedInt_Back
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	197 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	198 unsigned int CircularQueueUnsignedInt_PopBack(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	199
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	200 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	201 * This gets the value at the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	202 * If the queue is empty, the value returned will be 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	203 * Because this 0 return value is ambiguous because it could also could
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	204 * be a legitimate value in the queue, if you need more robust error
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	205 * checking for if the queue is empty, you should get the size of the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	206 * queue using the Size() function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	207 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	208 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	209 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	210 * @return Returns the value stored at the queue or 0 if the queue is empty
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	211 * (or if there is an error).
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	212 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	213 * @see CircularQueueUnsignedInt_Size
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	214 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	215 unsigned int CircularQueueUnsignedInt_Front(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	216
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	217 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	218 * This gets the value at the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	219 * If the queue is empty, the value returned will be 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	220 * Because this 0 return value is ambiguous because it could also could
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	221 * be a legitimate value in the queue, if you need more robust error
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	222 * checking for if the queue is empty, you should get the size of the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	223 * queue using the Size() function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	224 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	225 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	226 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	227 * @return Returns the value stored at the queue or 0 if the queue is empty
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	228 * (or 0 if there is an error).
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	229 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	230 * @see CircularQueueUnsignedInt_Size
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	231 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	232 unsigned int CircularQueueUnsignedInt_Back(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	233
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	234 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	235 * This gets the current number of entries that are in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	236 * This is number is not to be confused with the MaxSize.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	237 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	238 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	239 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	240 * @return Returns the number of entries currently in queue, or 0 if
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	241 * there is an error.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	242 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	243 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	244 unsigned int CircularQueueUnsignedInt_Size(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	245
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	246 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	247 * This gets the maximum number of entries that are allowed in the queue at
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	248 * a given time.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	249 * This is the number that you used in the CreateQueue function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	250 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	251 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	252 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	253 * @return Returns the maximum number of entries allowed in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	254 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	255 unsigned int CircularQueueUnsignedInt_MaxSize(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	256 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	257 * This empties the entire queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	258 * This will remove all entries that are in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	259 * This does not destroy any memory. Use FreeQueue() to actually destroy
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	260 * the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	261 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	262 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	263 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	264 void CircularQueueUnsignedInt_Clear(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	265
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	266 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	267 * This is a debugging function that will print all the elements in the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	268 * queue to stderr.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	269 * This function is provided as convenience, but should not be considered
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	270 * as part of the standard API. Treat this function as deprecated
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	271 * as it's implementation may change or be removed entirely.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	272 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	273 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	274 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	275 void CircularQueueUnsignedInt_Print(CircularQueueUnsignedInt* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	276
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	277 /**
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	278 * This returns the element located at the specified index,
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	279 * where index=0 represents the head/front of the queue.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	280 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	281 * @param queue The pointer to the CircularQueue instance.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	282 * @param the_index The index of the element you want where 0 represents the
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	283 * head/front of the queue and Size-1 is the back.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	284 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	285 * @return Returns the value located at the index on success, or 0 on failure.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	286 * Be careful to not to confuse an error for a legitmate 0 value.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	287 * Any index from 0 to Size-1 (where Size>0) will be a valid index.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	288 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	289 * This example traverses through the whole queue and prints out each value.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	290 * @code
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	291 * fprintf(stderr, "Queue: ");
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	292 * for(i=0;i<CircularQueueUnsignedInt_Size(xValueQueue);i++)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	293 * {
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	294 * ret_val = CircularQueueUnsignedInt_ValueAtIndex(xValueQueue, i);
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	295 * fprintf(stderr, "%d ", ret_val);
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	296 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	297 * }
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	298 * fprintf(stderr, "\n");
5 8cb13d89451a Doxygen support and fixes. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 2 diff changeset	299 * @endcode
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	300 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	301 * @note The implementation uses a modulo operation to compute the index, so
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	302 * this may not be the speediest operation in a tight loop.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	303 * This implementation was not optimized for random access, though it still
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	304 * is technically O(1).
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	305 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	306 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	307 unsigned int CircularQueueUnsignedInt_ValueAtIndex(CircularQueueUnsignedInt* queue, unsigned int the_index);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	308
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	309
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	310 /* This is a trick I picked up from Lua. Doing the typedef separately
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	311 * (and I guess before the definition) instead of a single
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	312 * entry: typedef struct {...} YourName; seems to allow me
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	313 * to use forward declarations. Doing it the other way (like SDL)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	314 * seems to prevent me from using forward declarions as I get conflicting
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	315 * definition errors. I don't really understand why though.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	316 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	317 typedef struct CircularQueueVoid CircularQueueVoid;
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	318 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	319 * This is the essentially the CircularQueue object.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	320 * This contains all the data associated with a CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	321 * This version is for unsigned int data types. In the future, I suppose
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	322 * I could add a void* data type at the very least and maybe some
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	323 * other data types.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	324 * This should be considered an opaque data type.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	325 */
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	326 struct CircularQueueVoid
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	327 {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	328 unsigned int maxSize; /*< Max size of the queue. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	329 unsigned int currentSize; /*< Current number of entries in the queue. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	330 unsigned int headIndex; /*< The index of where the current head is. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	331 unsigned int tailIndex; /*< The index of where the current tail is. /
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	332 void internalQueue; /< The array representing the queue. */
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	333 };
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	334
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	335 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	336 * This creates a new CircularQueue (for void* ) instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	337 * This will create a new circular queue instance which holds
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	338 * unsigned int's in its queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	339 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	340 * @note This implementation does not allow a circular queue to be resized.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	341 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	342 * @param max_size This specifies the maximum number of elements the circular
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	343 * can hold.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	344 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	345 * @return Returns a pointer to a CircularQueue which is the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	346 * instance variable (if successful) or NULL on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	347 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	348 * @see CircularQueueVoid_FreeQueue
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	349 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	350 CircularQueueVoid* CircularQueueVoid_CreateQueue(unsigned int max_size);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	351
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	352 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	353 * This destroys a CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	354 * This will destroy the memory associated with the circular queue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	355 * Whenever you create a CircularQueue instance, you should always to
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	356 * remember to balance it with a FreeQueue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	357 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	358 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	359 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	360 * @see CircularQueueVoid_CreateQueue
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	361 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	362 void CircularQueueVoid_FreeQueue(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	363
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	364 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	365 * This pushes a new value into the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	366 * If the queue is full, the function will fail and return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	367 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	368 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	369 * @param value The value you want to push into the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	370 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	371 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	372 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	373 unsigned int CircularQueueVoid_PushBack(CircularQueueVoid* queue, void* value);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	374
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	375 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	376 * This pushes a new value into the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	377 * If the queue is full, the function will fail and return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	378 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	379 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	380 * @param value The value you want to push into the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	381 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	382 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	383 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	384 unsigned int CircularQueueVoid_PushFront(CircularQueueVoid* queue, void* value);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	385
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	386 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	387 * This removes the value at the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	388 * If the queue is empty, the function will return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	389 * Note that this function does not return the value popped, but
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	390 * an error flag. If you need the value, you must call Front()
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	391 * to retrieve the value before popping it.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	392 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	393 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	394 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	395 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	396 * @see CircularQueueVoid_Front
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	397 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	398 unsigned int CircularQueueVoid_PopFront(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	399
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	400 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	401 * This removes the value at the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	402 * If the queue is empty, the function will return 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	403 * Note that this function does not return the value popped, but
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	404 * an error flag. If you need the value, you must call Back()
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	405 * to retrieve the value before popping it.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	406 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	407 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	408 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	409 * @return Returns 1 on success, or 0 on failure.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	410 * @see CircularQueueVoid_Back
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	411 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	412 unsigned int CircularQueueVoid_PopBack(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	413
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	414 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	415 * This gets the value at the front of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	416 * If the queue is empty, the value returned will be 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	417 * Because this 0 return value is ambiguous because it could also could
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	418 * be a legitimate value in the queue, if you need more robust error
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	419 * checking for if the queue is empty, you should get the size of the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	420 * queue using the Size() function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	421 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	422 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	423 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	424 * @return Returns the value stored at the queue or 0 if the queue is empty
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	425 * (or if there is an error).
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	426 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	427 * @see CircularQueueVoid_Size
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	428 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	429 void* CircularQueueVoid_Front(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	430
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	431 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	432 * This gets the value at the back of the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	433 * If the queue is empty, the value returned will be 0.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	434 * Because this 0 return value is ambiguous because it could also could
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	435 * be a legitimate value in the queue, if you need more robust error
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	436 * checking for if the queue is empty, you should get the size of the
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	437 * queue using the Size() function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	438 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	439 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	440 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	441 * @return Returns the value stored at the queue or 0 if the queue is empty
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	442 * (or 0 if there is an error).
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	443 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	444 * @see CircularQueueVoid_Size
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	445 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	446 void* CircularQueueVoid_Back(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	447
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	448 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	449 * This gets the current number of entries that are in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	450 * This is number is not to be confused with the MaxSize.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	451 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	452 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	453 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	454 * @return Returns the number of entries currently in queue, or 0 if
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	455 * there is an error.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	456 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	457 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	458 unsigned int CircularQueueVoid_Size(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	459
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	460 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	461 * This gets the maximum number of entries that are allowed in the queue at
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	462 * a given time.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	463 * This is the number that you used in the CreateQueue function.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	464 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	465 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	466 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	467 * @return Returns the maximum number of entries allowed in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	468 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	469 unsigned int CircularQueueVoid_MaxSize(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	470 /**
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	471 * This empties the entire queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	472 * This will remove all entries that are in the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	473 * This does not destroy any memory. Use FreeQueue() to actually destroy
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	474 * the queue.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	475 *
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	476 * @param queue The pointer to the CircularQueue instance.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	477 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	478 void CircularQueueVoid_Clear(CircularQueueVoid* queue);
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	479
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	480 /**
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	481 * This is a debugging function that will print all the addresses
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	482 * of elements in the queue to stderr.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	483 * This function is provided as convenience, but should not be considered
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	484 * as part of the standard API. Treat this function as deprecated
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	485 * as it's implementation may change or be removed entirely.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	486 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	487 * @param queue The pointer to the CircularQueue instance.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	488 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	489 void CircularQueueVoid_Print(CircularQueueVoid* queue);
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	490
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	491 /**
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	492 * This returns the element located at the specified index,
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	493 * where index=0 represents the head/front of the queue.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	494 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	495 * @param queue The pointer to the CircularQueue instance.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	496 * @param the_index The index of the element you want where 0 represents the
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	497 * head/front of the queue and Size-1 is the back.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	498 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	499 * @return Returns the element located at the index on success, or NULL on failure.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	500 * Be careful to not to confuse an error for a legitmate NULL value.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	501 * Any index from 0 to Size-1 (where Size>0) will be a valid index.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	502 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	503 * This example traverses through the whole queue and prints out each value.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	504 * @code
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	505 * fprintf(stderr, "Queue: ");
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	506 * for(i=0;i<CircularQueueVoid_ValueAtIndex(xValueQueue);i++)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	507 * {
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	508 * void* ret_val = CircularQueueUnsignedInt_ValueAtIndex(xValueQueue, i);
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	509 * fprintf(stderr, "%x ", ret_val);
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	510 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	511 * }
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	512 * fprintf(stderr, "\n");
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	513 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	514 * @note The implementation uses a modulo operation to compute the index, so
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	515 * this may not be the speediest operation in a tight loop.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	516 * This implementation was not optimized for random access, though it still
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	517 * is technically O(1).
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	518 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	519 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	520 void* CircularQueueVoid_ValueAtIndex(CircularQueueVoid* queue, unsigned int the_index);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	521
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	522
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	523
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	524
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	525 /* Ends C function definitions when using C++ */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	526 #ifdef __cplusplus
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	527 }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	528 #endif
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	529
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	530
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	531
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	532 #endif /* C_CIRCULAR_QUEUE_H */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	533

Mercurial > almixer_isolated

annotate CircularQueue.h @ 5:8cb13d89451a