User Tools

Site Tools


Sidebar

projects

pct0 (bonus; due 20230823)
wcp1 (due 20230823)
abc0 (due 20230830)
btt0 (due 20230830)
pct1 (bonus; due 20230830)
pct2 (due 20230830)
wcp2 (due 20230830)
mpg0 (due 20230906)
pct3 (bonus; due 20230906)
wcp3 (due 20230906)
pct4 (due 20230913)
ttb0 (due 20230913)
wcp4 (due 20230913)
pct5 (bonus; due 20230920)
ttb1 (due 20230920)
wcp5 (due 20230920)
dap0 (due 20230927)
gfo0 (due 20230927)
pct6 (due 20230927)
wcp6 (due 20230927)
cgf0 (due 20231004)
pct7 (bonus; due 20231004)
wcp7 (due 20231004)
bwp1 (bonus; due 20231018)
cgf1 (due 20231018)
pct8 (due 20231018)
wcp8 (due 20231018)
cgf2 (due 20231025)
pct9 (bonus; due 20231025)
wcp9 (due 20231025)
cgf3 (due 20231101)
gfo1 (due 20231101)
pctA (due 20231101)
wcpA (due 20231101)
pctB (bonus; due 20231108)
waq0 (due 20231108)
wcpB (due 20231108)
pctC (due 20231115)
waq1 (due 20231115)
wcpC (due 20231115)
bwp2 (bonus; due 20231129)
pctD (bonus; due 20231129)
wcpD (bonus; due 20231129)
gfo2 (due 20231206)
pctE (bonus; due 20231206)
wcpE (bonus; due 20231206)
EoCE (due 20231214)
haas:fall2023:data:projects:dll1

Corning Community College

CSCS2320 Data Structures

PROJECT: Lists - Doubly-Linked Lists of Nodes (DLL1)

OBJECTIVE

To continue our journey on doubly-linked data structures, and collaboratively authoring and documenting the project and its specifications.

OVERVIEW

We continue now delving into the realm of doubly-linked data structures. This project: we complete on our doubly-linked list implementation.

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.

Simply go into the project base directory, and run:

lab46:~/src/SEMESTER/DESIG/prevPROJECT$ make upgrade-dll1

EDIT

You will want to go here to edit and fill in the various sections of the document:

BACKGROUND

SPECIFICATIONS

This week we are working on the following functions:

  • obtain
  • empty
  • rmlist
  • compare
  • swapnode
  • sortlist

The way in which you proceed through these functions only matter if you want to use functions inside other functions. Unit tests this week do not rely upon other functions created this week to work. Some unit tests will make use of functions made last week, for dll0. Make sure that your cplist works well because that is found commonly throughout the unit tests.

Some possible combinations to get you going: empty inside rmlist, obtain inside empty, swap inside sort. There are more combinations possible to reduce the amount of reinventing that your doing of the wheel, but these are a few to just get you started on the idea of combining functions inside other functions.

*Our task is to ask questions on Discord or in class and document our findings on this wiki page collaboratively, regarding the functionality of this project.

*For anybody interested in editing the wiki page, here is the dokuwiki user guide: https://www.dokuwiki.org/wiki:syntax#basic_text_formatting -Ash

PROGRAM

It should be noted that the new compare is quite similar to the sllx version, therefore drawing inspiration from the code one wrote previously may be of assistance.

For the new rmlist function, like the one in the previous sllx projects, it would be wise to work on the empty function first (similar to that of the clear function in the sllx projects). That way when you want to deallocate a list, you can call the empty function to clear up the nodes within the list to ensure there is no memory leak.

NOTE If you are trying to work on this project without a fully functional dll0 library, you are still able to complete this project, and get full credit (if new implementations pass all the test cases). To do this, in your root folder of dll1 type: make use-test-reference. Rather than using your implementations of previous functions, your make will now use working implementations ONLY of functions from previous dllX's.

OUTPUT SPECIFICATIONS

No output to stdout for any of these functions, all functions should modify the list in some way, shape, or form.

UNIT TESTS

Total of 162 tests. Unit tests are called with make check, similar to every other week. Safe practice to make clean before every make to ensure old results are cleaned up. There will be an errors file created after running make, it’s a good idea to check this as well. Tests are split amongst all the functions, with 7 going to empty and rmlist. Compare, Swap, Sort, and Obtain have 12, 31, 48, and 57 tests respectively. While unit tests do a good job of ensuring basic functionality, ensure that your functions can work with any provided input. To be specific, if you're going to use swap inside sort(a good idea), make sure your swap can handle functions side by side anywhere in the list. The unit test for swap does not check for this.

Additionally, if one wishes to be shown any compiling errors/warnings immediately, one could use “make debug” to do so, as this will reroute the contents of the make to stdout instead of the errors file.

 

SUBMISSION

To be successful in this project, the following criteria (or their equivalent) must be met:

  • 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.

Submit Tool Usage

Let's say you have completed work on the project, and are ready to submit, you would do the following:

lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit

You should get some sort of confirmation indicating successful submission if all went according to plan. If not, check for typos and or locational mismatches.

RUBRIC

I'll be evaluating the project based on the following criteria:

91:dll1:final tally of results (91/91)
*:dll1:obtained project by the Sunday prior to duedate [13/13]
*:dll1:clean compile, no compiler messages [13/13]
*:dll1:implementation passes unit tests [26/26]
*:dll1:adequate modifications to code from template [13/13]
*:dll1:program operations conform to project specifications [13/13]
*:dll1:code tracked in lab46 semester repo [13/13]

Pertaining to the collaborative authoring of project documentation

  • 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

Additionally

  • 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
  • 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
haas/fall2023/data/projects/dll1.txt · Last modified: 2022/10/15 12:18 by 127.0.0.1