2. EXAMPLE PROBLEM CIRCLE CALCULATION

2.1 Requirements

To produce a program that calculates and outputs the circumference and area of a circle given its radius. Assume "PI" is equivalent to 3.14159 and that the radius is input by the user as a floating point number. Area of a circle = PI x diameter = 2 x PI x radius, and Circumference = PI x radius^2.

2.2 Design

Adopting a top down analysis approach to the above problem:

we can identify several operations. These operations are simple enough to be wrapped up into a single procedure -

1. CIRCLE_CALC (top level procedure) - Input radius, and calculate and output circumference and area.

Note that the procedure will need to include definitions for two data items: (1) the constant PI and (2) a variable in which to hold the input. It is a good idea to define the nature of data items required bu a procedure in a tabular format (even if there is only 1) as this information is required for testing purposes:

The detailed design for this procedure is given by the N-S chart to the right.

2.3. Implementation

-- CIRCLE CALCULATION
-- 7 August 1997
-- Frans Coenen
-- Dept Computer Science, University of Liverpool

with CS_IO;
use CS_IO;

procedure CIRCLE_CALC is
        PI: constant := 3.14;
        RADIUS: FLOAT;
begin
        PUT_LINE("Input radius: ");
        GET(RADIUS);
-- Calculate circumference using 2xPIxRadius
        PUT("The circumference is: ");
        put(2.0*PI*RADIUS, FORE => 3, AFT => 4, EXP => 0);
        NEW_LINE;
-- Calculate area using PIxRadius^2
        PUT("The area is: ");
        put(PI*RADIUS**2, FORE => 3, AFT => 4, EXP => 0);
        NEW_LINE;
end CIRCLE_CALC;

Some points to note about the above code:

• In the declaration section with have two data declarations:
  1. The first is a constant of type FLOAT which has been initialised with the value 3.14.
  2. The second is an uninitialised variable.
• The first "put" includes the sum 2.0*PI*RADIUS and not 2*PI*RADIUS because Ada does not support mixed mode arithmetic (2 is interpreted as an integer while 2.0 is interpreted as a real number).
• PUT statements of the form:

  PUT(REAL_VALUE, FORE=>N, AFT=>M, EXP=>0);
  

  indicate the format for the output of real values, N and M give the number of figures before or after the decimal point. If we simply write:

  PUT(REAL_VALUE);
  

  The output will be in scientific notation. For example:

  Input radius:
  10.0
  The circumference is:  6.28000000000000E+01
  The area is:  3.14000000000000E+02
  

  which should be interpreted as 6.28x10^1 (62.8) and 3.14x10^2 (314) respectively.
• The ** operator is the exponential operator, i.e. RADIUS**2 is equivalent to RADIUS*RADIUS. Note that the exponential value (the 2nd operand) is always an integer type.

2.4. Testing

Arithmetic testing: Test using negative, positive and zero input values for RADIUS as shown in the table (right). Note that when we input a negative number we produce a negative circumference - this is probably not the desired result and thus we should return to the requirements phase and determine what action we should take in the event of a negative radius - (a) error, (b) convert to a positive number, (c) ... ?

Data validation testing: We should also include some tests using input data which id deliberately of the wrong type or to many inputs, no inputs etc.

5. EXAMPLE PROBLEM CYLINDER CALCULATION

5.1 Requirements

To produce a program that calculates the surface area and volume of a cylinder given its diameter and height. Assume "PI" is equivalent to 3.14 and that the diameter and height are input by the user as floating point numbers. Area of a cylinder = (2 x AreaOfEnd) + (AreaOfSide) = (2 x PI x (diameter/2)^2) + (height x PI x diameter), Volume of a cylinder = AreaOfEnd x height = (PI x (diameter/2)^2) x height.

5.2 Design

Using a top-down hierarchical decomposition approach we can identify the following, three-level, break-down of operations:

From the above we Note that the "calculate area of a circle" operation is repeated. This indicates that the operation would be better placed at a higher level:

Inspection of the above thus indicates five distinct operations at three different levels of abstraction. We will address the identified operations using five distinct functions/procedures as follows:

1. CYLINDER_CALC (Top level procedure): Input data and calls to AREA_OF_CIRCLE, AREA_OF_CYLINDER and VOLUME_OF_CYLINDER.

   NAME	USAGE	TYPE	RANGE
   PI	Global constant	FLOAT	3.15
   DIAMETER	Global variable	FLOAT	Default
   HEIGHT	Global variable	FLOAT	Default
   AREA	Global variable	FLOAT	Default

2. AREA_OF_CIRCLE (level 2 function) - calculate and return area of circle.

   NAME	USAGE	TYPE	RANGE
   RADIUS	Formal parameter	FLOAT	Default

3. AREA_OF_CYLINDER (level 2 procedure) - calculate and output area of cylinder. Call to CIRCUM_OF_CIRCLE.

   NAME	USAGE	TYPE	RANGE
   DIAMETER	Formal parameter	FLOAT	Default
   HEIGHT	Formal parameter	FLOAT	Default
   AREA	Formal parameter	FLOAT	Default
   CIRCUM	Local variable	FLOAT	Default

4. VOLUME_OF_CYLINDER (level 2 procedure) - calculate and output volume of cylinder.

   NAME	USAGE	TYPE	RANGE
   HEIGHT	Formal parameter	FLOAT	Default
   AREA	Formal parameter	FLOAT	Default

5. CIRCUM_OF_CIRCLE (level 3 function) - calculate and return circumference of circle.

   NAME	USAGE	TYPE	RANGE
   DIAMETER	Formal parameter	FLOAT	Default

The design detail required for each of these procedures is given by the Nassi-Shneiderman charts given below.

5.3. Implementation

Remember that we implement a top down analysis/design a level at a time commencing with the highest level. Where necessary calls to lower level procedures are implemented using stubs (partial implementations). The top level implementation might be as follows.

-- CYLINDER CALCULATION
-- 4 August 1997
-- Frans Coenen
-- Dept Computer Science, University of Liverpool

with TEXT_IO;
use TEXT_IO;

procedure CYLINDER_CALC is
        package FLOAT_INOUT is new FLOAT_IO(FLOAT);
        use FLOAT_INOUT;
        PI                     : CONSTANT FLOAT := 3.14;
        DIAMETER, HEIGHT, AREA : FLOAT;

        ------------------------------------------------------------------
        -- AREA OF CIRCLE function
        function AREA_OF_CIRCLE return FLOAT is
        begin
                PUT_LINE("Area of circle function");
                RETURN(1.0);
        end AREA_OF_CIRCLE;
        ------------------------------------------------------------------
        -- AREA OF CYLINDER procedure
        procedure AREA_OF_CYLINDER is
        begin
                PUT_LINE("Area of cylinder procedure");
        end  AREA_OF_CYLINDER;
        ------------------------------------------------------------------
        -- VOLUME OF CYLINDER procedure
        procedure VOLUME_OF_CYLINDER is
        begin
                PUT_LINE("Volume of cylinder procedure");
        end VOLUME_OF_CYLINDER;
        ------------------------------------------------------------------

-- TOP LEVEL PROCEDURE
begin
-- Input data
        PUT_LINE("Input diameter: ");
        GET(DIAMETER);
        PUT_LINE("Input height: ");
        GET(HEIGHT);
        PUT(DIAMETER);
        PUT(HEIGHT);
        NEW_LINE;
-- Calculation
        AREA := AREA_OF_CIRCLE;
        PUT("Area of circle is: ");
        PUT(AREA,FORE=>3,AFT=>4,EXP =>0);
        NEW_LINE;
        AREA_OF_CYLINDER;
        VOLUME_OF_CYLINDER;
end CYLINDER_CALC;

Some comments:

On completion of this level-1 implementation a test run should be undertaken. Given that we do nothing with the input values at this stage there is no need to use test cases yet. However, we should ensure that the code compiles and, when executed, produces the output we would expect. In the above case the output would be as follows (given diameter and height inputs of 5.0 and 10.0):

kuban-293 $ cylinder_calc
Input diameter:
5.0
Input height:
10.0
 5.00000000000000E+00 1.00000000000000E+01
Area of circle function
Area of circle is:   1.0000
Area of cylinder procedure
Volume of cylinder procedure

-- CYLINDER CALCULATION
-- 4 August 1997
-- Frans Coenen
-- Dept Computer Science, University of Liverpool

with TEXT_IO;
use TEXT_IO;

procedure CYLINDER_CALC is
        package FLOAT_INOUT is new FLOAT_IO(FLOAT);
        use FLOAT_INOUT;
        PI: CONSTANT FLOAT := 3.14;
        DIAMETER, HEIGHT, AREA: FLOAT;


        -----------------------------------------------------
        -- AREA OF CIRCLE function
        function AREA_OF_CIRCLE(RADIUS: FLOAT)
                        return FLOAT is
        begin
                RETURN(PI*RADIUS**2);
        end AREA_OF_CIRCLE;

        -----------------------------------------------------
        -- AREA OF CYLINDER procedure
        procedure AREA_OF_CYLINDER(DIAMETER, HEIGHT,
                        AREA: FLOAT) is
        CIRCUM: FLOAT;
                ---------------------------------------------
                -- CIRCUMFERENCE OF CIRCLE function
                function CIRCUM_OF_CIRCLE (DIAMETER:
                                FLOAT) return FLOAT is
                begin
                        RETURN(PI*DIAMETER);
                end CIRCUM_OF_CIRCLE;
                ---------------------------------------------
        begin
                CIRCUM:= CIRCUM_OF_CIRCLE(DIAMETER);
                PUT("Area of cylinder is: ");
                PUT(AREA*2.0+CIRCUM*HEIGHT,FORE=>3,
                                AFT=>4,EXP =>0);
                NEW_LINE;
        end  AREA_OF_CYLINDER;

        -----------------------------------------------------
        -- VOLUME OF CYLINDER procedure
        procedure VOLUME_OF_CYLINDER(HEIGHT, AREA: FLOAT) is
        begin
                PUT("Volume of cylinder is: ");
                PUT(AREA*HEIGHT,FORE=>3,AFT=>4,
                                EXP =>0);
                NEW_LINE;
        end VOLUME_OF_CYLINDER;
        -----------------------------------------------------


-- TOP LEVEL procedure
begin
-- Input data
        PUT_LINE("Input diameter: ");
        GET(DIAMETER);
        PUT_LINE("Input height: ");
        GET(HEIGHT);
-- Calculation
        AREA := AREA_OF_CIRCLE(DIAMETER/2.0);
        AREA_OF_CYLINDER(DIAMETER, HEIGHT, AREA);
        VOLUME_OF_CYLINDER(HEIGHT, AREA);
end CYLINDER_CALC;

Some points to note about the above code:

1. Formal parameters have been included in the above procedures and functions describing variables that are also available globally. This is considered good programming practice as it guards against accidental changes to the values for global variables and ensures that individual procedures and functions have a "stand alone" capability.
2. A formal parameter (RADIUS: FLOAT) has been included in the AREA_OF_CIRCLE procedure. Note that when the procedure is called from lower down in the program the actual parameter is the expression DIAMETER/2.
3. The nesting of the various functions and procedures is illustrated in the diagram to the right.
4. The operator ** is the exponential operator.
5. In the statement PUT(AREA*2+CIRCUM*HEIGHT,FORE=>3,AFT=>4,EXP =>0) the mathematics operators have the usual precedence, i.e. multiplication is implemented before addition (more on this later).
6. Remember that Ada does not support mixed-mode arithmetic therefore we cannot write AREA*2+CIRCUM*HEIGHT, but must write AREA*2.0+CIRCUM*HEIGHT.

5.4. Testing

Arithmetic testing Test using all possible combinations of negative, positive and zero input values for the DIAMETER and HEIGHT user inputs as shown in the given table (right). Note that the code allows input of negative numbers. This is likely to be undesirable and thus a return to the requirements specification should be instigated and adjustments made in the light of the procurers wishes with respect to negative results.

Data validation testing Provide input data with incorrect syntax, both blatant and subtle. Suggested test cases given below. The '*' symbol indicates that we do not expect to input a second value as we expect the code to fail.