summaryrefslogtreecommitdiff
path: root/gcc/testsuite/ada/acats/tests/cxa/cxa5a08.a
blob: ae2b85a6d43d0ac003a455b6eafb93cfc1f40c04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
-- CXA5A08.A
--
--                             Grant of Unlimited Rights
--
--     Under contracts F33600-87-D-0337, F33600-84-D-0280, MDA903-79-C-0687,
--     F08630-91-C-0015, and DCA100-97-D-0025, the U.S. Government obtained 
--     unlimited rights in the software and documentation contained herein.
--     Unlimited rights are defined in DFAR 252.227-7013(a)(19).  By making 
--     this public release, the Government intends to confer upon all 
--     recipients unlimited rights  equal to those held by the Government.  
--     These rights include rights to use, duplicate, release or disclose the 
--     released technical data and computer software in whole or in part, in 
--     any manner and for any purpose whatsoever, and to have or permit others 
--     to do so.
--
--                                    DISCLAIMER
--
--     ALL MATERIALS OR INFORMATION HEREIN RELEASED, MADE AVAILABLE OR
--     DISCLOSED ARE AS IS.  THE GOVERNMENT MAKES NO EXPRESS OR IMPLIED 
--     WARRANTY AS TO ANY MATTER WHATSOEVER, INCLUDING THE CONDITIONS OF THE
--     SOFTWARE, DOCUMENTATION OR OTHER INFORMATION RELEASED, MADE AVAILABLE 
--     OR DISCLOSED, OR THE OWNERSHIP, MERCHANTABILITY, OR FITNESS FOR A
--     PARTICULAR PURPOSE OF SAID MATERIAL.
--*
--
-- OBJECTIVE:
--      Check that the function Arccot provides correct results.
--
-- TEST DESCRIPTION:
--      This test examines both the version of Arccot resulting from the 
--      instantiation of the Ada.Numerics.Generic_Elementary_Functions 
--      with a type derived from type Float, as well as the preinstantiated 
--      version of this package for type Float.
--      Prescribed results, including instances prescribed to raise 
--      exceptions, are examined in the test cases.  In addition, 
--      certain evaluations are performed where the actual function result 
--      is compared with the expected result (within an epsilon range of 
--      accuracy).
--
-- TEST FILES:
--      The following files comprise this test:
--
--         FXA5A00.A   (foundation code)
--         CXA5A08.A
--
--
-- CHANGE HISTORY:
--      06 Apr 95   SAIC    Initial prerelease version.
--      13 Jun 95   SAIC    Incorporated use of Dont_Optimize procedure, and
--                          use of Result_Within_Range function overloaded for
--                          FXA5A00.New_Float_Type.
--      18 Apr 96   SAIC    Incorporated reviewer comments for ACVC 2.1.
--      28 Feb 97   CTA.PWB Removed checks with explicit Cycle => 2.0*Pi
--
-- CHANGE NOTE:
--      According to Ken Dritz, author of the Numerics Annex of the RM,
--      one should never specify the cycle 2.0*Pi for the trigonometric
--      functions.  In particular, if the machine number for the first
--      argument is not an exact multiple of the machine number for the
--      explicit cycle, then the specified exact results cannot be
--      reasonably expected.  The affected checks in this test have been
--      marked as comments, with the additional notation "pwb-math".
--      Phil Brashear
--!

with Ada.Exceptions;
with Ada.Numerics.Elementary_Functions;
with Ada.Numerics.Generic_Elementary_Functions;
with FXA5A00;
with Report;

procedure CXA5A08 is
begin

   Report.Test ("CXA5A08", "Check that the Arccot function provides " &
                           "correct results");

   Test_Block:
   declare

      use Ada.Exceptions;
      use Ada.Numerics;
      use FXA5A00;

      package GEF is new Ada.Numerics.Generic_Elementary_Functions(New_Float);
      package  EF renames Ada.Numerics.Elementary_Functions;

      Float_Result      : Float;
      Angle             : Float;
      New_Float_Result  : New_Float;
      New_Float_Angle   : New_Float;
      Incorrect_Inverse : Boolean := False;

      procedure Dont_Optimize_Float     is new Dont_Optimize(Float);
      procedure Dont_Optimize_New_Float is new Dont_Optimize(New_Float);

   begin

      -- Testing of Arccot Function, both instantiated and pre-instantiated
      -- version.

      -- Check that Argument_Error is raised by the Arccot function when
      -- provided parameter values of 0.0, 0.0.

      begin
         New_Float_Result := GEF.Arccot(X => 0.0, Y => 0.0);
         Report.Failed("Argument_Error not raised when the Arccot " &
                       "function is provided input of 0.0, 0.0");
         Dont_Optimize_New_Float(New_Float_Result, 1);
      exception
         when Argument_Error => null;  -- OK, expected exception.
         when others         =>
            Report.Failed("Incorrect exception raised by the Arccot " &
                          "function when provided 0.0, 0.0 input parameters");
      end;


      -- Check that no exception is raised by the Arccot function when
      -- provided a large positive or negative X parameter value, when 
      -- using the default value for parameter Y.

      begin
         Float_Result := EF.Arccot(X => FXA5A00.Large);
         Dont_Optimize_Float(Float_Result, 2);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a large positive X parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(X => New_Float(-FXA5A00.Large));
         Dont_Optimize_New_Float(New_Float_Result, 3);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a large negative X parameter value");
      end;


      -- Check that no exception is raised by the Arccot function when
      -- provided a small positive or negative X parameter value, when
      -- using the default value for parameter Y.

      begin
         Float_Result := EF.Arccot(X => FXA5A00.Small);
         Dont_Optimize_Float(Float_Result, 4);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a small positive X parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(X => New_Float(-FXA5A00.Small));
         Dont_Optimize_New_Float(New_Float_Result, 5);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a small negative X parameter value");
      end;


      -- Check that no exception is raised by the Arccot function when
      -- provided combinations of large and small positive or negative 
      -- parameter values for both X and Y input parameters. 

      begin
         Float_Result := EF.Arccot(X => FXA5A00.Large, Y => FXA5A00.Large);
         Dont_Optimize_Float(Float_Result, 6);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided large positive X and Y parameter values");
      end;

      begin
         New_Float_Result := GEF.Arccot(New_Float(-FXA5A00.Large), 
                                        Y => New_Float(FXA5A00.Small));
         Dont_Optimize_New_Float(New_Float_Result, 7);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a large negative X parameter value "  &
                          "and a small positive Y parameter value");
      end;


      begin
         Float_Result := EF.Arccot(X => FXA5A00.Small, Y => FXA5A00.Large);
         Dont_Optimize_Float(Float_Result, 8);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a small positive X parameter value "  &
                          "and a large positive Y parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(New_Float(-FXA5A00.Small), 
                                        New_Float(-FXA5A00.Large));
         Dont_Optimize_New_Float(New_Float_Result, 9);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function is " &
                          "provided a small negative X parameter value "  &
                          "and a large negative Y parameter value");
      end;


      -- Check that when the Arccot function is provided a Y parameter value
      -- of 0.0 and a positive X parameter input value, the prescribed result
      -- of zero is returned.

      if  EF.Arccot(X => FXA5A00.Large, Y => 0.0)                 /= 0.0 or
         GEF.Arccot(2.0*Pi, Y => 0.0)                             /= 0.0 or
          EF.Arccot(FXA5A00.Small, 0.0)                           /= 0.0 or
          EF.Arccot(X => FXA5A00.Large, Y => 0.0, Cycle => 360.0) /= 0.0 or
         GEF.Arccot(2.0*Pi, Y => 0.0, Cycle => 360.0)             /= 0.0 or
          EF.Arccot(FXA5A00.Small, 0.0, Cycle => 360.0)           /= 0.0
      then 
         Report.Failed("Incorrect results from the Arccot function when " &
                       "provided a Y parameter value of 0.0 and various " &
                       "positive X parameter values");
      end if;


      -- Check that the Arccot function provides correct results when
      -- provided a variety of X parameter values.  

      if not Result_Within_Range( EF.Arccot( 1.0), Pi/4.0, 0.001)     or
         not Result_Within_Range(GEF.Arccot( 0.0), Pi/2.0, 0.001)     or
         not Result_Within_Range( EF.Arccot(-1.0), 3.0*Pi/4.0, 0.001) 
      then
         Report.Failed("Incorrect results from the Arccot function when " &
                       "provided a variety of Y parameter values");
      end if;


      -- Check the results of the Arccot function with specified cycle
      -- parameter.

      -- Check that the Arccot function with specified Cycle parameter 
      -- raises Argument_Error when the value of the Cycle parameter is zero
      -- or negative.

      begin
         Float_Result := EF.Arccot(X => Pi, Cycle => 0.0);  -- Default Y value
         Report.Failed("Argument_Error not raised by the Arccot function " &
                       "with default Y parameter value, when the Cycle "   &
                       "parameter is 0.0");
         Dont_Optimize_Float(Float_Result, 10);
      exception
         when Argument_Error => null;  -- OK, expected exception.
         when others         =>
            Report.Failed("Incorrect exception raised by the Arccot "      &
                          "function with default Y parameter value, when " &
                          "provided a 0.0 cycle parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(X => Pi, Y => 1.0, Cycle => 0.0);
         Report.Failed("Argument_Error not raised by the Arccot function " &
                       "when the Cycle parameter is 0.0");
         Dont_Optimize_New_Float(New_Float_Result, 11);
      exception
         when Argument_Error => null;  -- OK, expected exception.
         when others         =>
            Report.Failed("Incorrect exception raised by the Arccot "     &
                          "function when provided a 0.0 cycle parameter " &
                          "value");
      end;

      begin
         Float_Result := EF.Arccot(X => Pi, Cycle => -360.0); 
         Report.Failed("Argument_Error not raised by the Arccot function " &
                       "with a default Y parameter value, when the Cycle " &
                       "parameter is -360.0");
         Dont_Optimize_Float(Float_Result, 12);
      exception
         when Argument_Error => null;  -- OK, expected exception.
         when others         =>
            Report.Failed("Incorrect exception raised by the Arccot "        &
                          "function with a default Y parameter value, when " & 
                          "provided a -360.0 cycle parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(X => Pi, Y => 1.0, Cycle => -Pi);
         Report.Failed("Argument_Error not raised by the Arccot function " &
                       "when the Cycle parameter is -Pi");
         Dont_Optimize_New_Float(New_Float_Result, 13);
      exception
         when Argument_Error => null;  -- OK, expected exception.
         when others         =>
            Report.Failed("Incorrect exception raised by the Arccot "     &
                          "function when provided a -Pi cycle parameter " &
                          "value");
      end;


      -- Check that no exception is raised by the Arccot function with 
      -- specified Cycle parameter, when provided large and small positive
      -- or negative parameter values for both X and Y input parameters. 

      begin
         Float_Result := EF.Arccot(X     => -FXA5A00.Large, 
                                   Y     => -FXA5A00.Large,
--pwb-math  Next line: changed 2.0*Pi to 360.0
                                   Cycle => 360.0);
         Dont_Optimize_Float(Float_Result, 14);
      exception
         when others =>  
            Report.Failed("Exception raised when the Arccot function with " &
                          "specified Cycle parameter, when provided large " & 
                          "negative X and Y parameter values");
      end;


      begin
         New_Float_Result := GEF.Arccot(New_Float(FXA5A00.Large), 
                                        Y     => New_Float(-FXA5A00.Small),
--pwb-math  Next line: changed 2.0*Pi to 360.0
                                        Cycle => 360.0);
         Dont_Optimize_New_Float(New_Float_Result, 15);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function with "  &
                          "specified Cycle parameter, when provided large "  & 
                          "positive X parameter value and a small negative " &
                          "Y parameter value");
      end;


      begin
         Float_Result := EF.Arccot(X     => -FXA5A00.Small, 
                                   Y     => -FXA5A00.Large,
--pwb-math  Next line: changed 2.0*Pi to 360.0
                                   Cycle => 360.0);
         Dont_Optimize_Float(Float_Result, 16);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function with "  &
                          "specified Cycle parameter, when provided small "  & 
                          "negative X parameter value and a large negative " &
                          "Y parameter value");
      end;

      begin
         New_Float_Result := GEF.Arccot(New_Float(FXA5A00.Small), 
                                        New_Float(FXA5A00.Large), 
--pwb-math  Next line: changed 2.0*Pi to 360.0
                                        360.0);
         Dont_Optimize_New_Float(New_Float_Result, 17);
      exception
         when others => 
            Report.Failed("Exception raised when the Arccot function with " &
                          "specified Cycle parameter, when provided a "     & 
                          "small positive X parameter value and a large "   &
                          "positive Y parameter value");
      end;


      -- Check that the Arccot function with specified Cycle parameter 
      -- provides correct results when provided a variety of X parameter
      -- input values.

      if not FXA5A00.Result_Within_Range(GEF.Arccot( 0.0, Cycle => 360.0),
                                         90.0, 
                                         0.001) or
         not FXA5A00.Result_Within_Range(EF.Arccot( 0.0, Cycle => 100.0),
                                         25.0,
                                         0.001) or
         not FXA5A00.Result_Within_Range(GEF.Arccot( 1.0, Cycle => 360.0),
                                         45.0,
                                         0.001) or
         not FXA5A00.Result_Within_Range(EF.Arccot( 1.0, Cycle => 100.0),
                                         12.5,
                                         0.001) or
         not FXA5A00.Result_Within_Range(GEF.Arccot(-1.0, Cycle => 360.0),
                                         135.0,
                                         0.001) or
         not FXA5A00.Result_Within_Range(EF.Arccot(-1.0, Cycle => 100.0),
                                         37.5,
                                         0.001)
      then
         Report.Failed("Incorrect results from the Arccot function with "   &
                       "specified Cycle parameter when provided a variety " &
                       "of X parameter values");
      end if;


      if not FXA5A00.Result_Within_Range(EF.Arccot(0.2425355, 0.9701420),
                                         EF.Arccot(0.25),
                                         0.01) or
         not FXA5A00.Result_Within_Range(EF.Arccot(0.3162277, 0.9486831),
                                         Ef.Arccot(0.33),
                                         0.01)
      then
         Report.Failed("Incorrect results from the Arccot function with " &
                       "comparison to other Arccot function results");
      end if;


      if not FXA5A00.Result_Within_Range(EF.Cot(EF.Arccot(0.4472135,
                                                          0.8944270)),
                                         0.5,
                                         0.01) or
         not FXA5A00.Result_Within_Range(EF.Cot(EF.Arccot(0.9987380, 
                                                          0.0499369)),
                                         20.0,
                                         0.1)
      then
         Report.Failed("Incorrect results from the Arccot function when " &
                       "used as argument to Cot function");
      end if;


      -- Check that inverse function results are correct.
      -- Default Cycle test.

      Angle := 0.001;
      while Angle < Pi and not Incorrect_Inverse loop
         if not Result_Within_Range(EF.Arccot(EF.Cot(Angle)), Angle, 0.001)
         then
            Incorrect_Inverse := True;
         end if;
         Angle := Angle + 0.001;
      end loop;

      if Incorrect_Inverse then
         Report.Failed("Incorrect results returned from the Inverse "    &
                       "comparison of Cot and Arccot using the default " &
                       "cycle value");
         Incorrect_Inverse := False;
      end if;

      -- Non-Default Cycle test.

      New_Float_Angle := 0.01;
      while New_Float_Angle < 180.0 and not Incorrect_Inverse loop
         if not Result_Within_Range(EF.Arccot(EF.Cot(Float(New_Float_Angle), 
                                                     Cycle => 360.0), 
                                              Cycle => 360.0),
                                    Float(New_Float_Angle),
                                    0.01)  or
            not Result_Within_Range(GEF.Arccot(
                                       New_Float(GEF.Cot(New_Float_Angle, 
                                                         Cycle => 360.0)), 
                                       Cycle => 360.0),
                                    Float(New_Float_Angle),
                                    0.01)  
         then
            Incorrect_Inverse := True;
         end if;
         New_Float_Angle := New_Float_Angle + 0.01;
      end loop;

      if Incorrect_Inverse then
         Report.Failed("Incorrect results returned from the Inverse "    &
                       "comparison of Cot and Arccot using non-default " &
                       "cycle value");
      end if;


   exception
      when The_Error : others => 
         Report.Failed ("The following exception was raised in the " &
                        "Test_Block: " & Exception_Name(The_Error));
   end Test_Block;

   Report.Result;

end CXA5A08;