Homework 11
Last updated: Sat, 23 Nov 2024 10:13:11 -0500
Out: Mon Nov 18, 2024, 12pm (noon) EST
Due: Mon Nov 25, 2024, 12pm (noon) EST
Overview
In this assignment, we will continue adding features to our "CS450 Lang" "high-level language", namely variables and function calls. By continuing to use the design recipe, however, even advanced features can be added in a straightforward way.
This hw will be graded accordingly:
correctness (12 pts)
design recipe (30 pts) (testing 15 pts)
style (10 pts)
README (2 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 hw11 repository hw11-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
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.
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 find the "Syntactic Test Coverage" feature in DrRacket useful. At minimum, one-hundred percent of your code should be run (if not tested) before submission.
The main code should go in a file named hw11.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).
Programming
In Lecture 17 and
Lecture 18, we implemented a
programming language that could perform arithmetic on a variety of
data types. But it still is still very simplistic—
In this assignment, we will add some of these features, namely variables and function calls, to our language.
(Note that this assignment does not require completing the previous ones.)
Specifically, write the following functions to accommodate the Data Definitions below. Note that in some instances, the exact data definition is not specified and is left up to you to design.
Functions
parse : takes a 450LangExpr (abbreviated Expr) "program" and produces a 450LangAST abstract syntax tree (abbreviated AST) data structure.
Should raise a exn:fail:syntax:cs450 exception that you define (which should be a substruct of exn:fail:syntax) if the input is not a valid Expr (but passes the shallow contract check).
run : takes a 450LangAST tree (abbreviated AST) and "runs" it, to produce a 450LangResult "result" (abbreviated Result).
This function should define an internal function that uses an Environment accumulator. Make sure to follow all steps of the accumulator Design Recipe. The initial environment should contain bindings for + and - variables.
exn:fail:syntax:cs450? : returns true if given a exn:fail:syntax:cs450 exception, which should be thrown when trying to parse an invalid program
UNDEFINED-ERROR? : returns true if given an UNDEFINED-ERROR Result, which should occur if the program attempts to use an undefined variable
NOT-FN-ERROR? : returns true if given a NOT-FN-ERROR Result, which should occur if the program attempts to call a non-function value
For reference, here are the Data Definitions that we are using:
A Variable (Var) is a Symbol
An Environment is a List<(list Var Result)>
- A 450LangExpr (Expr for short) is one of:
Number
Variable
(list ’bind [Var Expr] Expr)
(cons Expr List<Expr>)
Interpretation: represents the surface-level syntax of CS450Lang programs. The last item is a function call (but the only functions available in this assignment will be the two arithmetic functions in the initial environment). - A 450LangAST (AST for short) is one of:
(num Number)
(vari Symbol)
????
Interpretation: represents an abstract syntax tree data structure that is produced from parsing the surface programNOTE: It is recommended that you do not name your Variable AST node "var". Past students have run into problems with this due to unintended shadowing (because var is also a match pattern name).
- A 450LangResult (Result for short) is one of:
Number
(Racket) function
NaN
ErrorResult
Interpretation: possible results after running a CS450Lang program. In this assignment, a NaN should be the result of any arithmetic involving non-number arguments. - An ErrorResult is one of:
UNDEFINED-ERROR
NOT-FN-ERROR
Interpretation: possible "error" results of a CS450Lang program. An "undefined" error should occur when trying to use an undefined variable. A "not fn" error should occur if attempting to call a non-function. If one of these occurs in an inner expression, it should propagrate to be the final result of the whole expression. If more than one error occurs, e.g., in arguments of a function call, their ordering the data definition specifies their precedence.
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:
hw11.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 hw11.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 hw11. 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.)