File : a-numaux.ads


   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                     A D A . N U M E R I C S . A U X                      --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                       (C Library Version, non-x86)                       --
   9 --                                                                          --
  10 --          Copyright (C) 1992-2014, Free Software Foundation, Inc.         --
  11 --                                                                          --
  12 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  13 -- terms of the  GNU General Public License as published  by the Free Soft- --
  14 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  15 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  16 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  17 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  18 --                                                                          --
  19 --                                                                          --
  20 --                                                                          --
  21 --                                                                          --
  22 --                                                                          --
  23 -- You should have received a copy of the GNU General Public License and    --
  24 -- a copy of the GCC Runtime Library Exception along with this program;     --
  25 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  26 -- <http://www.gnu.org/licenses/>.                                          --
  27 --                                                                          --
  28 -- GNAT was originally developed  by the GNAT team at  New York University. --
  29 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  30 --                                                                          --
  31 ------------------------------------------------------------------------------
  32 
  33 --  This package provides the basic computational interface for the generic
  34 --  elementary functions. The C library version interfaces with the routines
  35 --  in the C mathematical library, and is thus quite portable, although it may
  36 --  not necessarily meet the requirements for accuracy in the numerics annex.
  37 --  One advantage of using this package is that it will interface directly to
  38 --  hardware instructions, such as the those provided on the Intel x86.
  39 
  40 --  This version here is for use with normal Unix math functions. Alternative
  41 --  versions are provided for special situations:
  42 
  43 --    a-numaux-darwin    For OS/X (special handling of sin/cos for accuracy)
  44 --    a-numaux-libc-x86  For the x86, using 80-bit long double format
  45 --    a-numaux-x86       For the x86, using 64-bit IEEE (inline asm statements)
  46 --    a-numaux-vxworks   For use on VxWorks (where we have no libm.a library)
  47 
  48 package Ada.Numerics.Aux is
  49    pragma Pure;
  50 
  51    pragma Linker_Options ("-lm");
  52 
  53    type Double is digits 15;
  54    --  Type Double is the type used to call the C routines
  55 
  56    --  We import these functions directly from C. Note that we label them
  57    --  all as pure functions, because indeed all of them are in fact pure.
  58 
  59    function Sin (X : Double) return Double;
  60    pragma Import (C, Sin, "sin");
  61    pragma Pure_Function (Sin);
  62 
  63    function Cos (X : Double) return Double;
  64    pragma Import (C, Cos, "cos");
  65    pragma Pure_Function (Cos);
  66 
  67    function Tan (X : Double) return Double;
  68    pragma Import (C, Tan, "tan");
  69    pragma Pure_Function (Tan);
  70 
  71    function Exp (X : Double) return Double;
  72    pragma Import (C, Exp, "exp");
  73    pragma Pure_Function (Exp);
  74 
  75    function Sqrt (X : Double) return Double;
  76    pragma Import (C, Sqrt, "sqrt");
  77    pragma Pure_Function (Sqrt);
  78 
  79    function Log (X : Double) return Double;
  80    pragma Import (C, Log, "log");
  81    pragma Pure_Function (Log);
  82 
  83    function Acos (X : Double) return Double;
  84    pragma Import (C, Acos, "acos");
  85    pragma Pure_Function (Acos);
  86 
  87    function Asin (X : Double) return Double;
  88    pragma Import (C, Asin, "asin");
  89    pragma Pure_Function (Asin);
  90 
  91    function Atan (X : Double) return Double;
  92    pragma Import (C, Atan, "atan");
  93    pragma Pure_Function (Atan);
  94 
  95    function Sinh (X : Double) return Double;
  96    pragma Import (C, Sinh, "sinh");
  97    pragma Pure_Function (Sinh);
  98 
  99    function Cosh (X : Double) return Double;
 100    pragma Import (C, Cosh, "cosh");
 101    pragma Pure_Function (Cosh);
 102 
 103    function Tanh (X : Double) return Double;
 104    pragma Import (C, Tanh, "tanh");
 105    pragma Pure_Function (Tanh);
 106 
 107    function Pow (X, Y : Double) return Double;
 108    pragma Import (C, Pow, "pow");
 109    pragma Pure_Function (Pow);
 110 
 111 end Ada.Numerics.Aux;