CS173: Intro to Computer Science - Averaging Functions (100 Points)

Assignment Goals

The goals of this assignment are:

To develop functions to abstract program concepts

Background Reading and References

Please refer to the following readings and examples offering templates to help get you started:

Functions Activity

The Assignment

In this lab, you will develop and use functions to modularize and re-use your code.

Background

Consider the grading table of our course syllabus. It lists grading weights for each component of the course (for example, programming assignments). To compute your course grade, you would first average all your programming assignment grades together, and all the other grade component averages. To compute the assignment average \(\mu_{x}\), take the sum of each of your \(n\) assignment scores \(x_{i}\), and divide by the number of assignments, as follows:

\(\mu_{x} = \frac{\sum\limits_{i=1}^{n} x_{i}}{n}\)

For example, suppose your assignment grades are 100, 75, and 80. Your average assignment grade is the equally-weighted average:

\((1.0 + 0.75 + 0.80) / 3 = ((1.0 * 0.333) + (0.75 * 0.333) + (0.80 * 0.333)) = 0.85\) (or 85%)

Note that I converted each grade to a double; I did this by dividing each one by 100.0. This ensures that I am using floating point division throughout my program, and not integer division, in my calculations! I suggest you do this as well. Before you return your result, you can multiply by 100.0 again so that your grade is on a scale from 0 to 100.

Then, those averages are averaged - but not equally. The weighted average is computed by multiplying each of your component averages by a weight \(w_{i}\), given by the syllabus (for example, a 50% weight would be computed as 0.5 for that corresponding \(w_{i}\)):

\(\mu_{x} = \sum\limits_{i=1}^{n} w_{i} x_{i}\)

This is actually the same as the standard equally-weighted average, where \(w_{i}\) is \(\frac{1}{n}\), giving equal weight to all the components.

For example, suppose assignments had a weight of 40%, and labs had a weight of 60%. If your overall assignment grade is an 80%, and your overall lab grade is a 90%, your grade formula would be:

\(0.4 \times 0.8 + 0.6 \times 0.9 = 0.32 + 0.54 = 0.86\) (or 86%)

Part 1: Computing a Course Grade from a Weighted Average

In this lab, you will create a program that assigns variable values to labs, assignments, etc., according to the syllabus grade breakdown. Then, you will compute your average lab grade, average assignment grade, etc., using equal weighted averaging (by adding up all the grades and dividing by the number of grades). Then, you will take those computed averages, and compute a weighted average of them, using a weighted average (by multiplying each score by the weight of that score, and adding those products together). You will print out your final grade.

You can make up grades for these as an example, and it is fine to only consider labs and assignments. Use a 60% weight for assignments and a 40% weight for labs (these are not the actual weights in our course, but will be fine for an example!).

It is nice to be able to compute these averages without having to do so by hand, but you probably noticed how tedious is was to copy and paste, or re-write, your averaging code over and over again! We can use functions to reduce this workload.

Computing an Equally-Weighted Average of Individual Grades

Write a function computeEqualAverage that returns a double, and accepts doubles for your individual grades. Modify your program so that you replace your equal-weight averaging with calls to this function. Pass your individual grades as parameters to this function. For this example, let’s suppose you have three grades to compute (and, thus, three double parameters to this function). This function adds up the grades and divides by the number of grades.

This function goes outside of your main() function, but inside of your class curly braces, and will look like this:

public static double computeEqualAverage(double grade1, double grade2, double grade3) {
    // compute the average of grade1, grade2, grade3 here, and return that value
}

Your formula should look something like this:

\((grade1 + grade2 + grade3) / 3.0\)

Computing a Weighted Average of these Averages

Now, write a function computeWeightedAverage that also returns a double, and accepts doubles for your course averages as well as the weights (since there is a lab average and an assignment average, and each has a weight, you should have four double parameters to this function). This function multiplies each grade by its corresponding weight, and adds the resulting products together. Your formula should look something like this:

\(weight1 \times grade1 + weight2 \times grade2\)

Putting it all Together: Calling these Functions to Compute a Course Final Grade

Finally, write the body of your main() function to call the equal average function twice (once for assignments and once for labs), and then to pass those results as parameters to a call to the weight average function. Specifically, you can call the computeEqualAverage function to obtain your assignment average and to obtain your lab average, and then call computeWeightedAverage to weight them. For example, once your two functions (computeEqualAverage and computeWeightedAverage) are written, you could call them as follows:

// suppose our assignment grades were 60, 90, and 80: you should get approximately 76.667 as the average
double assignmentAverage = computeEqualAverage(60, 90, 80); 

// suppose the lab grades were 80, 90, and 80: you should get approximately 83.333 as the average
double labAverage = computeEqualAverage(80, 90, 80); 

// the assignment weight is 60% and the lab weight is 40%.  You should get approximately 79.333 as the total grade.
double finalGrade = computeWeightedAverage(assignmentAverage, 0.6, labAverage, 0.4); 

Merging the Averaging Functions into a Generalized Function

This program should be much shorter than if you had duplicated all the code to compute these averages! However, there is still some redundancy. The two average functions are still essentially the same algorithm and perhaps essentially the same code.

Write a function called computeAverage that returns a double and accepts the individual values as parameters, like the others. This time, add individual double paramters for the weights. You will have a total of 6 parameters: 3 grade parameters, and 3 weight parameters. Replace your call to computeWeightedAverage with a call to this function, passing the appropriate weights. If you are only using assignments and labs for your averages, you will only have four values to pass to comptueAverage rather than 6. You can pass 0 for the third grade and weight parameter, which will give the last zero a weight of 0, having no effect.

Finally, replace your call to computeEqualAverage with a call to computeAverage, passing the appropriate weights there as well (what should the weights be when computing an equal-weight average? Hint: the three weights should be the same!).

Commenting Your Code

It is important to comment your code so that your users (and you!) will easily see how to use the functions that you’ve written. After all, part of the purpose of writing modular code like functions is that you can re-use your code later! In practice, it is common to share code with peers and the general public as well. The Style Guide describes a best practice for documenting functions: there is a standard format called Javadoc, in which each function has a comment at the top that describes the function’s behavior, its inputs, and its return value. This is a nice place to put any assumptions you’ve made about your code, too - for example, that your weights should add up to 1.

You can create a Javadoc comment for a function very easily – click on the blank line above one of your functions, type /**, and hit enter. It will automatically fill in a template that you can type your details into, including a line for each parameter and the return value. Write a Javadoc for each function you’ve written in this lab.

Finishing Touches and Writeup

Don’t forget to test your program with several different inputs to help verify that things work the way you expect! Think in terms of trying to break your program; if it’s really hard to “trick” your program into getting the wrong answer, you’ve probably done a good job making your code robust.

Also, check the Style Guide to make sure that you’ve written high quality code; make sure your code is “readable,” well indented, uses good variable names, and includes good comments throughout the program.

When you’re done, write a README for your project, and save all your files, before exporting your project to ZIP. In your README, answer any bolded questions presented on this page. In addition, write a few paragraphs describing what you did, how you did it, and how to use your program. If your program requires the user to type something in, describe that here. If you wrote functions to help solve your problem, what are they, and what do they do? Imagine that you are giving your program to another student in the class, and you want to explain to them how to use it. What would you tell them? Imagine also that another student had given you the functions that you wrote for your program: what would you have wished that you knew about how to call those functions?

Exporting your Project for Submission

Here is a video tutorial describing how to write a README for your project, and how to export it. Be sure to save your README file before exporting the project, so that your work is included in the submission!

Submission

In your submission, please include answers to any questions asked on the assignment page in your README file. If you wrote code as part of this assignment, please describe your design, approach, and implementation in your README file as well. Finally, include answers to the following questions:

Describe what you did, how you did it, what challenges you encountered, and how you solved them.
Please answer any questions found throughout the narrative of this assignment.
If collaboration with a buddy was permitted, did you work with a buddy on this assignment? If so, who? If not, do you certify that this submission represents your own original work?
Please identify any and all portions of your submission that were not originally written by you (for example, code originally written by your buddy, or anything taken or adapted from a non-classroom resource). It is always OK to use your textbook and instructor notes; however, you are certifying that any portions not designated as coming from an outside person or source are your own original work.
Approximately how many hours it took you to finish this assignment (I will not judge you for this at all...I am simply using it to gauge if the assignments are too easy or hard)?
Your overall impression of the assignment. Did you love it, hate it, or were you neutral? One word answers are fine, but if you have any suggestions for the future let me know.
Any other concerns that you have. For instance, if you have a bug that you were unable to solve but you made progress, write that here. The more you articulate the problem the more partial credit you will receive (it is fine to leave this blank).

Assignment Rubric

Description	Pre-Emerging (< 50%)	Beginning (50%)	Progressing (85%)	Proficient (100%)
Algorithm Implementation (60%)	The algorithm fails on the test inputs due to major issues, or the program fails to compile and/or run	The algorithm fails on the test inputs due to one or more minor issues	The algorithm is implemented to solve the problem correctly according to given test inputs, but would fail if executed in a general case due to a minor issue or omission in the algorithm design or implementation	A reasonable algorithm is implemented to solve the problem which correctly solves the problem according to the given test inputs, and would be reasonably expected to solve the problem in the general case
Code Indentation and Spacing (10%)	Code indentation and spacing are generally inappropriate or inconsistent	Code indentation or spacing are generally appropriate but inconsistent in a few isolated instances	Code indentation or spacing are appropriate or consistent, with minor adjustments needed	Code indentation and spacing are appropriate and consistent
Code Quality (10%)	Prior code quality feedback and style guide standards are not reflected in the submitted code to a great extent	Code quality conforms to several standards in the course Style Guide, and progress is demonstrated in improving code quality from prior feedback	Code quality conforms to the standards in the course Style Guide to a great extent, with a few identified areas of improvement	Code quality substantially conforms to the standards in the course Style Guide
Code Documentation (10%)	Code commenting and structure are absent, or code structure departs significantly from best practice	Code commenting and structure is limited in ways that reduce the readability of the program; specifically, javadoc style comments are present for some functions	Code documentation is present that re-states the explicit code definitions	Code is documented at non-trivial points in a manner that enhances the readability of the program; specifically, javadoc style comments are present for all functions
Writeup and Submission (10%)	An incomplete submission is provided, or the README file submitted is blank	The program is submitted, but not according to the directions in one or more ways (for example, because it is lacking a readme writeup or missing answers to written questions)	The program is submitted according to the directions with a minor omission or correction needed, including a readme writeup describing the solution and answering nearly all questions posed in the instructions	The program is submitted according to the directions, including a readme writeup describing the solution and answering all questions posed in the instructions

Please refer to the Style Guide for code quality examples and guidelines.