The Way of the Java/Conditionals graphics recursion

Conditionals, graphics and recursion

The modulus operator

The modulus operator works on integers (and integer expressions) and yields the remainder when the first operand is divided by the second. In Java, the modulus operator is a percent sign, %. The syntax is exactly the same as for other operators:

 int quotient = 7 / 3;
 int remainder = 7 % 3;

The first operator, integer division, yields 2. The second operator yields 1. Thus, 7 divided by 3 is 2 with 1 left over.

The modulus operator turns out to be surprisingly useful. For example, you can check whether one number is divisible by another: if x%y is zero, then x is divisible by y.

Also, you can use the modulus operator to extract the rightmost digit or digits from a number. For example, x % 10 yields the rightmost digit of x (in base 10). Similarly x % 100 yields the last two digits.

Conditional execution

In order to write useful programs, we almost always need the ability to check certain conditions and change the behavior of the program accordingly. Conditional statements give us this ability. The simplest form is the if statement:

 if (x > 0)
   System.out.println ("x is positive");

The expression in parentheses is called the condition. If it is true, then the statements in brackets get executed. If the condition is not true, nothing happens.

The condition can contain any of the comparison operators, sometimes called relational operators:

 x == y               // x equals y
 x != y               // x is not equal to y
 x > y                // x is greater than y
 x < y                // x is less than y
 x >= y               // x is greater than or equal to y
 x <= y               // x is less than or equal to y

A common error is to use a single = instead of a double ==. Remember that = is the assignment operator, and == is a comparison operator. Also, there is no such thing as =< or =>.

The two sides of a condition operator have to be the same type. You can only compare ints to ints and doubles to doubles. Unfortunately, at this point you cannot compare Strings at all! There is a way to compare Strings, but we won't get to it for a couple of chapters.

Alternative execution

A second form of conditional execution is alternative execution, in which there are two possibilities, and the condition determines which one gets executed. The syntax looks like:

 if (x%2==0)
   System.out.println ("x is even");
 else
   System.out.println ("x is odd");

If the remainder when x is divided by 2 is zero, then we know that x is even, and this code prints a message to that effect. If the condition is false, the second print statement is executed. Since the condition must be true or false, exactly one of the alternatives will be executed.

As an aside, if you think you might want to check the parity (evenness or oddness) of numbers often, you might want to "wrap" this code up in a method, as follows:

 public static void printParity (int x)
   if (x%2==0)
     System.out.println ("x is even");
    else
     System.out.println ("x is odd");

Now you have a method named printParity that will print an appropriate message for any integer you care to provide. In main you would invoke this method as follows:

 printParity (17);

Always remember that when you invoke a method, you do not have to declare the types of the arguments you provide. Java can figure out what type they are. You should resist the temptation to write things like:

 int number = 17;
 printParity (int number);         // output: "x is odd"

Chained conditionals

Sometimes you want to check for a number of related conditions and choose one of several actions. One way to do this is by chaining a series of ifs and elses:

 if (x > 0)
   System.out.println ("x is positive");
 else if (x < 0)
   System.out.println ("x is negative");
 else
   System.out.println ("x is zero");

These chains can be as long as you want, although they can be difficult to read if they get out of hand. One way to make them easier to read is to use standard indentation, as demonstrated in these examples. If you keep all the statements and squiggly-brackets lined up, you are less likely to make syntax errors and you can find them more quickly if you do.

Nested conditionals

In addition to chaining, you can also nest one conditional within another. We could have written the previous example as:

 if (x == 0)
   System.out.println ("x is zero");
 else
   if (x > 0)
     System.out.println ("x is positive");
   else
     System.out.println ("x is negative");

There is now an outer conditional that contains two branches. The first branch contains a simple print statement, but the second branch contains another conditional statement, which has two branches of its own. Fortunately, those two branches are both print statements, although they could have been conditional statements as well.

Notice again that indentation helps make the structure apparent, but nevertheless, nested conditionals get difficult to read very quickly. In general, it is a good idea to avoid them when you can.

On the other hand, this kind of nested structure is common, and we will see it again, so you better get used to it.

The return statement

The return statement allows you to terminate the execution of a method before you reach the end. One reason to use it is if you detect an error condition:

 public static void printLogarithm (double x)
   if (x <= 0.0)
     System.out.println ("Positive numbers only, please.");
     return;
   
   double result = Math.log (x);
   System.out.println ("The log of x is " + result);

This defines a method named printLogarithm that takes a double named x as a parameter. The first thing it does is check whether x is less than or equal to zero, in which case it prints an error message and then uses return to exit the method. The flow of execution immediately returns to the caller and the remaining lines of the method are not executed.

I used a floating-point value on the right side of the condition because there is a floating-point variable on the left.

Type conversion

You might wonder how you can get away with an expression like "The log of x is " + result, since one of the operands is a String and the other is a double. Well, in this case Java is being smart on our behalf, by automatically converting the double to a String before it does the string concatenation.

This kind of feature is an example of a common problem in designing a programming language, which is that there is a conflict between formalism, which is the requirement that formal languages should have simple rules with few exceptions, and convenience, which is the requirement that programming languages be easy to use in practice.

More often than not, convenience wins, which is usually good for expert programmers (who are spared from rigorous but unwieldy formalism), but bad for beginning programmers, who are often baffled by the complexity of the rules and the number of exceptions. In this book I have tried to simplify things by emphasizing the rules and omitting many of the exceptions.

Nevertheless, it is handy to know that whenever you try to "add" two expressions, if one of them is a String, then Java will convert the other to a String and then perform string concatenation. What do you think happens if you perform an operation between an integer and a floating-point value?

Slates and Graphics objects

In order to draw things on the screen, you need two objects, a Slate and a Graphics object.

• Slate: a Slate is a window that contains a blank rectangle you can draw on. The Slate class is not part of the standard Java library; it is something I wrote for this course.
• Graphics: the Graphics object is the object we will use to draw lines, circles, etc. It is part of the Java library, so the documentation for it is on the Sun web site.

The methods that pertain to Graphics objects are defined in the built-in Graphics class. The methods that pertain to Slates are defined in the Slate class, which is shown in Appendix slate.

The primary method in the Slate class is makeSlate, which does pretty much what you would expect. It creates a new window and returns a Slate object you can use to refer to the window later in the program. You can create more than one Slate in a single program.

 Slate slate = Slate.makeSlate (500, 500);

makeSlate takes two arguments, the width and height of the window. Because it belongs to a different class, we have to specify the name of the class using dot notation.

The return value gets assigned to a variable named slate. There is no conflict between the name of the class (with an upper-case S) and the name of the variable (with a lower-case s).

The next method we need is getGraphics, which takes a Slate object and creates a Graphics object that can draw on it. You can think of a Graphics object as a piece of chalk.

 Graphics g = Slate.getGraphics (slate);

Using the name g is conventional, but we could have called it anything.

Invoking methods on a Graphics object

setColor

In order to draw things on the screen, you invoke methods on the graphics object. We have invoked lots of methods already, but this is the first time we have invoked a method on an object. The syntax is similar to invoking a method from another class:

 g.setColor (Color.black);
 g.drawOval (x, y, width, height);

The name of the object comes before the dot; the name of the method comes after, followed by the arguments for that method. In this case, the method takes a single argument, which is a color.

setColor changes the current color, in this case to black. Everything that gets drawn will be black, until we use setColor again.

Color.black is a special value provided by the Color class, just as Math.PI is a special value provided by the Math class. Color, you will be happy to hear, provides a palette of other colors, including:

black     blue    cyan   darkGray   gray   lightGray
magenta	  orange  pink   red        white  yellow

drawOval

To draw on the Slate, we can invoke draw methods on the Graphics object. For example:

 g.drawOval (x, y, width, height);

drawOval takes four integers as arguments. These arguments specify a bounding box, which is the rectangle in which the oval will be drawn (as shown in the figure). The bounding box itself is not drawn; only the oval is. The bounding box is like a guideline. Bounding boxes are always oriented horizontally or vertically; they are never at a funny angle.

bounding box

If you think about it, there are lots of ways to specify the location and size of a rectangle. You could give the location of the center or any of the corners, along with the height and width. Or, you could give the location of opposing corners. The choice is arbitrary, but in any case it will require the same number of parameters: four.

By convention, the usual way to specify a bounding box is to give the location of the upper-left corner and the width and height. The usual way to specify a location is to use a coordinate system.

You are probably familiar with Cartesian coordinates in two dimensions, in which each location is identified by an x-coordinate (distance along the x-axis) and a y-coordinate. By convention, Cartesian coordinates increase to the right and up, as shown in the figure.

Annoyingly, it is conventional for computer graphics systems to use a variation on Cartesian coordinates in which the origin is in the upper-left corner of the screen or window, and the direction of the positive y-axis is down. Java follows this convention.

pixel

The unit of measure is called a pixel; a typical screen is about 1000 pixels wide. Coordinates are always integers. If you want to use a floating-point value as a coordinate, you have to round it off to an integer (See Section rounding).

A lame Mickey Mouse

Let's say we want to draw a picture of Mickey Mouse. We can use the oval we just drew as the face, and then add ears. Before we do that it is a good idea to break the program up into two methods. main will create the Slate and Graphics objects and then invoke draw, which does the actual drawing.

 public static void main (String[] args)
   int width = 500;
   int height = 500;
   
   Slate slate = Slate.makeSlate (width, height);
   Graphics g = Slate.getGraphics (slate);
   
   g.setColor (Color.black);
   draw (g, 0, 0, width, height);
   
 public static void draw (Graphics g, int x, int y, int width, int height)
   g.drawOval (x, y, width, height);
   g.drawOval (x, y, width/2, height/2);
   g.drawOval (x+width/2, y, width/2, height/2);

The parameters for draw are the Graphics object and a bounding box. draw invokes drawOval three times, to draw Mickey's face and two ears. The following figure shows the bounding boxes for the ears.

 /-\ /-\
|  | |  |
 \ / \ /
  /---\
 |     |
  \___/

As shown in the figure, the coordinates of the upper-left corner of the bounding box for the left ear are (x, y). The coordinates for the right ear are (x+width/2, y). In both cases, the width and height of the ears are half the width and height of the original bounding box.

Notice that the coordinates of the ear boxes are all relative to the location (x and y) and size (width and height) of the original bounding box. As a result, we can use draw to draw a Mickey Mouse (albeit a lame one) anywhere on the screen in any size. As an exercise, modify the arguments passed to draw so that Mickey is one half the height and width of the screen, and centered.

Other drawing commands

prototype

drawLine
drawRect
fillOval
fillRect
prototype
interface

drawRect, drawLine

Another drawing command with the same parameters as drawOval is:

 drawRect (int x, int y, int width, int height)

Here I am using a standard format for documenting the name and parameters of methods. This information is sometimes called the method's interface or prototype. Looking at this prototype, you can tell what types the parameters are and (based on their names) infer what they do. Here is another example:

 drawLine (int x1, int y1, int x2, int y2)

The use of parameter names x1, x2, y1 and y2 suggests that drawLine draws a line from the point (x1, y1) to the point (x2, y2).

One other command you might want to try is:

 drawRoundRect (int x, int y, int width, int height,
	        int arcWidth, int arcHeight)

The first four parameters specify the bounding box of the rectangle; the remaining two parameters indicate how rounded the corners should be, specifying the horizontal and vertical diameter of the arcs at the corners.

fillRect, fillOval

There are also fill versions of these commands, that not only draw the outline of a shape, but also fill it in. The interfaces are identical; only the names have been changed:

 fillOval (int x, int y, int width, int height)
 fillRect (int x, int y, int width, int height)
 fillRoundRect (int x, int y, int width, int height,
	        int arcWidth, int arcHeight)

There is no such thing as fillLine—it just does not make sense as lines are one-dimensional.

Recursion

I mentioned in the last chapter that it is legal for one method to call another, and we have seen several examples of that. I neglected to mention that it is also legal for a method to invoke itself. It may not be obvious why that is a good thing, but it turns out to be one of the most magical and interesting things a program can do.

For example, look at the following method:
 public static void countdown (int n)
   if (n == 0)
     System.out.println ("Blastoff!");
   else
     System.out.println (n);
     countdown (n-1);

The name of the method is countdown and it takes a single integer as a parameter. If the parameter is zero, it prints the word Blastoff. Otherwise, it prints the number and then invokes a method named countdown—itself—passing n-1 as an argument.

What happens if we invoke this method, in main, like this:

 countdown (3);

1. The execution of countdown begins with n=3, and since n is not zero, it prints the value 3, and then invokes itself, passing 3-1...
2. The execution of countdown begins with n=2, and since n is not zero, it prints the value 2, and then invokes itself, passing 2-1...
3. The execution of countdown begins with n=1, and since n is not zero, it prints the value 1, and then invokes itself, passing 1-1...
4. The execution of countdown begins with n=0, and since n is zero, it prints the word Blastoff! and then returns.
5. The countdown that got n=1 returns.
6. The countdown that got n=2 returns.
7. The countdown that got n=3 returns.

And then you are back in main (what a trip). So the total output looks like:

3
2
1
Blastoff!

As a second example, let's look again at the methods newLine and threeLine.

 public static void newLine ()
   System.out.println ("");
 
 public static void threeLine ()
   newLine ();  newLine ();  newLine ();

verbatim

Although these work, they would not be much help if I wanted to print 2 newlines, or 106. A better alternative would be:

 public static void nLines (int n)
   if (n > 0)
     System.out.println ("");
     nLines (n-1);

This program is very similar; as long as n is greater than zero, it prints one newline, and then invokes itself to print n-1 additional newlines. Thus, the total number of newlines that get printed is 1 + (n-1), which usually comes out to roughly n.

The process of a method invoking itself is called recursion, and such methods are said to be recursive.

Stack diagrams for recursive methods

In the previous chapter we used a stack diagram to represent the state of a program during a method call. The same kind of diagram can make it easier to interpret a recursive method.

Remember that every time a method gets called it creates a new instance of the method that contains a new version of the method's local variables and parameters.

There is one instance of main and four instances of countdown, each with a different value for the parameter n. The bottom of the stack, countdown with n=0 is the base case. It does not make a recursive call, so there are no more instances of countdown.

The instance of main is empty because main does not have any parameters or local variables. As an exercise, draw a stack diagram for nLines, invoked with the parameter n=4.

Convention and divine law

In the last few sections, I used the phrase by convention several times to indicate design decisions that are arbitrary in the sense that there are no significant reasons to do things one way or another, but dictated by convention.

In these cases, it is to your advantage to be familiar with convention and use it, since it will make your programs easier for others to understand. At the same time, it is important to distinguish between (at least) three kinds of rules:

• Divine law This is my phrase to indicate a rule that is true because of some underlying principle of logic or mathematics, and that is true in any programming language (or other formal system). For example, there is no way to specify the location and size of a bounding box using fewer than four pieces of information. Another example is that adding integers is commutative. That is part of the definition of addition and has nothing to do with Java.
• Rules of Java These are the syntactic and semantic rules of Java that you cannot violate, because the resulting program will not compile or run. Some are arbitrary; for example, the fact that the + symbol represents addition and string concatenation. Others reflect underlying limitations of the compilation or execution process. For example, you have to specify the types of parameters, but not arguments.
• Style and convention There are a lot of rules that are not enforced by the compiler, but that are essential for writing programs that are correct, that you can debug and modify, and that others can read. Examples include indentation and the placement of squiggly braces, as well as conventions for naming variables, methods and classes.

As we go along, I will try to indicate which category various things fall into, but you might want to give it some thought from time to time.

While I am on the topic, you have probably figured out by now that the names of classes always begin with a capital letter, but variables and methods begin with lower case. If a name includes more than one word, you usually capitalize the first letter of each word, as in newLine and printParity. Which category are these rules in?

Glossary

• modulus An operator that works on integers and yields the remainder when one number is divided by another. In Java it is denoted with a percent sign ().
• conditional A block of statements that may or may not be executed depending on some condition.
• chaining A way of joining several conditional statements in sequence.
• nesting Putting a conditional statement inside one or both branches of another conditional statement.
• coordinate A variable or value that specifies a location in a two-dimensional graphical window.
• pixel The unit in which coordinates are measured.
• bounding box A common way to specify the coordinates of a rectangular area.
• typecast An operator that converts from one type to another. In Java it appears as a type name in parentheses, like (int).
• interface A description of the parameters required by a method and their types.
• prototype A way of describing the interface to a method using Java-like syntax.
• recursion The process of invoking the same method you are currently executing.
• infinite recursion A method that invokes itself recursively without ever reaching the base case. The usual result is a StackOverflowException.
• fractal A kind of image that is defined recursively, so that each part of the image is a smaller version of the whole.