Homework 10
Last updated: Tue, 15 Apr 2025 08:49:02 -0400
Out: Tue Apr 15 2025, 11am EST
Due: Tue Apr 22 2025, 11am EST
Overview
In this assignment, we will extend our "CS 450 Lang" programming language with more data types and primitive operations that are commonly found in other languages. Fortunately, using the The Design Recipe, this seemingly difficult task can be completed in a straightforward manner using the exact same methods we’ve been using all semester.
This hw will be graded accordingly:
correctness (autograder) (12 pts)
design recipe (21 pts)
testing (21 pts)
style (8 pts)
README (2 pt)
Setup
Create a new repository for this assignment by going to the CS450 Spring 2025 GitHub Organization and clicking "New".
Note: The CS450 Spring 2025 GitHub Organization must be the owner of the repository. Do not create the repository in your own account.
On the "Create a new repository" screen:
Name the repository hw<X>-<LASTNAME>-<FIRSTNAME> where <X> is the current homework number.
For example, I would name my hw10 repository hw10-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
Pre-programming Notes
- All code must be written following the The Design Recipe. (Just submitting code is not sufficient.) In additional to the required receipe steps, some language features may only be used in the certain scenarios, as called for by The Design Recipe.
For example, set! and other "imperative" features are not allowed ever.
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 be 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. Each function should have at minimum one Example, and "sufficient" Tests.
Tests should go in a tests.rkt file, as described in lecture, and the rest of the code should go in a file named hw10.rkt.
The submitted program must be only a series of defines (both constants and function definitions are allowed). It should not run any code (e.g., it should not start the big-bang loop automatically!). Not following this will result in GradeScope errors and/or timeouts.
You may look at lecture code to help you but DO NOT SUBMIT ANY OF THIS CODE (even if you change the variable names, etc). You won’t receive any credit. Instead, you should write code for this homework from scratch using The Design Recipe.
struct instances must be comparable with equal? and check-equal?, which means that they should be declared with the #:transparent keyword (including super structs).
Important: Each submission must be organized so that each function only processes one kind of data. Submissions consisting of only a few large, unreadable functions that try to do everything will not receive any credit.
Programming
In this assignment, you must use the following data definitions and functions.
Data Definitions
For each of these data definitions, you should complete them by writing the necessary predicates, constructors, etc. Items that differ from Homework 9 are in bold.
- A Program is one of:
Atom
`(+ ,Program ,Program)
`(x ,Program ,Program)
`(iffy ,Program ,Program ,Program)
`(~= ,Program ,Program)
Interpretation: represents the surface-level syntax of a new programming language (i.e., this is what programmers write). These (nested lists of) symbols have no meaning until they are "run". Note: the "x" symbol above is a "times" unicode symbol can be "typed" in DrRacket by writing "\times" and then pressing ctrl-\ - An Atom is one of:
Number
Bool!
String
Interp: represents basic data values in our language. - An Bool! is one of:
'TRUE!
'FALSE!
Interp: represents true/false boolean values in our language - An AST is one of:
(mk-num Number)
(mk-boo! Boolean)
(mk-str String)
(mk-add AST AST)
(mk-mul AST AST)
(mk-ify AST AST AST)
(mk-loo= AST AST)
Interpretation: represents an abstract syntax tree data structure that is produced from parsing the surface program - A Result is one of:
(Racket) Number
(Racket) Boolean
(Racket) String
NaN
Interpretation: possible results of running a program in our new language. NaN is a constant you must define and it should represent a unique value that is not equal to another Result value.
Functions (define and provide)
parse : takes a Program and produces an AST abstract syntax tree data value. When the input is not a valid Program, this function should call raise-syntax-error with an exn:fail:syntax:cs450 exception, which should be a substruct of exn:fail:syntax, and an appropriate error message.
exn:fail:syntax:cs450? : predicate evaluates to true if given a exn:fail:syntax:cs450 struct instance
AST? : predicate that evaluates to true for AST data definition values
run : takes an AST tree and "runs" it, to produce a Result "result"
As mentioned in lecture, the semantics of the language, e.g., "adding" or "multiplying" Booleans, Strings, etc., should follow JavaScript semantics. When in doubt, we will use the repljs.com evaluator as the official specification for the behavior of arithmetic on all kinds of values in our new programming language.
Some more specific semantic specifications:Arithmetic (e.g., plus or times) of strings has some interesting corner cases so you’ll want to have ample examples and tests here. Some examples to check: addition of non-number strings, e.g. "hello"; addition of number strings, e.g., "one"; different combinations of data types, e.g., addition of strings and bools, etc.; and multiplication of the same examples (which may not always have the same behavior as plus).
When attempting to perform an arithmetic operation that is unsupported, the result should be NaN, which is a constant you must define. NaN should be unique, meaning that it should not be equal to any other Result value. (A singleton pattern could be useful here.) Since the language can have nested operations, this means that the input to primtive functions can also be NaN and this needs to be handled.
The "test" part of an iffy expression should follow "truthy" semantics. This means that the result of the test may be a non-boolean which should be interpreted in the same way as JavaScript, and the appropriate branch should be taken in these cases.
The ~= operator implements a "loose equality". We will use the semantics of JavaScript’s == operator to dictate the behavior of our equality operator, so you should look into that. You may find this table which summarizes some corner cases for JS == useful.
NaN? : predicate that evaluates to true when given the NaN result value
Before Submitting
Testing (and Autograders)
Before submitting, note:
Do not submit until all code has been thoroughly tested (by you), which means writing a "sufficient" number of Test cases.
A GradeScope "Autograder" may or may not be released before the due date but either way, an Autograder is not a software development/testing tool, so do not use it as one. Code must be tested independent of any Autograder and questions about Autograders will be ignored (e.g., posts asking "why is the Autograder giving an error?" are not allowed)
If you do submit before the deadline and get an Autograder error, this is bonus information that indicates the submitted code is not complete and/or not correct. But it’s up to you to figure out what "correct" means and how to fix to the program.
Of course, the course staff is here and eager to help, but cannot do so without context information. The best way to supply this information is to INCLUDE EXAMPLES WITH ALL QUESTIONS, along with what the "expected" result should be! The posted examples should be the minimal amount of code needed to communicate the problem. This will receive the clearest possible answer.
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:
hw10.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 hw10.rkt and define tests for it.
Specifically, it should define a rackunit test-suite named TESTS 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 hw10. 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.)