Lab46 Wiki

User Tools

Site Tools

You are here: start » haas » fall2015 » data » projects » dlq0
haas:fall2015:data:projects:dlq0

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
haas:fall2015:data:projects:dlq0 [2015/04/29 18:48] – external edit 127.0.0.1haas:fall2015:data:projects:dlq0 [2015/11/16 14:10] (current) – [Queue library unit tests] wedge
Line 11: Line 11:
 This section will document any updates applied to the project since original release: This section will document any updates applied to the project since original release:
  
-  * __revision 1__: typo in unit-dequeue (20150425) +  * __revision #__: <description> (DATESTRING)
-    * 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===== =====Objective=====
Line 24: Line 17:
  
 =====Background===== =====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.+A **queue** is considered one of the most important data structures, along with **stack** (last week's project), trees, and hash tables. And it is largely because of how often we find them playing out in nature or in 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:+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   * (generically): a line or sequence of items awaiting their turn to be attended to or to proceed
Line 37: Line 30:
 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. 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:+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 after/prior 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.   * __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.
Line 47: Line 40:
 Although we've commonly viewed lists horizontally (from left to right), there is absolutely nothing requiring this positional orientation. 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.+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 structure in nature.
  
 ====the queue==== ====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: 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).+  * 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 last and first pointers, respectively).
   * 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 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).+  * to get an item off of the queue, we **dequeue** it. In our **dequeue()** function, we grab the **front** node off the queue (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: These qualities cause the queue to be described as a FIFO (or LILO) structure:
Line 60: Line 53:
   * **LILO**: **L**ast **I**n **L**ast **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).+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 enqueued would be the first one we get back when we dequeue 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). 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:+With that said, the existence of **front**, **back**, along with the core **enqueue()** and **dequeue()** functions defines the minimal necessary requirements 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 requirements 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).   * **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).
Line 72: Line 65:
  
 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. 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==== ====buffer size can matter====
  
Line 94: Line 88:
  
 <code c> <code c>
-// Status codes for the queue implementation+//////////////////////////////////////////////////////////////////////
 // //
-#define  DLQ_SUCCESS        256 +// Status codes for the doubly linked queue implementation 
-#define  DLQ_CREATE_FAIL    512 +// 
-#define  DLQ_NULL           1024 +#define  DLQ_SUCCESS         0x0000000100000000 
-#define  DLQ_EMPTY          2048 +#define  DLQ_CREATE_FAIL     0x0000000200000000 
-#define  DLQ_OVERRUN        4096 +#define  DLQ_NULL            0x0000000400000000 
-#define  DLQ_UNDERRUN       8192 +#define  DLQ_EMPTY           0x0000000800000000         
-#define  DLQ_DEFAULT_FAIL   16384 +#define  DLQ_OVERRUN         0x0000001000000000         
-#define  DLQ_FAIL           32768+#define  DLQ_UNDERRUN        0x0000002000000000         
 +#define  DLQ_ERROR           0x0000004000000000 
 +#define  DLQ_INVALID         0x0000008000000000 
 +#define  DLQ_DEFAULT_FAIL    0x0000000000808000
 </code> </code>
- 
-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==== ====In inc/queue.h====
Line 114: Line 109:
 #define _QUEUE_H #define _QUEUE_H
  
-#include "data.h"                   // helpful #defines +////////////////////////////////////////////////////////////////////// 
-#include "list.h"                   // queue relies on list to work +// 
-                                    // (which relies on node)+// Queue relies on list (which relies on node) to work. 
 +// 
 +#include "list.h" 
 + 
 +////////////////////////////////////////////////////////////////////// 
 +// 
 +// Define the queue struct 
 +//
 struct queue { struct queue {
-    List *data;                     // pointer to list containing data +    Node *front;                       // pointer to front of queue 
-    Node *front;                    // pointer to node at front of queue +    Node *back;                        // pointer to back of queue 
-    Node *back;                     // pointer to node at back of queue +    List *data;                        // pointer to queue data 
-    uli   buffer;                   // maximum queue size (0 is unbounded)+    ulli  buffer;                      // queue length (0- unbounded)
 }; };
-typedef struct queue Queue;         // because we deserve nice things 
  
-code_t mkqueue(Queue **, uli     ); // create new queue (of max size) +code_t    mkqueue(Queue **, ulli    ); // create new queue (of length) 
-code_t cpqueue(Queue  *, Queue **); // create a copy of an existing queue +code_t    cpqueue(Queue  *, Queue **); // create a copy of a queue 
-code_t rmqueue(Queue **          ); // clear and de-allocate a queue+code_t    rmqueue(Queue **          ); // de-allocate a queue
  
-code_t purge  (Queue **          ); // clear and de-allocate an existing queue+code_t    purge  (Queue **          ); // clear an existing queue
  
-code_t enqueue(Queue **, Node  * ); // add new node to the back of queue +code_t    enqueue(Queue **, Node  * ); // add node to back of queue 
-code_t dequeue(Queue **, Node ** ); // take off node at front of queue+code_t    dequeue(Queue **, Node ** ); // grab node at front of queue
  
 #endif #endif
 </code> </code>
  
-For our queue implementation, we will continue to utilize the double pointer, in order to achieve passing parameters by address.+For our queue implementation, we will continue to utilize the double pointer, in order to practice 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).+This is necessary so that we can free up the return value of **enqueue()** and **dequeue()** to be used for status codes (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.  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. 
Line 151: Line 152:
  
 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. 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): 
- 
-<cli> 
-**                                                                    ** 
-** make use-test-reference  - use working implementation object files ** 
-** make use-your-own-code   - use your node/list implementation code  ** 
-**                                                                    ** 
-</cli> 
- 
-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: 
- 
-<cli> 
-lab46:~/src/data/dlq0$ make use-test-reference 
-... 
-NODE and LIST reference implementation in place, run 'make' to build everything. 
-lab46:~/src/data/dlq0$  
-</cli> 
- 
-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: 
- 
-<cli> 
-lab46:~/src/data/dlq0$ make 
-... 
-</cli> 
- 
-**__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: 
- 
-<cli> 
-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$  
-</cli> 
  
 ====Queue library unit tests==== ====Queue library unit tests====
-In **testing/queue/unit/**, you will find these files:+In **unit/queue/**, you will find these files:
  
   * **unit-mkqueue.c** - unit test for **mkqueue()** library function   * **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-enqueue.c** - unit test for **enqueue()** library function
   * **unit-dequeue.c** - unit test for **dequeue()** library function   * **unit-dequeue.c** - unit test for **dequeue()** library function
 +  * **unit-cpqueue.c** - unit test for **cpqueue()** library function
 +  * **unit-rmqueue.c** - unit test for **rmqueue()** library function
   * **unit-purge.c**   - unit test for **purge()** 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.+There are also corresponding **verify-FUNCTION.sh** scripts that will output a "MATCH"/"MISMATCH" to confirm overall conformance with the pertinent queue 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). 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).
Line 223: Line 178:
     * make sure you understand what is going on     * make sure you understand what is going on
     * ask questions to get clarification!     * ask questions to get clarification!
- 
  
 =====Expected Results===== =====Expected Results=====
Line 234: Line 188:
  
 <cli> <cli>
-lab46:~/src/data/dlq0$ bin/verify-queue.sh  +lab46:~/src/data/dlq0$ make check 
-coming soon...+====================================================== 
 +=    Verifying Doubly-Linked Queue Functionality     = 
 +====================================================== 
 +   [mkqueue] Total:   6, Matches:   6, Mismatches:   0 
 +   [enqueue] Total:  18, Matches:  18, Mismatches:   0 
 +   [dequeue] Total:  19, Matches:  19, Mismatches:   0 
 +   [cpqueue] Total:  17, Matches:  17, Mismatches:   0 
 +     [purge] Total:   7, Matches:   7, Mismatches:   0 
 +   [rmqueue] Total:  10, Matches:  10, Mismatches:   0 
 +====================================================== 
 +   [RESULTS] Total:  77, Matches:  77, Mismatches:   0 
 +======================================================
 lab46:~/src/data/dlq0$  lab46:~/src/data/dlq0$ 
 </cli> </cli>
  
-=====Submission Criteria===== +=====Submission===== 
-To be successful in this project, the following criteria must be met: +{{page>haas:fall2015:common:submitblurb#DATA&noheader&nofooter}}
- +
-  * 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.+
  
haas/fall2015/data/projects/dlq0.1430333298.txt.gz · Last modified: 2015/11/16 14:08 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki