Project: SLL3

This section will document any updates applied to the project since original release:

• 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.

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.

For this project, we need to make a couple modifications to the list struct (which you can also check out in inc/list.h):

struct list {
    Node              *first;           // pointer to start of list
    Node              *last;            // pointer to end of list
    struct list       *after;           // pointer to the next list
    unsigned long int  qty;             // number of nodes in list
};
typedef struct list    List;            // because we deserve nice things

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.

To implement qty, all list functions that perform manipulations to the list will need to see some updating (insert(), append(), obtain(), and mklist()).

mklist() should also set the list's after pointer to a sane initial state (NULL).

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).

#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

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.

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.

In testing/group/unit/, you will find the unit tests and verify scripts for the functions to be implementated in the group library.

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:

• 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!

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:

Here is what you should get for the node library:

lab46:~/src/data/sll3$ bin/verify-node.sh 
====================================================
=    Verifying Singly-Linked Node Functionality    =
====================================================
 [mknode] Total:   4, Matches:   4, Mismatches:   0
 [cpnode] Total:   5, Matches:   5, Mismatches:   0
 [rmnode] Total:   2, Matches:   2, Mismatches:   0
====================================================
[RESULTS] Total:  11, Matches:  11, Mismatches:   0
====================================================
lab46:~/src/data/sll3$ 

Here is what you should get for all the functions completed so far in the list library (sll0+sll1+sll2+sll3):

lab46:~/src/data/sll3$ bin/verify-list.sh 
======================================================
=     Verifying Singly-Linked List Functionality     =
======================================================
    [mklist] Total:  21, Matches:  21, 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:  21, Matches:  21, Mismatches:   0
[searchlist] 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:  44, Matches:  44, Mismatches:   0
 [clearlist] Total:   3, Matches:   3, Mismatches:   0
    [rmlist] Total:   3, Matches:   3, Mismatches:   0
  [swapnode] Total:   9, Matches:   9, Mismatches:   0
  [sortlist] Total:  27, Matches:  27, Mismatches:   0
======================================================
   [RESULTS] Total: 210, Matches: 210, Mismatches:   0
======================================================
lab46:~/src/data/sll3$ 

Here is what you should get for all the functions completed in the group library:

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/sll3$ 

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
• Any and all functions written must have, at most, 1 return statement
  • points will be lost for solutions containing multiple return statements in a function.
• 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.