Lab46 Wiki

User Tools

Site Tools

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

Differences

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

Link to this comparison view

haas:fall2022:data:projects:dln0 [2021/10/14 18:04] – created - external edit 127.0.0.1haas:fall2022:data:projects:dln0 [2022/10/15 12:07] (current) – wedge
Line 4: Line 4:
 </WRAP> </WRAP>
  
-======Project: DLN0======+======PROJECT: Nodes - Doubly-Linked Nodes (DLN0)======
  
-=====Errata===== +=====OBJECTIVE===== 
-This section will document any updates applied to the project since original release:+To begin our journey on doubly-linked data structures, and collaboratively authoring and documenting the project and its specifications.
  
-  * __revision #__: <description> (DATESTAMP)+=====OVERVIEW===== 
 +We have been focusing on singly-linked data structures for the past few weeks. We now start 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: doubly-linked nodes.
  
-=====Objective===== +=====GRABBING===== 
-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.+We are doing a fresh start this week, reimplementing our data structure infrastructure from scratch. So, to obtain the project files for this project, we will be doing an initial **grabit**.
  
-=====Procedure to obtain dln0===== +Simply go into your DESIG organizational/staging directory, and run:
-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. +
- +
-====grabit==== +
-Just as we did with the first project in the series, **sln1**, we can also use grabit to obtain this project:+
  
 <cli> <cli>
-lab46:~/src/data$ grabit data +lab46:~/src/SEMESTER/DESIG$ grabit data dln0
-ERROR: must specify class and project! +
-example: +
-    grabit discrete matrixadd +
- +
-Projects available for data: +
-    * dln0 +
-    * sln1 +
- +
-lab46:~/src/data$ +
 </cli> </cli>
  
-So, we can just go ahead and do:+=====EDIT===== 
 +You will want to go [[/notes/data/fall2022/projects/dln0|here]] to edit and fill in the various sections of the document:
  
-<cli> +  * [[/notes/data/fall2022/projects/dln0|https://lab46.g7n.org/notes/data/fall2022/projects/dln0]]
-lab46:~/src/data$ grabit data dln0 +
-... +
-</cli>+
  
-And voila! Freshly grabbed **dln0** in our ~/src/data/ directory.+{{page>notes:data:fall2022:projects:dln0&nouser&nodate&nomdate}}
  
-=====Project Overview===== +=====SUBMISSION===== 
-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:+To be successful in this project, the following criteria (or their equivalent) must be met:
  
-====In inc/node.h==== +  * Project must be submit on time, by the deadline. 
-<code c 1> +    * Late submissions will lose 33%  credit per day, with the submission window closing on the 3rd day following the deadline. 
-#ifndef _NODE_H +  * All code must compile cleanly (no warnings or errors) 
-#define _NODE_H+    * 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.
  
-////////////////////////////////////////////////////////////////////// +====Submit Tool Usage==== 
-// +Let's  say you  have completed  work  on the  project, and  are ready  to 
-// Additional useful information in data.h +submit, you  would do the following:
-// +
-#include "data.h"+
  
-////////////////////////////////////////////////////////////////////// +<cli> 
-// +lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit 
-// node struct definition +</cli>
-// +
-struct node { +
-    union  info      payload; +
-    struct node     *left; +
-    struct node     *right; +
-};+
  
-////////////////////////////////////////////////////////////////////// +You should get some sort of confirmation indicating successful submission 
-// +if all went according to plan. If  not, check for typos and or locational 
-// function prototypes +mismatches.
-// +
-code_t mknode(Node **, sc);    // allocate new node containing value +
-code_t cpnode(Node  *, Node **); // duplicate node +
-code_t rmnode(Node **);          // deallocate node+
  
-#endif +=====RUBRIC===== 
-</code> +I'll be evaluating the project based on the following criteria:
- +
-There is an addition of a "left" node pointer, to allow connections to our previous neighbors. +
- +
-The node info element has been changed as well... instead of a singular value, it is now a union by the name of payload, which contains a value entry (a signed char entry), a data entry (Node pointer), and an other entry (a void pointer). +
- +
-====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> +
-#ifndef _DATA_H +
-#define _DATA_H +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// We make use of NULL, so we need stdlib +
-// +
-#include <stdlib.h> +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// Set up union for node payload (multipurpose use) +
-// +
-union info { +
-    sc           value; +
-    struct node *data; +
-    void        *other; +
-}; +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// node struct helper defines +
-// +
-#define  VALUE   payload.value +
-#define  DATA    payload.data +
-#define  OTHER   payload.other +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// create some peers to NULL for our endeavors: UNDEFINED +
-// +
-#if !defined(UNDEFINED) +
-    #define UNDEFINED ((void*)1) +
-#endif +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// 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; +
- +
-////////////////////////////////////////////////////////////////////// +
-// +
-// Status codes for the doubly linked node implementation +
-// +
-#define  DLN_SUCCESS         0x0000000000000100 +
-#define  DLN_MALLOC_FAIL     0x0000000000000200 +
-#define  DLN_ALREADY_ALLOC   0x0000000000000400 +
-#define  DLN_NULL            0x0000000000000800 +
-#define  DLN_ERROR           0x0000000000001000 +
-#define  DLN_INVALID         0x0000000000002000 +
-#define  DLN_DEFAULT_FAIL    0x0000000000004000 +
-#define  DLN_RESERVED_CODE   0x0000000000008000+
  
-#endif+<code> 
 +65:dln0:final tally of results (65/65) 
 +*:dln0:obtained project by the Sunday prior to duedate [6/6] 
 +*:dln0:clean compile, no compiler messages [13/13] 
 +*:dln0:implementation passes unit tests [13/13] 
 +*:dln0:adequate modifications to code from template [13/13] 
 +*:dln0:program operations conform to project specifications [13/13] 
 +*:dln0:code tracked in lab46 semester repo [7/7]
 </code> </code>
  
-====node operation status codes==== +===Pertaining to the collaborative authoring of project documentation===
-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.+
  
-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.+  * 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
  
-  * **DLN_SUCCESS** - everything went according to plan, no errors encountered, average case +===Additionally===
-  * **DLN_MALLOC_FAIL** - memory allocation failed (considered in error) +
-  * **DLN_ALREADY_ALLOC** - memory has already been allocated (considered in error) +
-  * **DLN_NULL** - result is NULL (probably in error) +
-  * **DLN_DEFAULT_FAIL** - default state of unimplemented functions (default error) +
-  * **DLN_ERROR** - 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 "DLN_MALLOC_FAIL", there are actually a total of three states raised: +  * Solutions not abiding  by spirit of project will be  subject to a 50% overall deduction 
-  * DLN_ERROR (a problem has occurred) +  * Solutions  not  utilizing descriptive  why and  how comments  will be subject to a 25% overall deduction 
-  * DLN_MALLOC_FAIL (a problem has occurred when using malloc()) +  * 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 
-  * DLN_NULL (no memory allocated, so node cannot be anything but NULL) +  * 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
- +
-ALL THREE states must be returned from the function in question should such an occurrence take place. +
- +
-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. +
- +
-====In inc/support.h==== +
-Finally we have support.h... this header will contain some information on helper functions utilized in the various unit tests. You really don't need to bother with this... in fact, do **not** use any of these functions in your implementation. +
- +
-====node library==== +
-In **src/node/**, you will find skeletons of what was previously there, ready for you to re-implement. +
- +
-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). +
- +
- +
-=====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): +
- +
-====node library==== +
-Here is what you should get for node: +
- +
-<cli> +
-lab46:~/src/data/dln0$ make check +
-====================================================== +
-=    Verifying Doubly-Linked  Node Functionality     = +
-====================================================== +
-    [mknode] Total:  12, Matches:  12, Mismatches:   0 +
-    [cpnode] Total:  17, Matches:  17, Mismatches:   0 +
-    [rmnode] Total:   4, Matches:   4, Mismatches:   0 +
-====================================================== +
-   [RESULTS] Total:  33, Matches:  33, Mismatches:   0 +
-====================================================== +
-lab46:~/src/data/dln0$  +
-</cli> +
-=====Submission===== +
-{{page>haas:fall2017:common:submitblurb#DATA&noheader&nofooter}}+
  
haas/fall2022/data/projects/dln0.1634234649.txt.gz · Last modified: 2021/10/14 18:04 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