MA117 Programming for Scientists: Project 1 Circles on a Plane

Administrative Details

.  This project is the first of the three assignments required for the assessment in this course. Details of the method of the submission via the Moodle system have been described in the lecture notes and are also available on the course web page.

.  This assignment will count for 25% of your total grade in the course.

.  The automated submission system requires that you closely follow instructions about the format of certain files; failure to do so will result in the severe loss of points in this assessment.

.  You may work on the assignment during the lab session, provided you have completed the other tasks that have been set. You can always use the work areas when they are not booked for teaching, and they are open. If you are working on the assignment on your home system you are advised to make regular back-up copies (for example by transferring the files to the  University systems).  NOTE: no allowance will be made for domestic disasters involving your own computer system. You should make sure well ahead of the deadline that you are able to transfer all necessary files to the University system and that it works there as well.

.  Remember that all work you submit should be your own work. Do not be tempted to copy work; this assignment is not a team exercise. There are both human and automated techniques to detect pieces of the code which have been copied from others. If you are stuck, then ask for assistance in the lab sessions. TAs will not complete the exercise for you, but they will help if you do not understand the problem, are confused by an error message, need advice on how to debug the code, require further explanation of a feature of Java or similar matters.

.  If you have more general or administrative problems e-mail me immediately. Always include the course number (MA117) in the subject of your e-mail.

1     Formulation of the Problem

This  assignment focuses  neither  on  mathematical/modelling  issues  nor  on  any  advanced  techniques  in scientific computing.  It will test your ability to write a simple Java code consisting of a few classes and manipulate  simple  data  structures.  Remember  that  marks  are  available  for  properly  documenting  and structuring your code.

You are given a set of data stored in a text (ASCII) file.  Each  line  in this file stores 3  real numbers that represent:

.  the coordinates (x, y) of a point in the plane and

.  a radius T of the circle with the centre at that point.

Hence each line in the file represents a circle in the plane. Your task is to write a code which will analyse this set of circles. The number of lines in the file is 40 ≤   lines  ≤  5000.  The statistical analysis required in this step is very simple and does not require any sophisticated techniques. The information you want to extract from this set of data is:

•  Project1.java in which you will use Circle and Point to process the data file.

•   student.data contains the data set you are supposed to analyse. This file is rather large so for testing you may want to experiment with your own smaller data set, which may also allow you to test different aspects of your code.

•  You can create such a file easily in any text editor (but not a word processor). Each circle is defined on a single line in this file, and it contains three numbers: coordinates x , y  , and the radius T .

•  All decimal values should be formatted to 9 decimal places (i.e. %.9f)

Finally, there is the file ReadFile.java, which is not explicitly part of Project 1. It is a piece of example code which documents using the Scanner class to read in the data from a file and find the maximum and minimum of that data. You should not submit it.

2.1       The Point class

The Point class will contain:

1.  private variables  double X, Y, that store the  co-ordinates of the point  represented by an instance of this class.

2.  All of the standard methods that we identified in the previous exercises as necessary for usual classes of the similar type. In particular: constructors, setters, getters, converters, and the method equals which allows us to compare two Points.

In  particular,  the   comparison  between  two   points   is  important,  and  different  from  the   usual mathematical notion of equality. Due to the way that floating point numbers are stored in computer memory, we never usually test whether two floating point numbers are equal; just whether they are ‘close’ to within an arbitrarily chosen tolerance. You should have seen examples of this in the week 13 lab notes.

Given two points (x1, y1) and (x2, y2) we say that they are equal in our model if and only if |x1− x2| ≤ Δ and  |y1− y2| ≤ Δ .  The  quantity ∆  is  named  GEOMTOL in  the  Point  class  and  it  is  defined  as public, final and static. In your computations the value of this variable should be 10-6.

Moreover, whenever you test for equality that involves two of the geometric objects in this project, you will allow for the tolerance ∆. For example, to test that the distance between two points d(A, B) is equal to a certain value a you would evaluate |d(A, B)  −  a |   ≤  ∆ .

3.  Implement the  method  distance  that  computes the  Euclidean  distance  between  two  points x   = (x1, y1) andy  =  (x2, y2), which is defined as

4.  You can, and in fact should, also include a tester (as the method main) for the methods as usual. See week 14 lecture notes for more information on this.

2.2       The Circle class

While the methods in the class Point are rather standard, for the class which defines instances for circles you need to do more work.

1.  You should start by defining two private variables: Point A and double r which store the centre and the radius of the circle.

2.  You then have to define all standard method as above in the class Point, i.e., constructors, setters, getters and converters.  Read carefully instructions in the file  Circle.java as they explain the names of each of these methods, along with their expected behaviour.

3.  The method equals that compares two circles. Obviously, two circles are equal if they have identical (within the tolerance Δ) centres and radii.

The  core  of  this  class  are  methods  that  actually  implement  functions  needed  for  the  circles.  In particular, in this exercise you will need the area method: area simply computes and returns the area of the circle.

2.3          The Project1 class

This class will perform the statistical analysis of the data and should produce the results you are asked to perform in the formulation. You must design and implement the core method results and some additional methods which will calculate all the quantities outlined in the formulation above. The results method takes the argument fileName, which contains the name of the file from which the data will be entered. An example how to read the data from the given file is provided in a file ReadData.java, which suggests how you can read data from the start of a file until the end of the file.

Within results(), you should not print anything to the screen with System.out.println. Instead, you should store the results in the predefined public variables at the top of the class:

.  int circleCounter: The number of (non-singular) circles in the file.

.  double[] aabb: The 4 doubles representing x1, y1, x2, y2 of the axis-aligned bounding box.

.  double Smax: The maximum area Smax.

.  double Smin: The minimum area Smin.

.  double areaAverage: The average area µ .

.  double areaSD: The standard deviation of the areas.

.  double areaMedian: The median of the areas.

Remember: do not to change the names or types of any of these variables.

Hint: While most of the implementation is straightforward, one task requires a bit more algorithmic thinking. Let A with 0  ≤  i  <  N be an increasing sequence (Ai + 1   ≥  A  , ∀i) which represents a data set which is sorted. Then the median  if N is odd or  if N is even. Hence you will need to

store areas of entered circles into an array and then sort the array. We will cover this topic in week 16, but you should try and figure this out for yourself first!