Lab46 Wiki

User Tools

Site Tools

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

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:dll2 [2021/10/28 19:46] – created - external edit 127.0.0.1haas:fall2022:data:projects:dll2 [2022/10/31 11:45] (current) – [OVERVIEW] wedge
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======Project: DLL2======+======PROJECT: Lists - Doubly-Linked Lists of Nodes (DLL2)======
  
-=====Errata===== +=====OBJECTIVE===== 
-This section will document any updates applied to the project since original release:+We prepare to shift our focus onto a different data structure, that of doubly-linked stacks, and collaboratively authoring and documenting the project and its specifications.
  
-  * __revision #__: <description> (DATESTAMP)+=====OVERVIEW===== 
 +With our list implementation completed, we will be making some modifications to better suit our implementation for our next intended data structure, stacks. Namely, adding the **qty** element to the list struct, and adding more modes to **display()**.
  
-=====Objective===== +=====UPGRADING===== 
-This is a transitional project, making a few modifications to the list struct forcing some changes to a few functions so that we can better explore the next topic (in **dls0**).+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.
  
-As such, while this is a standalone project, it should be considered a small one, and one that is given out in combination with another (again: **dls0**), so be mindful of time management.+Simply go into the project base directory, and run:
  
-You will need to complete this project prior to upgrading to **dls0**.+<cli> 
 +lab46:~/src/SEMESTER/DESIG/prevPROJECT$ make upgrade-dll2 
 +</cli>
  
-=====Project Overview=====+=====EDIT===== 
 +You will want to go [[/notes/data/fall2022/projects/dll2|here]] to edit and fill in the various sections of the document:
  
-====list.h==== +  * [[/notes/data/fall2022/projects/dll2|https://lab46.g7n.org/notes/data/fall2022/projects/dll2]]
-For this project, we need to make a modification to the list struct (which you can also check out in **inc/list.h**):+
  
-<code c> +{{page>notes:data:fall2022:projects:dll2&nouser&nodate&nomdate}}
-struct list { +
-    Node              *lead;                // pointer to start of list +
-    Node              *last;                // pointer to end of list +
-    ulli               qty;                 // quantity of nodes in list +
-}; +
-</code>+
  
-Specifically, we now have a **qty** variable, which will keep track of the number of nodes in the list.+=====SUBMISSION===== 
 +To be successful in this project, the following criteria (or their equivalent) must be met:
  
-To implement **qty**, all list functions that perform manipulations to the list will need to see some updating (**mklist()**, **insert()**, **append()**, and **obtain()**). Functions like **cplist()** should be using the aforementioned functions to manipulate the list, so it does not need any changes (if your **cplist()** is redundant, it will need to see changes to ensure compatibility).+  * 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.
  
-====list library==== +====Submit Tool Usage==== 
-Again, in **src/list/**, you are to add support for **qty** so that, just as the list's **lead** and **last** maintain an accurate positioning of their respective aspects of the list, **qty** maintains a count of the total number of nodes still in the list.+Let's  say you  have completed  work  on the  project, and  are ready  to 
 +submit, you  would do the following:
  
-===display() enhancements=== 
-You are also to implement 4 additional modes to the display() function.  
- 
-Be sure to adjust any mode error correction accordingly. 
- 
-The modes are as follows: 
- 
-<code c> 
-////////////////////////////////////////////////////////////////////// 
-// 
-// Options for list display() and support catlist() functions 
-// 
-#define  DISPLAY_FORWARD     000 
-#define  DISPLAY_NOPOSVALS   000 
-#define  DISPLAY_NOASCII     000 
-#define  DISPLAY_SEPS        000 
-#define  DISPLAY_POSVALS     001 
-#define  DISPLAY_BACKWARD    002 
-#define  DISPLAY_ASCII       004 
-#define  DISPLAY_NOSEPS      010 
-</code> 
- 
-What has changed? There are two additional toggles: 
-  * NOASCII/ASCII - whether or not to render VALUE as an ASCII character or a number 
-    * in ASCII mode, separators become commas, and the terminating NULL no longer is output 
-  * SEPS/NOSEPS - whether or not to display arrows/commas or nothing at all 
- 
-For example, if there was a numeric 65 stored in the node, with DISPLAY_ASCII set, an **'A'** should be displayed instead of a **65**. 
- 
-==display() output examples based on mode== 
-Let's say we have a list with the following elements: 
- 
-  first -> 51 -> 49 -> 51 -> 51 -> 55 -> NULL 
- 
-==forward, no positions, with separators, as numbers (not ASCII)== 
 <cli> <cli>
-51 -> 49 -> 51 -> 51 -> 55 -> NULL+lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit
 </cli> </cli>
  
-==forward, with positions, with separators, as numbers (NOT ASCII)== +You should get some sort of confirmation indicating successful submission 
-<cli> +if all went according to plan. If  not, check for typos and or locational 
-[0] 51 -> [1] 49 -> [2] 51 -> [3] 51 -> [4] 55 -> NULL +mismatches.
-</cli>+
  
-==forward, no positions, with separators, in ASCII== +=====RUBRIC===== 
-<cli> +I'll be evaluating the project based on the following criteria:
-'3' -> '1' -> '3' -> '3' -> '7' -> NULL +
-</cli>+
  
-==forward, with positions, with separators, in ASCII== +<code> 
-<cli> +65:dll2:final tally of results (65/65) 
-[0] '3' -> [1] '1' -> [2] '3' -> [3] '3' -> [4] '7' -> NULL +*:dll2:obtained project by the Sunday prior to duedate [6/6] 
-</cli>+*:dll2:clean compile, no compiler messages [13/13] 
 +*:dll2:implementation passes unit tests [13/13] 
 +*:dll2:adequate modifications to code from template [13/13] 
 +*:dll2:program operations conform to project specifications [13/13] 
 +*:dll2:code tracked in lab46 semester repo [7/7] 
 +</code>
  
-==forward, no positions, no separators, in ASCII== +===Pertaining to the collaborative authoring of project documentation===
-<cli> +
-31337 +
-</cli>+
  
-Please see the unit test for more information.+  * each class member is to participate in the contribution of relevant information and formatting of the documentation 
 +    * minimal member contributions consist of: 
 +      * near the class average edits (a value of at least four productive edits) 
 +      * 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
  
-====List library applications====+===Additionally===
  
-===cyclecheck (bonus opportunity)=== +  * Solutions not abiding  by spirit of project will be  subject to a 50% overall deduction 
-A problem that cropped up from time to time during the list implementation was the instance of a list **cycle**, where a node accidentally ended up pointing to itself (or a previous location, to the direction of traversal). This led to seemingly "infinite loops" as streams of identical values displayed on the screen, and hopefully pictures drawn to try and track down the source of the problem. +  * 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 
-With the doubly-linked list functions (especially insert() and append()) we baked in additional resiliency by having them check the validity of their **place** pointers, to ensure that **place** was a legitimate node in the list. +  * 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
- +
-But we've not done anything to address the presence of cycles. Here we will explore how to detect them, and even attempt to ascertain where they start (source) and at what point the list repeats (destination) over and over again. +
-=====Expected Results===== +
-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: +
- +
-====list library==== +
- +
-===dll2 list functions=== +
-Here is what you should get for the specific functions relevant to dll3: +
- +
-<cli> +
-lab46:~/src/data/dll2$ make check +
-====================================================== +
-=    Verifying Doubly-Linked  List Functionality     = +
-====================================================== +
-    [mklist] Total:  18, Matches:  18, Mismatches:   0 +
-    [append] Total:  47, Matches:  47, Mismatches:   0 +
-    [insert] Total:  47, Matches:  47, Mismatches:   0 +
-    [obtain] Total:  71, Matches:  71, Mismatches:   0 +
-   [display] Total:  54, Matches:  54, Mismatches:   0 +
-====================================================== +
-   [RESULTS] Total: 237, Matches: 237, Mismatches:   0 +
-====================================================== +
-lab46:~/src/data/dll2$  +
-</cli> +
- +
-===entire list=== +
-Here is what you should get for all the functions completed so far in the list library (dll0+dll1+dll2): +
- +
-<cli> +
-lab46:~/src/data/dll2$ bin/verify-list.sh +
-==================================================== +
-=    Verifying Doubly-Linked List Functionality    = +
-==================================================== +
-  [mklist] Total:  18, Matches:  18, Mismatches:   0 +
-  [cplist] Total:  18, Matches:  18, Mismatches:   0 +
-  [rmlist] Total:   7, Matches:   7, Mismatches:   0 +
-   [empty] Total:   7, Matches:   7, Mismatches:   0 +
-  [append] Total:  47, Matches:  47, Mismatches:   0 +
-  [insert] Total:  47, Matches:  47, Mismatches:   0 +
-  [obtain] Total:  71, Matches:  71, Mismatches:   0 +
- [display] Total:  54, Matches:  54, Mismatches:   0 +
-    [find] Total:  28, Matches:  28, Mismatches:   0 +
- [compare] Total:  12, Matches:  12, Mismatches:   0 +
-[swapnode] Total:  31, Matches:  31, Mismatches:   0 +
-[sortlist] Total:  48, Matches:  48, Mismatches:   0 +
-==================================================== +
- [RESULTS] Total: 388, Matches: 388, Mismatches:   0 +
-==================================================== +
-lab46:~/src/data/dll2$  +
-</cli> +
-=====Submission===== +
-{{page>haas:fall2017:common:submitblurb#DATA&noheader&nofooter}}+
  
haas/fall2022/data/projects/dll2.1635450413.txt.gz · Last modified: 2021/10/28 19:46 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