Lab46 Wiki

User Tools

Site Tools

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

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:sll2 [2021/09/08 17:55] – created - external edit 127.0.0.1haas:fall2022:data:projects:sll2 [2022/09/12 12:53] (current) – external edit 127.0.0.1
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======Project: SLL2======+======PROJECT: Singly-Linked List of Nodes (SLL2)======
  
-=====Errata===== +=====OBJECTIVE===== 
-This section will document any updates applied to the project since original release:+To continue to enhance our ability to explore various algorithmic and computing realms through the exploration and cultivation of debugging and troubleshooting skills, and collaboratively authoring and documenting the project and its specifications.
  
-  * __revision #__: <description> (DATESTRING)+=====UPGRADING===== 
 +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.
  
-=====Objective===== +Simply go into the project base directory, and run:
-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()** +
-=====Project Overview=====+
  
-For this project, we're going to be implementing the following functions:+<cli> 
 +lab46:~/src/SEMESTER/DESIG/prevPROJECT$ make upgrade-sll2 
 +</cli>
  
-<code c> +=====EDIT===== 
-List *obtain (List *, Node **);         // obtain/disconnect node from list +You will want to go [[/notes/data/fall2022/projects/sll2|here]] to edit and fill in the various sections of the document:
-List *clearlist(List *);                // empty an existing list +
-List *rmlist(List *);                   // deallocate list +
-List *swapnode(List *, Node *, Node *); // swap positions of given nodes in list +
-List *sortlist(List *, int);            // sort list (according to mode) +
-</code>+
  
-====list library==== +  * [[/notes/data/fall2022/projects/sll2|https://lab46.g7n.org/notes/data/fall2022/projects/sll2]]
-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) +{{page>notes:data:fall2022:projects:sll2&nouser&nodate&nomdate}}
-  * **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 list library (**liblist.a**) we will be using in this and future projects.+=====SUBMISSION===== 
 +To be successful in this project, the following criteria (or their equivalent) must be met:
  
-Figure out what is going on, make sure you understand it.+  * 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 unit tests==== +====Submit Tool Usage==== 
-In **unit/list/**, you will find these new files: +Let's  say you  have completed  work  on the  project, and  are ready  to 
- +submit, you  would do the following  (assuming you have a  program called 
-  * **unit-obtain.c**     - unit test for **obtain()** library function +uom0.c):
-  * **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). +
- +
-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! +
- +
-====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: +
- +
-====node library==== +
-Here is what you should get for the node library:+
  
 <cli> <cli>
-lab46:~/src/SEMESTER/DESIG/sll2$ bin/verify-node.sh  +lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit
-==================================================== +
-=    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/SEMESTER/DESIG/sll2$ +
 </cli> </cli>
  
-====list library==== +You should get some sort of confirmation indicating successful submission 
-Here is what you should get for all the functions completed so far in the list library (sll0+sll1+sll2):+if all went according to plan. If  not, check for typos and or locational 
 +mismatches.
  
-<cli> +=====RUBRIC===== 
-lab46:~/src/SEMESTER/DESIG/sll2$ bin/verify-list.sh +I'll be evaluating the project based on the following criteria:
  
-====================================================== +<code> 
-=     Verifying Singly-Linked List Functionality     = +78:sll2:final tally of results (78/78) 
-====================================================== +*:sll2:obtained project by the Sunday prior to duedate [13/13] 
-    [mklist] Total:   5, Matches:   5, Mismatches:   0 +*:sll2:clean compile, no compiler messages [13/13] 
-    [insert] Total:  11, Matches:  11, Mismatches:   0 +*:sll2:implementation passes unit tests [13/13] 
-  [displayf] Total:   4, Matches:   4, Mismatches:   0 +*:sll2:adequate modifications to code from template [13/13] 
-    [getpos] Total:   8, Matches:   8, Mismatches:   0 +*:sll2:program operations conform to project specifications [13/13] 
-    [setpos] Total:   9, Matches:   9, Mismatches:   0 +*:sll2:code tracked in lab46 semester repo [13/13] 
-    [append] Total:  11, Matches:  11, Mismatches:   0 +</code>
-[searchlist] Total:  11, Matches:  11, Mismatches:   0 +
-    [cplist] Total:  11, Matches:  11, Mismatches:   0 +
-  [displayb] Total:   6, Matches:   6, Mismatches:   0 +
-   [compare] Total:  15, Matches:  15, Mismatches:   0 +
-    [obtain] Total:  28, Matches:  28, 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: 161, Matches: 161, Mismatches:   0 +
-====================================================== +
-lab46:~/src/SEMESTER/DESIG/sll2$  +
-</cli>+
  
-===sll2 specific functions===+===Pertaining to the collaborative authoring of project documentation===
  
-And of course, the **make check** functionality will show you your current progress on sll2 specifically (be sure to run this and not get distracted by the others).+  * 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
  
-<cli> +===Additionally=== 
-lab46:~/src/SEMESTER/DESIG/sll2$ make check + 
-====================================================== +  * Solutions not abiding  by spirit of project will be  subject to a 50% overall deduction 
-=    Verifying Singly-Linked  List Functionality     = +  * 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 
-    [obtain] Total:  28, Matches:  28, Mismatches:   0 +  * 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
- [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:  70, Matches:  70, Mismatches:   0 +
-====================================================== +
-lab46:~/src/SEMESTER/DESIG/sll2$  +
-</cli> +
-=====Submission===== +
-{{page>haas:fall2021:common:submitblurb#DATA&noheader&nofooter}}+
  
haas/fall2022/data/projects/sll2.1631123711.txt.gz · Last modified: 2021/09/08 17:55 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