Lab46 Wiki

User Tools

Site Tools

You are here: start » haas » summer2015 » data » projects » dln0
haas:summer2015:data:projects:dln0

Differences

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

Link to this comparison view

Next revision		Previous revision
haas:summer2015:data:projects:dln0 [2015/05/29 15:16] – created wedgehaas:summer2015:data:projects:dln0 [2015/06/21 20:51] (current) – [node operation status codes] wedge
Line 16: Line 16:
 In this project, we take our first opportunity to undergo a complete code re-write of node functionality, and we will also introduce the necessary functionality for doubly linked node operations. In this project, we take our first opportunity to undergo a complete code re-write of node functionality, and we will also introduce the necessary functionality for doubly linked node operations.
  
-=====Procedure to Obtain dln0=====+=====Procedure to obtain dln0=====
 As this is a rewrite, dln0 is not based on any of the code you have written up to this point. As such, the transition process is slightly different: As this is a rewrite, dln0 is not based on any of the code you have written up to this point. As such, the transition process is slightly different:
  
 <cli> <cli>
-lab46:~/src/data/sll3$ make get-dln0+lab46:~/src/data/sll4$ make get-dln0
 ... ...
 </cli> </cli>
Line 39: Line 39:
  
 #include <stdlib.h> #include <stdlib.h>
 +#include "data.h"
  
 +// node struct
 +//
 struct node { struct node {
         char         value;         char         value;
Line 45: Line 48:
         struct node *prior;         struct node *prior;
 }; };
-typedef struct node Node; 
  
-Node *mknode(char  );     // allocate new node containing value +// function prototypes 
-Node *cpnode(Node *);     // duplicate node +// 
-Node *rmnode(Node *);     // deallocate node+code_t  mknode(Node **, char  );       // allocate new node containing value 
 +code_t  cpnode(Node *,  Node **);      // duplicate node 
 +code_t  rmnode(Node **);               // deallocate node
  
 #endif #endif
Line 58: Line 62:
 The node info element has been renamed to "value", just to make sure you understand what is going on code-wise. The node info element has been renamed to "value", just to make sure you understand what is going on code-wise.
  
-====In inc/list.h====+====In inc/data.h==== 
 +You'll notice that node.h includes a file called data.h; This header will contain predominantly useful #define statements, typedefs, and support function prototypes to make our lives easier. It will see additional content added with future projects.
  
 <code c 1> <code c 1>
-#ifndef _LIST_H +#ifndef _DATA_H 
-#define _LIST_H+#define _DATA_H
  
-#include "node.h"                       // list relies on node to work+// custom types (mostly for shortening typing) 
 +// 
 +typedef struct node            Node;   // because we deserve nice things 
 +typedef unsigned long long int code_t; // status code data type 
 +typedef unsigned long long int ulli; 
 +typedef   signed long long int slli;
  
-#define  DLL_SUCCESS            0 +// Status codes for the doubly linked node implementation 
-#define  DLL_MALLOC_FAIL        1 +// 
-#define  DLL_ALREADY_ALLOC      2 +#define  DLN_SUCCESS         1    // 0x01, 0001, 00000001 
-#define  DLL_NULL               4 +#define  DLN_MALLOC_FAIL     2    // 0x02, 0002, 00000010 
-#define  DLL_EMPTY              8 +#define  DLN_ALREADY_ALLOC   4    // 0x04, 0004, 00000100 
-#define  DLL_DEFAULT_FAIL       64 +#define  DLN_NULL            8    // 0x08, 0010, 00001000 
-#define  DLL_FAIL               128+#define  DLN_ERROR           16   // 0x10, 0020, 00010000 
 +#define  DLN_DEFAULT_FAIL    32   // 0x20, 0040, 00100000 
 +#define  DLN_INVALID         64   // 0x40, 0100, 01000000 
 +#define  DLN_RESERVED_CODE   128  // 0x80, 0200, 10000000
  
-struct list { +// Function prototypes 
-    Node              *first;           // pointer to start of list +// 
-    Node              *last;            // pointer to end of list +void lscodes(code_t);
-}; +
-typedef struct list    List;            // because we deserve nice things +
- +
-int mklist (List **);                   // create/allocate new list struct +
-int cplist (List *,  List **);          // duplicate list contents  +
- +
-int insert (List **, Node *, Node *);   // add node before given node +
-int append (List **, Node *, Node *);   // add node after given node +
- +
-int display(List *,  int);              // display list from start to end +
-int find   (List *,  int,    Node **);  // locate node containing value+
  
 #endif #endif
 </code> </code>
  
-The following changes have taken place: +====node operation status codes==== 
- +You'll notice the presence of a set of #define's in the data.h header file. These are intended to be used to report on various states of node status after performing various operations.
-  * **qty** has been removed from the list +
-  * **getpos()**/**setpos()** are no longer present. In many ways their functionality is no longer needed with the doubly-linked nature of the list. +
-  * **searchlist()** has been renamed to **find()** (aesthetic change, to keep function names at 8 characters or less, and now supports resuming (finding additional matches). +
-  * **displayf()/displayb()** are gone, and previous functionality will be merged into one universal **display()** function.  +
- +
-There is now a set of status/error codes that will be utilized as list function return values, so we can better report particular failures. +
- +
-====list operation status codes==== +
-You'll notice the presence of a set of #define's in the list header file. These are intended to be used to report on various states of list status after performing various operations.+
  
 They are not exclusive- in some cases, multiple states can be applied. The intent is that you will OR together all pertinent states and return that from the function. They are not exclusive- in some cases, multiple states can be applied. The intent is that you will OR together all pertinent states and return that from the function.
  
-  * **DLL_SUCCESS** - everything went according to plan, no errors encountered, average case +  * **DLN_SUCCESS** - everything went according to plan, no errors encountered, average case 
-  * **DLL_MALLOC_FAIL** - memory allocation failed (considered in error) +  * **DLN_MALLOC_FAIL** - memory allocation failed (considered in error) 
-  * **DLL_ALREADY_ALLOC** - memory has already been allocated (considered in error) +  * **DLN_ALREADY_ALLOC** - memory has already been allocated (considered in error) 
-  * **DLL_NULL** - result is NULL (probably in error) +  * **DLN_NULL** - result is NULL (probably in error) 
-  * **DLL_EMPTY** - result is an empty list (may or may not be in error) +  * **DLN_DEFAULT_FAIL** - default state of unimplemented functions (default error) 
-  * **DLL_DEFAULT_FAIL** - default state of unimplemented functions (default error) +  * **DLN_ERROR** - some error occurred 
-  * **DLL_FAIL** - some error occurred+  * **DLN_INVALID** - invalid use (NULL pointer) 
 +  * **DLN_RESERVED_CODE** - reserved for future use (not used at present time)
  
-For example, in the case of "DLL_MALLOC_FAIL", there are actually a total of three states raised: +For example, in the case of "DLN_MALLOC_FAIL", there are actually a total of three states raised: 
-  * DLL_FAIL (a problem has occurred) +  * DLN_ERROR (a problem has occurred) 
-  * DLL_MALLOC_FAIL (a problem has occurred when using malloc()) +  * DLN_MALLOC_FAIL (a problem has occurred when using malloc()) 
-  * DLL_NULL (no memory allocated, so list cannot be anything but NULL)+  * DLN_NULL (no memory allocated, so node cannot be anything but NULL)
  
 ALL THREE states must be returned from the function in question should such an occurrence take place. ALL THREE states must be returned from the function in question should such an occurrence take place.
-====list library====+ 
 +You'll notice these #defines map to numeric values, and particular ones at that. This is to our supreme advantage: if you understand how numbers work, you should have an easy time of working with these status codes. 
 +====node library====
 In **src/node/**, you will find skeletons of what was previously there, ready for you to re-implement. In **src/node/**, you will find skeletons of what was previously there, ready for you to re-implement.
- 
-In **src/list/**, you will find the same- 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. Figure out what is going on, the connections, and make sure you understand it.
Line 129: Line 123:
 Be sure to focus on implementing the functionality from scratch (the more you do this from scratch, vs. referencing old code, the more it will help you). Be sure to focus on implementing the functionality from scratch (the more you do this from scratch, vs. referencing old code, the more it will help you).
  
-====List library unit tests==== 
-In **unit/list/**, you will find these new files: 
- 
-  * **unit-mklist.c** - unit test for **mklist()** library function 
-  * **unit-cplist.c** - unit test for **cplist()** library function 
-  * **unit-append.c** - unit test for **append()** library function 
-  * **unit-insert.c** - unit test for **insert()** library function 
-  * **unit-find.c** - unit test for **find()** library function 
-  * **unit-display.c** - unit test for **display()** library function 
- 
-Enhancements to these unit tests may be provided via dll0 project updates. 
- 
-There are also corresponding **verify-FUNCTION.sh** scripts that will output a "MATCH"/"MISMATCH" to confirm overall conformance with the pertinent list functionality. 
- 
-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). 
- 
-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===== =====Expected Results=====
Line 164: Line 131:
  
 <cli> <cli>
-lab46:~/src/data/dll0$ bin/verify-node.sh +lab46:~/src/data/dln0$ bin/verify-node.sh 
 ==================================================== ====================================================
 =    Verifying Doubly-Linked Node Functionality    = =    Verifying Doubly-Linked Node Functionality    =
 ==================================================== ====================================================
-  [mknode] Total:   5, Matches:   5, Mismatches:   0 + [mknode] Total:  12, Matches:  12, Mismatches:   0 
-  [cpnode] Total:   6, Matches:   6, Mismatches:   0 + [cpnode] Total:  15, Matches:  15, Mismatches:   0 
-  [rmnode] Total:   2, Matches:   2, Mismatches:   0+ [rmnode] Total:   4, Matches:   4, Mismatches:   0
 ==================================================== ====================================================
- [RESULTS] Total:  13, Matches:  13, Mismatches:   0+[RESULTS] Total:  31, Matches:  31, Mismatches:   0
 ==================================================== ====================================================
-lab46:~/src/data/dll0$ +lab46:~/src/data/dln0$ 
 </cli> </cli>
  
-====list library==== 
-Here is what you should get for list: 
- 
-<cli> 
-lab46:~/src/data/dll0$ bin/verify-list.sh  
-==================================================== 
-=    Verifying Doubly-Linked List Functionality    = 
-==================================================== 
-  [mklist] Total:  11, Matches:  11, Mismatches:   0 
-  [cplist] Total:  17, Matches:  17, Mismatches:   0 
-  [append] Total:  22, Matches:  22, Mismatches:   0 
-  [insert] Total:  22, Matches:  22, Mismatches:   0 
- [display] Total:  12, Matches:  12, Mismatches:   0 
-    [find] Total:  28, Matches:  28, Mismatches:   0 
-==================================================== 
- [RESULTS] Total: 112, Matches: 112, Mismatches:   0 
-==================================================== 
-lab46:~/src/data/dll0$  
-</cli> 
-=====Submission Criteria===== 
-To be successful in this project, the following criteria must be met: 
  
-  * Project must be submit on time, by the posted deadline. +=====Submission===== 
-    * Late submissions will lose 25% credit per day, with the submission window closing on the 4th day following the deadline. +{{page>haas:summer2015:common:submitblurb#DATA&noheader&nofooter}}
-  * 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 must be correct (i.e. the list visualization, where applicable) 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/summer2015/data/projects/dln0.1432912570.txt.gz · Last modified: 2015/05/29 15:16 by wedge

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