|
|
|
|
| Arctan | Cos | Entier | Exp |
| Ln | Power | Sin | Sqrt |
function Arctan
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Arctan - Return arctangent of number.
--
--
-- This function computes the arctangent for a real number passed in as the
-- parameter. In other words, this function computes the angle that has
-- a trigonometric tangent equal to the input parameter value. Note: the
-- name 'Arctan' is used in the Ada version, while 'Arctan' is used in the
-- MODULA-2 version (note lower-case 't' in MODULA-2).
--
-- CALLING SEQUENCE -
--
-- f := Arctan (real)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The number for which the arctangent is required.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- The resultant arctangent
--
-- EXAMPLE -
--
-- y := 1.5708;
-- x := Arctan (y);
-- or
-- x := Arctan (1.5708);
-- In these examples, the computed Arctan value for 1.5708 radians is
-- 1.004
--
function Cos
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Cos - Return cosine of number.
--
--
-- This function returns the cosine of an angle whose measure is expressed
-- in radians. If possible, keep the absolute value of 'real' less than 2
-- pi.
--
-- CALLING SEQUENCE -
--
-- f := Cos (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The angle (in radians) for which the cosine is to be computed.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- The approximation for the cosine of 'real'.
--
-- EXAMPLE -
--
-- y := 1.5708;
-- x := Cos (y);
-- or
-- x := Cos (1.5708);
--
-- In these examples, the computed Cosine value for 1.5708 radians
-- is approximately 0.0
--
function Entier
(RealVal : in ModSys.S_Float64) return ModSys.S_Integer;
--*
-- Entier - Convert floating point number to integer.
--
--
-- This function computes the whole-number (integer) part of a real number
-- passed in as the parameter.
--
-- CALLING SEQUENCE -
--
-- i := Entier (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The floating point number to convert to an integer.
--
-- EXIT -
--
-- i : ModSys.S_integer
-- The integer portion of the specified 'real' value
--
-- EXAMPLE -
--
-- y := 578.4;
-- x := Entier(y);
-- or
-- x := Entier(578.4);
--
function Exp
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Exp - Compute value for e raised to real exponent.
--
--
-- This function computes the value for Euler's Number, e, the base of the
-- natural logarithm (2.71828), raised to a real number power. The real number
-- power (exponent) is the input parameter. The function result is 'e'
-- raised to this exponent.
--
-- CALLING SEQUENCE -
--
-- f := Exp (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The power to which 'e' is raised.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- An approximation of 'e' raised to the 'real' power
--
-- EXAMPLE -
--
-- y := 2.4;
-- x := Exp (y);
-- or
-- x := Exp (2.4);
-- In these examples, the computed Exp value, x, is 11.0232
--
function Ln
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Ln - Return natural logarithm.
--
--
-- This function returns the computed natural logarithm of a real number.
--
-- CALLING SEQUENCE -
--
-- f := Ln (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- A number greater than 0 for which the natural logarithm is to be
-- determined.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- The approximation of the natural log of 'real'.
--
-- EXAMPLE -
--
-- y := 78.5;
-- x := Ln (y);
-- or
-- x := Ln (78.5);
-- In these examples, the computed Ln value, x, is 4.3631
--
function Power
(RealVal : in ModSys.S_Float64;
exp1 : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Power - Raise floating point number to floating point power.
--
--
-- This function calculates the value of the parameter 'real' taken to the
-- parameter 'exp1' power.
--
-- CALLING SEQUENCE -
--
-- f := Power (RealVal, exp1)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The base.
--
-- exp1 : ModSys.S_Float64
-- The exponent.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- An approximation of 'real' raised to the 'exp1'th power.
--
-- EXAMPLE -
--
-- compute the value of 2.0 raised to the 3.0 power (exponent)
--
-- y := 2.0;
-- z := 3.0;
-- x := Power (y, z);
-- or
-- x := Power (2.0, 3.0);
--
function Sin
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Sin - Return sine of number.
--
--
-- This function returns the sine of an angle whose measure is expressed in
-- radians. If possible, keep the absolute value of 'real' less than 2 pi.
--
-- CALLING SEQUENCE -
--
-- f := Sin (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The angle (in radians) for which the sine is to be computed.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- The approximation for the sine of 'real'.
--
-- EXAMPLE -
--
-- y := 1.5708;
-- x := Sin (y);
-- or
-- x := Sin (1.5708);
--
-- In these examples, the computed Sine value for 1.5708 radians is 1.0
--
function Sqrt
(RealVal : in ModSys.S_Float64) return ModSys.S_Float64;
--*
-- Sqrt - Return square root of number.
--
--
-- This function computes the square root of its real number parameter.
--
-- CALLING SEQUENCE -
--
-- f := Sqrt (RealVal)
--
-- ENTRY -
--
-- RealVal : ModSys.S_Float64
-- The number for which the square root is to be determined.
--
-- EXIT -
--
-- f : ModSys.S_Float64
-- The resultant square root of the parameter.
--
-- EXAMPLE -
--
-- y := 578.4;
-- x := Sqrt (y);
-- or
-- x := Sqrt (578.4);
-- In these examples, the computed square root value, x, is 24.0499
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance