Differences

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

--- haas:spring2015:data:projects:sll3 [2015/03/06 14:41] – created wedge
+++ haas:spring2015:data:projects:sll3 [2015/03/30 16:26] (current) – [List library unit tests] wedge
@@ Line 11: / Line 11: @@
 This section will document any updates applied to the project since original release:
-  * __revision #__: <description> (DATESTRING)
+  * __revision 1__: unit tests for mkgroup, lgetpos, and lsetpos released (20150315)
+    * verify-group.sh updated with correct values
+    * all that remains now is lappend, linsert, and lobtain... hopefully before too long.
+  * __revision 2__: unit tests for lappend and linsert released (20150322)
+    * verify-group.sh updated with correct totals
+    * unit-lobtain and unit-rmgroup are still in need of completion; I'll be extending the deadline yet again to compensate for this (but I will be releasing the next project this week as originally planned).
+      * the issue is really one of distraction: I can really only crank out these unit tests when I have long interrupted moments to focus on it (it requires balancing many variables in my head at once)... but, I've been distracted because I've finally encouraged others in different classes to more regularly contact me with questions. I absolutely love it, but it has meant me slipping on delivering the unit tests in a timely fashion (I cannot wait for break to get caught up!)
+    * so, there will be at least one more revision, when it is ready, to bring in the lobtain and rmgroup unit tests (don't worry, dll0 will not depend on ANY of the code we've written so far).
+  * __revision 3__: unit-lsetpos wasn't actually completed (20150329)
+    * on one of the last tests, it was segfaulting. This has been FIXED.
+    * verify-group.sh updated with corrected unit-lsetpos test count.
+    * unit-lobtain and unit-rmgroup still to be finished.
+  * __revision 4__: unit-lobtain and unit-rmgroup released (20150330)
+    * unit-rmgroup was held up by a bug in my lobtain() implementation; once I discovered and fixed it, the unit test lit up and worked as expected.
+    * unit-lobtain, the long awaited final unit test of sll3, has been released. Now all unit tests for sll3 are available.
 =====Objective=====
-In this project, we complete the node transactions core of our singly-linked list implementation by exploring the remaining functions: **obtain()**, **clearlist()**, **rmlist()**, **swapnode()**, and **sortlist()**
+In this project, we take a step up from our singly linked list implementation- just as the singly-linked list was a step up from the individual nodes as an organizing unit for nodes.
+So what does this give us? An organizing unit for lists! I'm calling them "ListGroups" or "GroupOfLists", and we'll also sneak in true linked list functionality, by adding an "after" pointer to the List struct.
 =====Project Overview=====
-For this project, we're going to be implementing the following functions:
+====list.h====
+For this project, we need to make a couple modifications to the list struct (which you can also check out in **inc/list.h**):
 <code c>
-List *obtain (List *, Node **);         // obtain/disconnect node from list
+struct list {
-List *clearlist(List *);                // empty an existing list
+    Node              *first;           // pointer to start of list
-List *rmlist(List *);                   // deallocate list
+    Node              *last;            // pointer to end of list
-List *swapnode(List *, Node *, Node *); // swap positions of given nodes in list
+    struct list       *after;           // pointer to the next list
-List *sortlist(List *, int);            // sort list (according to mode)
+    unsigned long int  qty;             // number of nodes in list
+};
+typedef struct list    List;            // because we deserve nice things
 </code>
-====list library====
+Specifically, we have an after pointer, so that we can point to an entirely separate list, along with a newly added qty variable, which will keep track of the number of nodes in the list.
-In **src/list/**, you will find 5 new C files:
-  * **obtain.c**   - which will house the list obtain function (to disconnect nodes from a list)
+To implement **qty**, all list functions that perform manipulations to the list will need to see some updating (**insert()**, **append()**, **obtain()**, and **mklist()**).
-  * **clear.c**    - which will handle clearing (emptying) the list
-  * **rm.c**       - which will handle deallocating (purging) the list
-  * **swap.c**     - which will handle swapping two nodes within a list
-  * **sort.c**     - which will house the list sort function
-Take a look at the code there. These are the files that contain functions which will be compiled and archived into the node library (**liblist.a**) we will be using in this and future projects.
+**mklist()** should also set the list's **after** pointer to a sane initial state (NULL).
+====group.h====
+With the updated list struct (and supporting list functions), we can now organize our lists with this new groupoflists struct (typedef'ed to **Group** for typing convenience).
+<code c>
+#ifndef _GROUP_H
+#define _GROUP_H
+#include "list.h"                        // list relies on node to work
+struct groupoflists {
+    List *first;                         // pointer to first list
+    List *last;                          // pointer to last list
+};
+typedef struct groupoflists Group;       // because we deserve nice things
+Group *mkgroup(void);                    // create/allocate new Group
+Group *rmgroup(Group *);                 // clear/deallocate Group
+Group *linsert(Group *, List *, List *); // add list before given list
+Group *lappend(Group *, List *, List *); // add list after given list
+Group *lobtain(Group *, List **);        // obtain/disconnect list from group
+long int  ldisplay(Group *, long int);   // display entire/aspects of list group
+long int  lgetpos(Group *, List *);      // retrieve position from given node
+List     *lsetpos(Group *, long int);    // seek to indicated node in list
+#endif
+</code>
+You should notice a striking similarity to the core list functionality (a first and a last pointer-- only to Lists, and not Nodes), and the presence of Group manipulation and utility functions (appending, inserting, obtaining, displaying, getting/setting position, creating, and removing a group).
+This project will test the level of your abstraction skills-- for there isn't that much of a conceptual difference between the list functions and the group functions. The more you understand that, the easier this project will be.
+====group library====
+In **src/group/**, you will find 7 new C files:
+  * **obtain.c**   - which will house the group lobtain() function (to disconnect lists from a group)
+  * **pos.c**      - which will handle getting/setting list positions within the group
+  * **mk.c**       - which will handle creating (allocating) a new group struct
+  * **rm.c**       - which will handle deallocating (purging) the group
+  * **insert.c**   - which will handle inserting (linsert()) a new list into the group
+  * **append.c**   - which will house the group appending function **lappend()**
+  * **display.c**  - which will house the group display (**ldisplay()**) function.
+Take a look at the code there. These are the files that contain functions which will be compiled and archived into the group library (**libgroup.a**) we will be using in this and future projects.
 Figure out what is going on, make sure you understand it.
 ====List library unit tests====
-In **testing/list/unit/**, you will find these new files:
+In **testing/group/unit/**, you will find the unit tests and verify scripts for the functions to be implementated in the group library.
-  * **unit-obtain.c**     - unit test for **obtain()** library function
-  * **unit-clearlist.c**  - unit test for **clearlist()** library function
-  * **unit-rmlist.c**     - unit test for **rmlist()** library function
-  * **unit-swapnode.c**   - unit test for **swapnode()** library function
-  * **unit-sortlist.c**   - unit test for **sortlist()** library function
-These are complete runnable programs (when compiled, and linked against the list library, which is all handled for you by the **Makefile** system in place).
+These are complete runnable programs (when compiled, and linked against the group 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:
@@ Line 63: / Line 118: @@
     * ask questions to get clarification!
-====list testing applications====
-===palindrome===
-Now that we've completed our list functionality, we can use these individual functions to piece together solutions to various everyday problems where a list could be effective. After all, that's a big aspect to learning data structures- they open doors to new algorithms and problem solving capabilities.
-Our first endeavor will be that of palindromes (ie words/phrases that, when reversed, spell the same thing).
-This implementation will be considered an extra credit opportunity, so as to offer those who have fallen behind (but working to get caught up) a reprieve on some of the credit they've lost.
-It is also highly recommended to undertake as it will give you further experience working with these concepts.
 =====Expected Results=====
-To assist you in verifying a correct implementation, a fully working implementation of the node library and list library (up to this point) should resemble the following:
+To assist you in verifying a correct implementation, a fully working implementation of the node library, list library (with new modifications), and group library should resemble the following:
 ====node library====
@@ Line 81: / Line 126: @@
 <cli>
-lab46:~/src/data/sll2$ bin/verify-node.sh
+lab46:~/src/data/sll3$ bin/verify-node.sh
 ====================================================
 =    Verifying Singly-Linked Node Functionality    =
@@ Line 91: / Line 136: @@
 [RESULTS] Total:  11, Matches:  11, Mismatches:   0
 ====================================================
-lab46:~/src/data/sll2$
+lab46:~/src/data/sll3$
 </cli>
 ====list library====
-Here is what you should get for all the functions completed so far in the list library (sll0+sll1+sll2):
+Here is what you should get for all the functions completed so far in the list library (sll0+sll1+sll2+sll3):
 <cli>
-lab46:~/src/data/sll2$ bin/verify-list.sh
+lab46:~/src/data/sll3$ bin/verify-list.sh
 ======================================================
 =     Verifying Singly-Linked List Functionality     =
 ======================================================
-    [mklist] Total:   5, Matches:   5, Mismatches:   0
+    [mklist] Total:  21, Matches:  21, Mismatches:   0
-    [insert] Total:  11, Matches:  11, Mismatches:   0
+    [insert] Total:  21, Matches:  21, Mismatches:   0
   [displayf] Total:   4, Matches:   4, Mismatches:   0
     [getpos] Total:   8, Matches:   8, Mismatches:   0
     [setpos] Total:   9, Matches:   9, Mismatches:   0
-    [append] Total:  11, Matches:  11, Mismatches:   0
+    [append] Total:  21, Matches:  21, Mismatches:   0
 [searchlist] Total:  11, Matches:  11, Mismatches:   0
-    [cplist] Total:  11, Matches:  11, Mismatches:   0
+    [cplist] Total:  14, Matches:  14, Mismatches:   0
   [displayb] Total:   6, Matches:   6, Mismatches:   0
    [compare] Total:   9, Matches:   9, Mismatches:   0
-    [obtain] Total:  28, Matches:  28, Mismatches:   0
+    [obtain] Total:  44, Matches:  44, Mismatches:   0
  [clearlist] Total:   3, Matches:   3, Mismatches:   0
     [rmlist] Total:   3, Matches:   3, Mismatches:   0
@@ Line 118: / Line 163: @@
   [sortlist] Total:  27, Matches:  27, Mismatches:   0
 ======================================================
-   [RESULTS] Total: 155, Matches: 155, Mismatches:   0
+   [RESULTS] Total: 210, Matches: 210, Mismatches:   0
+======================================================
+lab46:~/src/data/sll3$
+</cli>
+====group library====
+Here is what you should get for all the functions completed in the group library:
+<cli>
+lab46:~/src/data/sll3$ bin/verify-group.sh
+======================================================
+=  Verifying Singly-Linked Group List Functionality  =
+======================================================
+   [mkgroup] Total:   5, Matches:   5, Mismatches:   0
+  [ldisplay] Total:  30, Matches:  30, Mismatches:   0
+   [lgetpos] Total:  14, Matches:  14, Mismatches:   0
+   [lsetpos] Total:  13, Matches:  13, Mismatches:   0
+   [lappend] Total:  20, Matches:  20, Mismatches:   0
+   [linsert] Total:  20, Matches:  20, Mismatches:   0
+   [lobtain] Total:  15, Matches:  15, Mismatches:   0
+   [rmgroup] Total:   3, Matches:   3, Mismatches:   0
+======================================================
+   [RESULTS] Total: 120, Matches: 120, Mismatches:   0
 ======================================================
-lab46:~/src/data/sll2$
+lab46:~/src/data/sll3$
 </cli>
 =====Submission Criteria=====

Lab46 Wiki

User Tools

Site Tools

Differences

Page Tools