Homework 5
Last updated: Fri, 11 Oct 2024 16:09:24 -0400
Out: Mon Oct 07, 2024, 12pm (noon) EST
Due: Mon Oct 14, 2024, 12pm (noon) EST
Overview
This assignment continues to explore programming according to the The Design Recipe, in particular with lists and list functions.
This hw will be graded accordingly:
correctness (9 pts)
design recipe (16 pts)
style (9 pts)
README (1 pt)
Setup
Create a new repository for this assignment by going to the CS450 Fall 2024 GitHub Organization and clicking "New".
Note: The CS450 Fall 2024 GitHub Organization must be the owner of the repository. Do not create the repository in your own account.
Name the repository hw<X>-<LASTNAME>-<FIRSTNAME> where <X> is the current homework number.
For example, I would name my hw5 repository hw5-Chang-Stephen.
Mark the repository as Private.
Check "Add a README file".
Select the Racket template for the .gitignore.
Choose whatever you wish for the license.
When done click "Create repository".
Tasks
Reading
Read Chapter 14-15 of the Textbook (where reading means working through the examples and exercises interactively).
Review the The Design Recipe section of the course website (topics that will be covered in future lectures are marked as such).
Notes and Reminders
All code you write must now follow the The Design Recipe. (Just submitting code is no longer sufficient.)
Signatures should use define/contract and the predicates defined in the Data Design Recipe step. UPDATE: You may need the listof contract constructor for this assignment.
For Examples and Tests, do not use check-expect from the Beginning Student Language (even though the textbook says to). Instead, use check-equal? or other testing forms from rackunit.
Examples for a function definition should come right after the define. But Tests should be put into the test-suite in tests.rkt. Try to think about corner cases and code coverage.
Also, remember that Racket Style and The Design Recipe reserves certain language features only for specific scenarios. For example, set! and other "imperative" features are not allowed ever. Conditionals such as cond should only be used with enumeration or itemization Data Definitions.
The submitted program must be only a series of defines (both constants and function definitions are allowed) and tests/examples. Do not run any other code, i.e., do not automatically start big-bang! Not following this this will result in GradeScope errors and point deductions.
You may look at prior code and examples to help you but BE CAREFUL. A "COPY-AND-MODIFY" PROGRAMMING STRATEGY WILL NOT WORK IN THIS COURSE (nor in the real world). Your program will be wrong (partially because most of the design recipe steps will be wrong) and will receive a low score. Instead, you should write the code for this homework from scratch using The Design Recipe.
Programming
In this assignment (and the next one or two) we’ll continue building our "Guitar Hero"-like big-bang interactive program.
Here is an online demo that approximates what the program might look like (after everything is done).
The main code should go in a file named hw5.rkt and tests should go in a tests.rkt file of the appropriate format.
In this assignment, each function should have at minimum of one (meaningful) Example and two Tests (that are not the same as the example).
This assignment is straightforward. Convert your list functions from Homework 4 to use map, filter, foldl/foldr and other list functions.
To help you get started, a partial solution to Homework 4 is available at: hw5 starter code. Note the warning above about copying code.
If you followed the design recipe and have properly structured code—
one function does one task with one kind of data— then this assignment will be easy. - As a reminder, here are the list functions from Homework 4:
Notes?
prune-Notes : takes a ListofNotes and removes the ones that satsify the out-Note? predicate
next-Notes : take a ListofNotes for each, computes the updated notes after one tick
place-Notes-in-scene : takes ListofNotes and a image? and inserts the notes into the scene using place-Note-in-scene
- maybe-add-Note : takes a list of notes and inserts a new note at the front of the list at coordinate NOTE-INIT-Y and some constant NOTE-VELOCITY and PENDING state if
a 1-in-100 random function, called insert-note? returns true
the new note would not overlap with the note that is closest to the top in the given list
Since this function processes randomness, it may use if, but no more than two.
Before Submitting
Testing
Do not submit until all code has been thoroughly tested (by you).
Assignments may or may not use a GradeScope Autograder, but either way, an Autograder is not a software development tool so do not use it as one. Code must be tested independent of any Autograder.
If you submit and get an Autograder error, this means the code you wrote is not complete and/or not correct and it’s up to you to figure out why.
Of course, the course staff is here and eager to help, but cannot do so if a student does not explain what they’ve tried first (e.g., "why is the Autograder giving an error?" is not something we can help with). At the very least you should report what error you are seeing and which part of the error message you do not understand.
The Autograder test suite is subject to change. This means that the visible grade seen during submission is not the final grade.
Style
All code should follow proper Racket Style.
Also, the repository itself must follow proper style. Specifically, it must have appropriate commit messages. See How to Write a Git Commit Message if you are unsure how to write a commit message.
Files
A submission must have the following files in the repository root:
hw5.rkt: Contains the hw solution code.
All defines should use the name specified in the exercise (ask if you are unsure) and should be provided.
The easiest (but not always the most readable) way to ensure all necessary definitions are provided is to (initially) put as the second line in the file:
This automatically provides all definitions in the file. (The first line should be #lang racket)
tests.rkt: This file should require hw5.rkt and define tests for it.
Specifically, it should define a rackunit test-suite which contains sufficient rackunit test cases (e.g., check-equal?, etc.) for each defined function.
README.md: Contains the required README information, including the GitHub repo url.
Submitting
When you are done, submit your work to Gradescope hw5. You must use the "GitHub" Submission Method and select your hw<X>-<LASTNAME>-<FIRSTNAME> repository.
Note that this is the only acceptable way to submit homework in this course. (Do not manually upload files and do not email files to the course staff. Homework submitted via any unapproved methods will not be graded.)