------------------------------------------------------------------------------
-- --
-- GNAT RUNTIME COMPONENTS --
-- --
-- S Y S T E M . G E N E R I C _ C _ M A T H _ I N T E R F A C E --
-- --
-- S p e c --
-- --
-- Copyright (C) 1992-2014, 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. --
-- --
-- --
-- --
-- --
-- --
-- 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 --
-- . --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-- This is the Ada Cert Math specific version of s-gcmain.ads.
-- The separate version is necessary, because this system does not
-- provide an implementation of tanh, among other hyperbolic functions.
-- The run time currently has no code to implement this function,
-- so the only short term option was to remove the hyperbolic functions.
-- @llrset s-gcmain.ads
-- Generic C Math Interface
-- ========================
-- Provide the elementary mathematical functions support library packages.
-- This package is an implementation of the Ada elementary functions
-- using the C math library. The C library is assumed to be conforming
-- with ISO/IEC 9899:1999 (C99). In particular, all identities specified
-- in chapter F.9 must hold. Furthermore, the accuracy of the various
-- functions is assumed to be sufficient for the strict mode specified
-- in Annex G of the Ada standard.
-- For environments where this is not true, the generic Ada implementations
-- should be used. These only require the standard arithmetic operations.
-- Typically, the generic functions are imported from C as follows.
-- For the C type "float":
-- function Sin (X : Float) return Float;
-- pragma Import (C, Sin, "sinf");
-- or for the C type "double":
-- function Sin (X : Long_Float) return Long_Float;
-- pragma Import (C, Sin, "sin");
-- or for the C type "long double":
-- function Sin (X : Long_Long_Float) return Long_Long_Float
-- pragma Import (C, Sin, "sinl");
generic
type Float_Type is digits <>;
with function C_Sqrt (X : Float_Type) return Float_Type is <>;
with function C_Log (X : Float_Type) return Float_Type is <>;
with function C_Exp (X : Float_Type) return Float_Type is <>;
with function C_Pow (X, Y : Float_Type) return Float_Type is <>;
with function C_Sin (X : Float_Type) return Float_Type is <>;
with function C_Cos (X : Float_Type) return Float_Type is <>;
with function C_Tan (X : Float_Type) return Float_Type is <>;
with function C_Asin (X : Float_Type) return Float_Type is <>;
with function C_Acos (X : Float_Type) return Float_Type is <>;
with function C_Atan2 (Y, X : Float_Type) return Float_Type is <>;
with function C_Sinh (X : Float_Type) return Float_Type is <>;
with function C_Cosh (X : Float_Type) return Float_Type is <>;
with function C_Tanh (X : Float_Type) return Float_Type is <>;
with function C_Asinh (X : Float_Type) return Float_Type is <>;
with function C_Acosh (X : Float_Type) return Float_Type is <>;
with function C_Atanh (Y : Float_Type) return Float_Type is <>;
package System.Generic_C_Math_Interface is
pragma Pure (Generic_C_Math_Interface);
pragma Assert (Float_Type'Signed_Zeros);
pragma Assert (Float_Type'Machine_Radix = 2);
function Sqrt (X : Float_Type'Base) return Float_Type'Base;
-- @llr Sqrt (Float_Type)
-- This function shall return the square root of
function Log (X : Float_Type'Base) return Float_Type'Base;
-- @llr Log (Float_Type)
-- This function shall return the logarithm of
function Log (X, Base : Float_Type'Base) return Float_Type'Base;
-- @llr Log (Float_Type; Float_Type)
-- This function shall compute the logarithm of with the specified base
function Exp (X : Float_Type'Base) return Float_Type'Base;
-- @llr Exp (Float_Type)
-- This function shall compute the exponent of
function "**" (Left, Right : Float_Type'Base) return Float_Type'Base;
-- @llr "**" (Float_Type; Float_Type)
-- This function shall compute to the power of
function Sin (X : Float_Type'Base) return Float_Type'Base;
-- @llr Sin (Float_Type)
-- This function shall return the sine of
function Sin (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Sin (Float_Type; Float_Type)
-- This function shall return the sine of with the specified base
function Cos (X : Float_Type'Base) return Float_Type'Base;
-- @llr Cos (Float_Type)
-- This function shall return the cosine of
function Cos (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Cos (Float_Type; Float_Type)
-- This function shall return the cosine of with the specified base
function Tan (X : Float_Type'Base) return Float_Type'Base;
-- @llr Tan (Float_Type)
-- This function shall return the tangent of
function Tan (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Tan (Float_Type; Float_Type)
-- This function shall return the tangent of with the specified base
function Cot (X : Float_Type'Base) return Float_Type'Base;
-- @llr Cot (Float_Type)
-- This function shall return the cotangent of
function Cot (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Cot (Float_Type; Float_Type)
-- This function shall return the cotangent of with the specified base
function Arcsin (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arcsin (Float_Type)
-- This function shall return the inverse sine of
function Arcsin (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Arcsin (Float_Type; Float_Type)
-- This function shall return the inverse sine of with the specified
-- base
function Arccos (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arccos (Float_Type)
-- This function shall return the inverse cosine of
function Arccos (X, Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Arccos (Float_Type; Float_Type)
-- This function shall return the inverse cosine of with the specified
-- base
function Arctan
(Y : Float_Type'Base;
X : Float_Type'Base := 1.0) return Float_Type'Base;
-- @llr Arctan (Float_Type; Float_Type)
-- This function shall compute the principal value of the inverse tangent
-- of /
function Arctan
(Y : Float_Type'Base;
X : Float_Type'Base := 1.0;
Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Arctan (Float_Type; Float_Type; Float_Type)
-- This function shall compute the principal value of the inverse tangent
-- of / with the specified base
function Arccot
(X : Float_Type'Base;
Y : Float_Type'Base := 1.0) return Float_Type'Base;
-- @llr Arccot (Float_Type; Float_Type)
-- This function shall compute the principal value of the inverse cotangent
-- of /
function Arccot
(X : Float_Type'Base;
Y : Float_Type'Base := 1.0;
Cycle : Float_Type'Base) return Float_Type'Base;
-- @llr Arccot (Float_Type; Float_Type; FLoat_Type)
-- This function shall compute the principal value of the inverse cotangent
-- of / with the specified base
function Sinh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Sinh (Float_Type)
-- This function shall return the hyperbolic sine of
function Cosh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Cosh (Float_Type)
-- This function shall return the hyperbolic cosine of
function Tanh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Tanh (Float_Type)
-- This function shall return the hyperbolic tangent of
function Coth (X : Float_Type'Base) return Float_Type'Base;
-- @llr Coth (Float_Type)
-- This function shall return the hyperbolic cotangent of
function Arcsinh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arcsinh (Float_Type)
-- This function shall return the inverse hyperbolic sine of
function Arccosh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arccosh (Float_Type)
-- This function shall return the inverse hyperbolic cosine of
function Arctanh (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arctanh (Float_Type)
-- This function shall return the inverse hyperbolic tangent of
function Arccoth (X : Float_Type'Base) return Float_Type'Base;
-- @llr Arccoth (Float_Type)
-- This function shall return the inverse hyperbolic cotangent of
end System.Generic_C_Math_Interface;