aboutsummaryrefslogtreecommitdiff
path: root/gcc/ada/libgnat/s-expont.ads
blob: 2cf6dc0cdabfbe8da10f2428ab7eae8d600ca0e3 (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
------------------------------------------------------------------------------
--                                                                          --
--                         GNAT RUN-TIME COMPONENTS                         --
--                                                                          --
--                        S Y S T E M . E X P O N T                         --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--          Copyright (C) 1992-2025, Free Software Foundation, Inc.         --
--                                                                          --
-- GNAT is free software;  you can  redistribute it  and/or modify it under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
-- GNAT was originally developed  by the GNAT team at  New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc.      --
--                                                                          --
------------------------------------------------------------------------------

--  This package provides functions for signed integer exponentiation. This
--  is the version of the package with checks enabled.

generic
   type Int is range <>;

package System.Expont
  with Pure, SPARK_Mode
is
   function Expon (Left : Int; Right : Natural) return Int;
   --  Calculate ``Left`` ** ``Right``. If ``Left`` is 0 then 0 is returned
   --  and if ``Right`` is 0 then 1 is returned. In all other cases the result
   --  is set to 1 and then computed in a loop as follows:
   --  If ``Right`` is a multiple of 2 then multiply the result with ``Left``.
   --  Divide ``Right`` by 2.
   --  If ``Right is 0, return.
   --  Multiply ``Left`` with itself.

end System.Expont;