Lab46 Wiki

User Tools

Site Tools

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

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:sll4 [2021/10/05 19:21] – created - external edit 127.0.0.1haas:fall2022:data:projects:sll4 [2022/09/26 15:13] (current) – wedge
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======Project: SLL4======+======PROJECT: Groups - Or Singly-Linked List of Lists of Nodes (SLL4)======
  
-=====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> (DATESTAMP)+=====OVERVIEW===== 
 +As our list data structure was built atop nodes, here we have a new data structure, groups, built atop lists: groups of lists! Intended as an opportunity for you to better exercise your conceptual understanding of everything (it should seem more similar than different to what came before).
  
-=====Objective===== +=====UPGRADING===== 
-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.+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.
  
-So what does this give us? An organizing unit for lists! I'm calling them "ListGroups" or "GroupOfLists", and with our sll3 addition of a **next** pointer to the list struct, we'll be working with groups of linked lists.+Simply go into the project base directory, and run:
  
-=====Project Overview=====+<cli> 
 +lab46:~/src/SEMESTER/DESIG/prevPROJECT$ make upgrade-sll4 
 +</cli>
  
-====group.h==== +=====EDIT===== 
-We can now organize our lists with this new groupoflists struct (typedef'ed to **Group** for typing convenience).+You will want to go [[/notes/data/fall2022/projects/sll4|here]] to edit and fill in the various sections of the document:
  
-<code c> +  * [[/notes/data/fall2022/projects/sll4|https://lab46.g7n.org/notes/data/fall2022/projects/sll4]]
-#ifndef _GROUP_H +
-#define _GROUP_H+
  
-#include "list.h"                        // group relies on list and node to work+{{page>notes:data:fall2022:projects:sll4&nouser&nodate&nomdate}}
  
-struct groupoflists { +=====SUBMISSION===== 
-    List *initial;                       // pointer to first list +To be successful in this project, the following criteria (or their equivalent) must be met:
-    List *closing;                       // pointer to last list +
-}; +
-typedef struct groupoflists Group;       // cuz we deserve nice things +
-typedef long   int          sli;         // short name for big thing+
  
-Group *mkgroup(void);                    // create/allocate new Group +  * Project must be submit on time, by the deadline. 
-Group *rmgroup(Group *);                 // clear/deallocate Group+    * 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.
  
-Group *linsert(Group *, List *, List *); // add list before given list +====Submit Tool Usage==== 
-Group *lappend(Group *, List *, List *); // add list after given list +Let's  say you  have completed  work  on the  project, and  are ready  to 
-Group *lobtain(Group *, List **);        // obtain/disconnect list from group+submit, you  would do the following  (assuming you have a  program called 
 +uom0.c):
  
-sli    ldisplay(Group *, sli);           // display list group+<cli> 
 +lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit 
 +</cli>
  
-sli    lgetpos(Group  *, List *);        // retrieve position of list +You should get some sort of confirmation indicating successful submission 
-List  *lsetpos(Group  *, sli);           // seek to list in group+if all went according to plan. If  not, check for typos and or locational 
 +mismatches.
  
-#endif+=====RUBRIC===== 
 +I'll be evaluating the project based on the following criteria: 
 + 
 +<code> 
 +91:sll4:final tally of results (91/91) 
 +*:sll4:obtained project by the Sunday prior to duedate [13/13] 
 +*:sll4:clean compile, no compiler messages [13/13] 
 +*:sll4:implementation passes unit tests [13/13] 
 +*:sll4:adequate modifications to code from template [13/13] 
 +*:sll4:program operations conform to project specifications [26/26] 
 +*:sll4:code tracked in lab46 semester repo [13/13]
 </code> </code>
  
-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).+===Pertaining to the collaborative authoring of project documentation===
  
-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. +  * each class member is to participate in the contribution of relevant information and formatting of the documentation 
-====group library==== +    * minimal member contributions consist of: 
-In **src/group/**, you will find 7 new C files:+      * 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
  
-  * **obtain.c**   - which will house the group lobtain() function (to disconnect lists from a group) +===Additionally===
-  * **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. +  * 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 
-Figure out what is going on, make sure you understand it. +  * 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 
- +  * 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
-====Group library unit tests==== +
-In **unit/group/**, 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! +
- +
-=====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: +
- +
-====group library==== +
-Here is what you should get for all the functions completed in the group library: +
- +
-<cli> +
-lab46:~/src/SEMESTER/DESIG/sll4$ make check +
-====================================================== +
-=    Verifying Singly-Linked Group Functionality     = +
-====================================================== +
-   [mkgroup] Total:   5, Matches:   5, Mismatches:   0 +
-   [rmgroup] Total:   3, Matches:   3, Mismatches:   0 +
-   [linsert] Total:  20, Matches:  20, Mismatches:   0 +
-   [lappend] Total:  20, Matches:  20, Mismatches:   0 +
-   [lobtain] Total:  15, Matches:  15, Mismatches:   0 +
-  [ldisplay] Total:  31, Matches:  31, Mismatches:   0 +
-   [lgetpos] Total:  14, Matches:  14, Mismatches:   0 +
-   [lsetpos] Total:  14, Matches:  14, Mismatches:   0 +
-====================================================== +
-   [RESULTS] Total: 122, Matches: 122, Mismatches:   0 +
-====================================================== +
-lab46:~/src/SEMESTER/DESIG/sll4$  +
-</cli> +
-=====Submission===== +
-{{page>haas:fall2021:common:submitblurb#DATA&noheader&nofooter}}+
  
haas/fall2022/data/projects/sll4.1633461682.txt.gz · Last modified: 2021/10/05 19:21 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