Lab46 Wiki

User Tools

Site Tools

You are here: start » haas » fall2022 » data » projects » dll0
haas:fall2022:data:projects:dll0

Differences

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

Link to this comparison view

Next revision		Previous revision
haas:fall2022:data:projects:dll0 [2018/10/15 14:39] – created - external edit 127.0.0.1haas:fall2022:data:projects:dll0 [2022/10/15 12:12] (current) – [OBJECTIVE] wedge
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======Project: DLL0======+======PROJECT: Lists - Doubly-Linked Lists of Nodes (DLL0)======
  
-=====Errata===== +=====OBJECTIVE===== 
-This section will document any updates applied to the project since original release:+To continue our journey on doubly-linked data structures, and collaboratively authoring and documenting the project and its specifications.
  
-  * __revision #__: <description> (DATESTAMP)+=====OVERVIEW===== 
 +We continue now delving into the realm of doubly-linked data structures. And we will start by reimplementing some of the same base data structures (specifically, nodes and lists), this project: we start on doubly-linked lists.
  
-=====Objective===== +=====UPGRADING===== 
-In this project, we continue our doubly-linked code re-write, this time focusing on the linked list. +To assist with consistency across all implementations, project files for use with this project, along with the integration of the work you did on the last project, is made possible via a special recipe in the Makefile. 
-=====Procedure to obtain dll0===== + 
-As dll0 utilizes the code generated in dln0, transitioning to this project is merely a matter of upgrading:+Simply go into the project base directory, and run:
  
 <cli> <cli>
-lab46:~/src/data/dln0$ make upgrade-dll0 +lab46:~/src/SEMESTER/DESIG/prevPROJECT$ make upgrade-dll0
-...+
 </cli> </cli>
  
-When you upgrade, your existing code is copied over, because the next project builds upon what you did previously.+=====EDIT===== 
 +You will want to go [[/notes/data/fall2022/projects/dll0|here]] to edit and fill in the various sections of the document:
  
-Once you run "**make upgrade-dll0**" you should have a **dll0** directory that you can access and commence working on just as you have with the other project directories. +  * [[/notes/data/fall2022/projects/dll0|https://lab46.g7n.org/notes/data/fall2022/projects/dll0]]
-=====Project Overview=====+
  
-For this project, we're going to be re-implementing MOST of the previous node and list functions. There have been a few changes, namely:+{{page>notes:data:fall2022:projects:dll0&nouser&nodate&nomdate}}
  
 +=====SUBMISSION=====
 +To be successful in this project, the following criteria (or their equivalent) must be met:
  
-====In inc/list.h====+  * Project must be submit on time, by the deadline. 
 +    * Late submissions will lose 33%  credit per day, with the submission window closing on the 3rd day following the deadline. 
 +  * All code must compile cleanly (no warnings or errors) 
 +    * Compile with the **-Wall** and **--std=gnu18** compiler flags 
 +    * all  requested functionality  must conform  to stated  requirements (either on  this document or  in a 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 
 +  * Code must be consistently written, to strive for readability from having a consistent style throughout 
 +  * 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 
 +  * No global variables (without instructor approval), no goto statements, no calling of main()! 
 +  * Track/version the source code in your lab46 semester repository 
 +  * Submit  a copy of  your source code to  me using the  **submit** tool (**make submit** on lab46 will do this) by the deadline.
  
-<code c 1> +====Submit Tool Usage==== 
-#ifndef _LIST_H +Let's  say you  have completed  work  on the  project, and  are ready  to 
-#define _LIST_H+submit, you  would do the following:
  
-#include "node.h"                          // list relies on node to work+<cli> 
 +lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit 
 +</cli>
  
-struct list { +You should get some sort of confirmation indicating successful submission 
-    Node              *lead;               // pointer to start of list +if all went according to plan. If  not, check for typos and or locational 
-    Node              *last;               // pointer to end of list +mismatches.
-};+
  
-code_t  mklist (List **);                  // create new list struct +=====RUBRIC===== 
-code_t  cplist (List  *, List **);         // duplicate list contents+I'll be evaluating the project based on the following criteria:
  
-code_t  insert (List **, Node *, Node  *); // add node before given node +<code> 
-code_t  append (List **, Node *, Node  *); // add node after given node +78:dll0:final tally of results (78/78) 
- +*:dll0:obtained project by the Sunday prior to duedate [13/13] 
-code_t  display(List  *, int);             // display list start to end +*:dll0:clean compile, no compiler messages [13/13] 
-code_t  find   (List  *, char,   Node **); // locate node with value +*:dll0:implementation passes unit tests [13/13] 
- +*:dll0:adequate modifications to code from template [13/13] 
-#endif+*:dll0:program operations conform to project specifications [13/13] 
 +*:dll0:code tracked in lab46 semester repo [13/13]
 </code> </code>
  
-The following changes have taken place from the singly-linked list implementation:+===Pertaining to the collaborative authoring of project documentation===
  
-  * **qty** has been removed from the list (NO COUNTING!) +  * each class member is to participate in the contribution of relevant information and formatting of the documentation 
-  * **getpos()**/**setpos()** are no longer present. In many ways their functionality is no longer needed with the doubly-linked nature of the list (DO **NOT** RECREATE THEM NOR THEIR FUNCTIONALITY!) +    * minimal member contributions consist of: 
-  * **searchlist()** has been renamed to **find()** (aesthetic change, to keep function names at 8 characters or less, and now supports resuming (finding additional matches). +      * near the class average edits (a value of at least four productive edits) 
-  * **displayf()/displayb()** are gone, and previous functionality will be merged into one universal **display()** function. +      * near the average class content change average (a value of at least 256 bytes (absolute value of data content change)) 
 +      * near the class content contribution average (a value of at least 1kiB) 
 +      * no adding in one commit then later removing in its entirety for the sake of satisfying edit requirements 
 +    * adding and formatting data in an organized fashion, aiming to create an informative and readable document that anyone in the class can reference 
 +    * content contributions will be factored into a documentation coefficient, a value multiplied against your actual project submission to influence the end result: 
 +      * no contributions, co-efficient is 0.50 
 +      * less than minimum contributions is 0.75 
 +      * met minimum contribution threshold is 1.00
  
-Just as with the doubly-linked node, there are now a set of status/error codes that will be utilized as list function return values, so we can better report particular failures. +===Additionally===
-====In inc/data.h==== +
-In addition to what was there previously, we see the following:+
  
-<code c 1> +  * Solutions not abiding  by spirit of project will be  subject to a 50% overall deduction 
-////////////////////////////////////////////////////////////////////// +  * Solutions  not  utilizing descriptive  why and  how comments  will be subject to a 25% overall deduction 
-// +  * Solutions not utilizing indentation to promote scope and clarity or otherwise maintaining consistency in code style and presentation will be subject to a 25% overall deduction 
-// Status codes for the doubly linked list implementation +  * Solutions not organized and easy to  read (assume a terminal at least 90 characters wide, 40 characters tall)  are subject to a 25% overall deduction
-// +
-#define  DLL_SUCCESS         0x0000000000010000 +
-#define  DLL_MALLOC_FAIL     0x0000000000020000 +
-#define  DLL_ALREADY_ALLOC   0x0000000000040000 +
-#define  DLL_NULL            0x0000000000080000 +
-#define  DLL_ERROR           0x0000000000100000 +
-#define  DLL_EMPTY           0x0000000000200000 +
-#define  DLL_INVALID         0x0000000000400000 +
-#define  DLL_DEFAULT_FAIL    0x0000000000800000 +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// Options for list display() and support catlist() functions +
-// +
-#define  DISPLAY_FORWARD     000 +
-#define  DISPLAY_NOPOSVALS   000 +
-#define  DISPLAY_POSVALS     001 +
-#define  DISPLAY_BACKWARD    002 +
-</code> +
- +
-Similar in many ways to the doubly-linked node status codes, we see a new possibility: EMPTY. This is the state of a list existing but having no nodes associated with it (which you should already be familiar with). Whenever this state exists, that status code MUST be set in the respective function being called (i.e. the list as a result of the function processing leaves us with an empty list). +
-====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. +
- +
-  * **DLL_SUCCESS** - everything went according to plan, no errors encountered, average case +
-  * **DLL_MALLOC_FAIL** - memory allocation failed (considered in error) +
-  * **DLL_ALREADY_ALLOC** - memory has already been allocated (considered in error) +
-  * **DLL_NULL** - result is NULL (probably in error) +
-  * **DLL_EMPTY** - result is an empty list (may or may not be in error) +
-  * **DLL_DEFAULT_FAIL** - default state of unimplemented functions (default error) +
-  * **DLL_ERROR** - some error occurred +
-  * **DLL_INVALID** - invalid use (passing a NULL pointer) +
- +
-For example, in the case of "DLL_MALLOC_FAIL", there are actually a total of three states raised: +
-  * DLL_ERROR (a problem has occurred) +
-  * DLL_MALLOC_FAIL (a problem has occurred when using malloc()) +
-  * DLL_NULL (no memory allocated, so list cannot be anything but NULL) +
- +
-ALL THREE states must be returned from the function in question should such an occurrence take place. +
-====list library==== +
-In **src/list/**, 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. +
- +
-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===== +
-To assist you in verifying a correct implementation, a fully working implementation of the node and list libraries should resemble the following (when running the respective verify script): +
- +
- +
-====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:  12, Matches:  12, Mismatches:   0 +
-    [cplist] Total:  18, Matches:  18, Mismatches:   0 +
-    [append] Total:  36, Matches:  36, Mismatches:   0 +
-    [insert] Total:  36, Matches:  36, Mismatches:   0 +
-   [display] Total:  12, Matches:  12, Mismatches:   0 +
-      [find] Total:  28, Matches:  28, Mismatches:   0 +
-====================================================== +
-   [RESULTS] Total: 142, Matches: 142, Mismatches:   0 +
-====================================================== +
-lab46:~/src/data/dll0$  +
-</cli> +
-=====Submission===== +
-{{page>haas:fall2016:common:submitblurb#DATA&noheader&nofooter}}+
  
haas/fall2022/data/projects/dll0.1539614391.txt.gz · Last modified: 2018/10/15 14:39 by 127.0.0.1

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