Corning Community College CSCS2320 Data Structures ~~TOC~~ ======Project: DLQ0====== =====Errata===== This section will document any updates applied to the project since original release: * __revision 1__: typo in unit-dequeue (20150425) * lacking a leading '0x' on the status code (FIXED) * also, a few erroneous mentions of "Popping"; should say "Dequeueing" (FIXED) * __revision 2__: typo in unit-purge (20150427) * "should be:" lines were saying "NOT EMPTY" when they should say "EMPTY" (FIXED) * __revision 3__: typo in unit-dequeue (20150429) * unit-dequeue was dequeueing backwards (FIXED) =====Objective===== In this project, resume our conceptual journey and explore another data structure: queues. =====Background===== A **queue** is considered one of the most important data structures, along with **stack** (last week's project) and trees. And it is largely because of how often we find them playing out in nature or our day-to-day lives. The word "queue" is [[https://www.google.com/search?&q=define%3Aqueue&ie=utf-8&oe=utf-8|defined]] as: * (generically): a line or sequence of items awaiting their turn to be attended to or to proceed * (computing): a list of data items, commands, etc., stored so as to be retrievable in a definite order, usually the order of insertion ====Lists and Nodes==== So, how does all this list and node stuff play into our queue implementation? Well, like stacks, we're going to build the queue ON TOP OF lists (which are composed of nodes). Therefore, a queue is a data structure that stores its data in a list (which consists of nodes), and we apply various rules/restrictions on our access of that list data. The concept of restricting access is a very important one- which we did with our list as well (limiting our access to the list through the use of **append()**, **insert()**, and **obtain()** versus manipulating the next/prev pointers manually all the time). By limiting how we access the data, we give ourselves certain algorithmic advantages: * __error reduction__: if have a small set of operations that can do one thing, and do their one thing extremely well (**insert()**, **append()**, and **obtain()** again, for instance), we can then rely on them to do the low-level grunt work, freeing us up to accomplish higher level tasks (such as **sorting** or **swapping**), or even things like determining if a word is a **palindrome**, or just preserving order of items during storage. * __performance__: by restricting our available choices, the edge cases we have to check for are reduced, and in ideal situations, the average case moves closer to the best case. ====conceptualizing a queue==== It is common to think of a queue as a horizontal object, much like a line of people that need to be services (such as a checkout line at the grocery store, or a line at the bank). Although we've commonly viewed lists horizontally (from left to right), there is absolutely nothing requiring this positional orientation. Similarly, queues possess no mandatory orientation, but we do usually visualize them as horizontal entities, largely because that's how we commonly find ourselves entangled in this data structures in nature. ====the queue==== The queue data structure presents certain advantages that encourages its use in solving problems (why is the notion of forming lines important? What problems does that solve? How are resources more efficiently utilized by this act?), and we accomplish that by its compositional definition: * a queue has a **back** and a **front**, basically node pointers that constantly point to the back and front node in the queue (equivalent to the underlying list's start and end pointers-- you can decide which one you want to use for what location). * to put an item on the queue, we **enqueue** it (place it at the back of the queue). So one of the functions we'll be implementing is **enqueue()**, which will take the node we wish to place on the given queue, and enqueue will handle all the necessary coordination with its underlying list. * to get an item off of the queue, we **dequeue** it. In our **dequeue()** function, we grab the **front** node off the stack (this also translates into a set of list-level transactions that our **dequeue()** function will handle for us). These qualities cause the queue to be described as a FIFO (or LILO) structure: * **FIFO**: **F**irst **I**n **F**irst **O**ut * **LILO**: **L**ast **I**n **L**ast **O**ut And that describes what is conceptually going on-- if we can ONLY put our data on at one end (the back), and grab our data from the other (the front), the data most immediately available to us is that which we placed there first (hence the first one we pushed in would be the first one we get back when dequeueing it). This concept is very important, and being aware of it can be of significant strategic importance when going about solving problems (and seeing its pattern proliferate in nature). With that said, the existence of **front**, **back**, along with the core **enqueue()** and **dequeue()** functions defines the minimal necessary requiments to interface with a queue. Sometimes we'll see additional actions sneak in. While these may be commonly associated with queue, they should not be confused as core requiments of a queue: * **purge**: a way to quickly empty out a queue (evacuate its contents-- note this is partially similar in nature to what our **rmqueue()** function will do; only we won't take it the extra step of de-allocating and NULLifying the queue pointer). * this will be similar in nature to the list's **empty()** function, which properly clears a list to an empty state; only, **purge()** is operating at the queue level. While we may be implementing these supplemental functions, it should be noted that not only are they in no way necessary for using a queue, they could be detrimental, as one could rely on them as a crutch. Their inclusion should ONLY be viewed as a means of convenience (in certain scenarios they may result in less code needing to be written), but NOT as something you should routinely make use of. ====buffer size can matter==== With a queue, there sometimes exists a need to cap its total size (especially in applications on the computer, we may have only allocated a fixed amount of space and cannot exceed it). For this reason, we will need to maintain a count of nodes in the queue (ie the underlying list). For this reason, we continue to make use of the list's **qty** element. Additionally, the queue will have a configured maximum buffer- if the quantity of nodes in the list exceeds the configured buffer of the queue, we should prevent any additional enqueues. It should also be pointed out that in other applications, a queue need not have a maximum buffer size.. in which case it can theoretically grow an indefinite amount. We will explore both conditions (unbounded and bounded) in this project. ====queue error conditions==== There are two very important operational error conditions a queue can experience: * __buffer **over**run__: this is the situation where the quantity of the list is equal to the configured queue buffer, and we try to enqueue another node onto the queue. * __buffer **under**run__: this is the situation where the queue is empty, yet we still try to dequeue a value from it. =====Project Overview===== For this project, we're going to be implementing the queue data structure atop of our recently re-implemented linked list (the doubly linked list). ====In inc/data.h==== Building on the **data.h** header file introduced in dls0, a section of status codes has been added for queues: // Status codes for the queue implementation // #define DLQ_SUCCESS 256 #define DLQ_CREATE_FAIL 512 #define DLQ_NULL 1024 #define DLQ_EMPTY 2048 #define DLQ_OVERRUN 4096 #define DLQ_UNDERRUN 8192 #define DLQ_DEFAULT_FAIL 16384 #define DLQ_FAIL 32768 You may notice that they equate to the same numerical values as the stack; that is because, for the purposes of our stack and queue implementations, there will be no overlap in functionality (stacks won't be accessing queue operations, and queues will not be accessing stack operations). ====In inc/queue.h==== #ifndef _QUEUE_H #define _QUEUE_H #include "data.h" // helpful #defines #include "list.h" // queue relies on list to work // (which relies on node) struct queue { List *data; // pointer to list containing data Node *front; // pointer to node at front of queue Node *back; // pointer to node at back of queue uli buffer; // maximum queue size (0 is unbounded) }; typedef struct queue Queue; // because we deserve nice things code_t mkqueue(Queue **, uli ); // create new queue (of max size) code_t cpqueue(Queue *, Queue **); // create a copy of an existing queue code_t rmqueue(Queue ** ); // clear and de-allocate a queue code_t purge (Queue ** ); // clear and de-allocate an existing queue code_t enqueue(Queue **, Node * ); // add new node to the back of queue code_t dequeue(Queue **, Node ** ); // take off node at front of queue #endif For our queue implementation, we will continue to utilize the double pointer, in order to achieve passing parameters by address. This is necessary so that we can free up the return value of **enqueue()** and **dequeue()** to be used for status (ie look out for buffer overruns and underruns). Also, while nothing is stopping you from doing so, the idea here is that things like **buffer** and the underlying list **qty** in queue transactions will **NOT** be accessed outside of the **enqueue()** and **dequeue()** functions. Just like my warnings about using **qty** in your list solutions (save for **display()** when showing position values in a backwards orientation)-- do not consider **buffer** as a variable for your general use. In object-oriented programming, both **buffer** and **qty** would be **private** member variables of their respective classes, unable to be used by anything other than their respective member functions. ====queue library==== In **src/queue/**, you will find skeletons of the above prototyped functions, hollowed out in anticipation of being made operational. Figure out what is going on, the connections, and make sure you understand it. Again, your queue is to utilize the list for its underlying data storage operations. This is what the queue's **data** list pointer is to be used for. ====Reference Implementation==== As the layers and complexities rise, narrowing down the source of errors becomes increasingly important. If your stack push() isn't working, is it because of a problem in push()? Or might it be in an underlying list operation it relies upon? Or perhaps even the lowest-level node functions.. To aid you in your development efforts, you now have the ability to import a functioning node and list implementation into your project for the purposes of testing your stack functionality. This also provides another opportunity for those who have fallen behind to stay current, as they can work on this project without having needed to successfully get full list functionality. ===Using the test reference implementation=== You'll notice that, upon running **make help** in the base-level Makefile, the following new options appear (about halfway in the middle): ** ** ** make use-test-reference - use working implementation object files ** ** make use-your-own-code - use your node/list implementation code ** ** ** In order to make use of it, you'll need to run **make use-test-reference** from the base of your **dlq0** project directory, as follows: lab46:~/src/data/dlq0$ make use-test-reference ... NODE and LIST reference implementation in place, run 'make' to build everything. lab46:~/src/data/dlq0$ You'll see that final message indicating everything is in place (it automatically runs a **make clean** for you), and then you can go ahead and build everything with it: lab46:~/src/data/dlq0$ make ... **__Debugging__:** When using the test reference implementation, you will not be able to debug the contents of the node and list functions (the files provided do not have debugging symbols added), so you'll need to take care not to step into these functions (it would be just like stepping into **printf()**. You can still compile the project with debugging support and debug (as usual) those compiled functions (ie the stack functions). ===Reverting back to using your code=== If you were trying out the reference implementation to verify queue functionality, and wanted to revert back to your own code, it is as simple as: lab46:~/src/data/dlq0$ make use-your-own-code Local node/list implementation restored, run 'make clean; make' to build everything. lab46:~/src/data/dlq0$ ====Queue library unit tests==== In **testing/queue/unit/**, you will find these files: * **unit-mkqueue.c** - unit test for **mkqueue()** library function * **unit-cpqueue.c** - unit test for **cpqueue()** library function * **unit-rmqueue.c** - unit test for **rmqueue()** library function * **unit-enqueue.c** - unit test for **enqueue()** library function * **unit-dequeue.c** - unit test for **dequeue()** library function * **unit-purge.c** - unit test for **purge()** library function There are also corresponding **verify-FUNCTION.sh** scripts that will output a "MATCH"/"MISMATCH" to confirm overall conformance with the pertinent stack functionality. These are complete runnable programs (when compiled, and linked against the queue library, which is all handled for you by the **Makefile** system in place). Of particular importance, I want you to take a close look at: * the source code to each of these unit tests * the purpose of these programs is to validate the correct functionality of the respective library functions * follow the logic * make sure you understand what is going on * ask questions to get clarification! * the output from these programs once compiled and ran * analyze the output * make sure you understand what is going on * ask questions to get clarification! =====Expected Results===== To assist you in verifying a correct implementation, a fully working implementation of the queue library should resemble the following (when running the respective verify script): ====queue library==== Here is what you should get for queue: lab46:~/src/data/dlq0$ bin/verify-queue.sh coming soon... lab46:~/src/data/dlq0$ =====Submission Criteria===== To be successful in this project, the following criteria must be met: * Project must be submit on time, by the posted deadline. * Late submissions will lose 25% credit per day, with the submission window closing on the 4th day following the deadline. * All code must compile cleanly (no warnings or errors) * all requested functions must be implemented in the related library * all requested functionality must conform to stated requirements (either on this project page or in comment banner in source code files themselves). * Executed programs must display in a manner similar to provided output * output formatted, where applicable, must match that of project requirements * Processing must be correct based on input given and output requested * Output, if applicable, must be correct based on values input * Code must be nicely and consistently indented (you may use the **indent** tool) * Code must be commented * Any "to be implemented" comments **MUST** be removed * these "to be implemented" comments, if still present at evaluation time, will result in points being deducted. * Sufficient comments explaining the point of provided logic **MUST** be present * Track/version the source code in a repository * Submit a copy of your source code to me using the **submit** tool (**make submit** will do this) by the deadline.