home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / util / rexx / MOOS.lha / MOOS / Docs / english / rexx_math.doc < prev    next >
Encoding:
Text File  |  1997-02-26  |  10.1 KB  |  583 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. --background--
  6. rexx_math.library/Abs
  7. rexx_math.library/ACos
  8. rexx_math.library/ACosH
  9. rexx_math.library/ASin
  10. rexx_math.library/ASinH
  11. rexx_math.library/ATan
  12. rexx_math.library/ATan2
  13. rexx_math.library/ATanH
  14. rexx_math.library/Ceil
  15. rexx_math.library/Cos
  16. rexx_math.library/CosH
  17. rexx_math.library/Cot
  18. rexx_math.library/Csc
  19. rexx_math.library/Exp
  20. rexx_math.library/Fact
  21. rexx_math.library/Floor
  22. rexx_math.library/Log
  23. rexx_math.library/Log10
  24. rexx_math.library/NInt
  25. rexx_math.library/Pow
  26. rexx_math.library/Sec
  27. rexx_math.library/Sin
  28. rexx_math.library/SinH
  29. rexx_math.library/Sqrt
  30. rexx_math.library/Tan
  31. rexx_math.library/TanH
  32.  
  33.  
  34. --background--                                                  --background--
  35.  
  36.  $(C): (1996, Rocco Coluccelli, Bologna)
  37.  $VER: rexx_math.library 37.1 (05.02.97)
  38.  
  39.     rexx_math.library
  40.  
  41.     This sub-library of the rexxMOOS.library let ARexx programmers
  42.     use any math function. This is only a preliminary version not
  43.     optimized to support any FPU.
  44.  
  45.         abs()
  46.         acos()
  47.         acosh()
  48.         asin()
  49.         asinh()
  50.         atan()
  51.         atan2()
  52.         atanh()
  53.         ceil()
  54.         cos()
  55.         cosh()
  56.         cot()
  57.         csc()
  58.         exp()
  59.         fact()
  60.         floor()
  61.         log()
  62.         log10()
  63.         nint()
  64.         pow()
  65.         sec()
  66.         sin()
  67.         sinh()
  68.         sqrt()
  69.         tan()
  70.         tanh()
  71.  
  72.     NOTES
  73.  
  74.         Is part of the MOOS package.
  75.  
  76.     TODO
  77.  
  78.         A procedure to evaluate a math expression directly into the
  79.         library to drastically increase the speed performance.
  80.  
  81.     BUGS
  82.  
  83.         The conversion double=>string=>double reduces the precision of
  84.         any result. A new atof()/ftoa() will replace the existing ones.
  85.  
  86. rexx_math.library/Abs                                    rexx_math.library/Abs
  87.  
  88.     NAME
  89.  
  90.         Abs -- Absolute value.
  91.  
  92.     SYNOPSIS
  93.  
  94.         z = Abs(x)
  95.  
  96.     FUNCTION
  97.  
  98.         Returns the absolute value of x. The given argument, x, may be
  99.         any real number.
  100.  
  101.     EXAMPLE
  102.  
  103.         SAY Abs(-0.291268)
  104.  
  105. rexx_math.library/ACos                                  rexx_math.library/ACos
  106.  
  107.     NAME
  108.  
  109.         ACos -- ArcCosine function.
  110.  
  111.     SYNOPSIS
  112.  
  113.         z = ACos(x)
  114.  
  115.     FUNCTION
  116.  
  117.         Calculates the arccosine of x. The value of x must be in the
  118.         range of [-1,1] (its absolute value is lower or equal to 1).
  119.  
  120.     EXAMPLE
  121.  
  122.         SAY ACos(-0.291268)
  123.  
  124. rexx_math.library/ACosH                                rexx_math.library/ACosH
  125.  
  126.     NAME
  127.  
  128.         ACosH -- Hyperbolic arccosine function.
  129.  
  130.     SYNOPSIS
  131.  
  132.         z = ACosH(x)
  133.  
  134.     FUNCTION
  135.  
  136.         Calculates the hyperbolic arccosine of x. The value of x must
  137.         be any real number greater or equal to 1.
  138.  
  139.     EXAMPLE
  140.  
  141.         SAY ACosH(1)
  142.  
  143. rexx_math.library/ASin                                  rexx_math.library/ASin
  144.  
  145.     NAME
  146.  
  147.         ASin -- ArcSine function.
  148.  
  149.     SYNOPSIS
  150.  
  151.         z = ASin(x)
  152.  
  153.     FUNCTION
  154.  
  155.         Calculates the arcsine of x. The value of x must be in the
  156.         range of [-1,1] (its absolute value is lower or equal to 1).
  157.  
  158.     EXAMPLE
  159.  
  160.         SAY ASin(-0.291268)
  161.  
  162. rexx_math.library/ASinH                                rexx_math.library/ASinH
  163.  
  164.     NAME
  165.  
  166.         ASinH -- Hyperbolic arcsine function.
  167.  
  168.     SYNOPSIS
  169.  
  170.         z = ASinH(x)
  171.  
  172.     FUNCTION
  173.  
  174.         Calculates the hyperbolic arcsine of x. The value of x may be
  175.         any real number.
  176.  
  177.     EXAMPLE
  178.  
  179.         SAY ASinH(-0.291268)
  180.  
  181. rexx_math.library/ATan                                  rexx_math.library/ATan
  182.  
  183.     NAME
  184.  
  185.         ATan -- ArcTangent function.
  186.  
  187.     SYNOPSIS
  188.  
  189.         z = ATan(x)
  190.  
  191.     FUNCTION
  192.  
  193.         Calculates the arctangent of x. The value of x may be any
  194.         real number.
  195.  
  196.     EXAMPLE
  197.  
  198.         SAY ATan(-0.291268)
  199.  
  200. rexx_math.library/ATan2                                rexx_math.library/ATan2
  201.  
  202.     NAME
  203.  
  204.         ATan2 -- ArcTangent of x/y.
  205.  
  206.     SYNOPSIS
  207.  
  208.         z = ATan2(x,y)
  209.  
  210.     FUNCTION
  211.  
  212.         Calculates the arctangent of x/y. The value of x may be any
  213.         real number. The value of y might be not equal to zero, but
  214.         the function returns the rigth value for the limit according
  215.         with the sign of x.
  216.  
  217.     EXAMPLE
  218.  
  219.         SAY ATan2(1,0)  /* ==>  pi/2 */
  220.         SAY ATan2(-1,0) /* ==> -pi/2 */
  221.  
  222. rexx_math.library/ATanH                                rexx_math.library/ATanH
  223.  
  224.     NAME
  225.  
  226.         ATanH -- Hyperbolic arctangent function.
  227.  
  228.     SYNOPSIS
  229.  
  230.         z = ATanH(x)
  231.  
  232.     FUNCTION
  233.  
  234.         Calculates the hyperbolic arctangent of x. The value of x must
  235.         be in the range of ]-1,1[.
  236.  
  237.     EXAMPLE
  238.  
  239.         SAY ATanH(-0.291268)
  240.  
  241. rexx_math.library/Ceil                                  rexx_math.library/Ceil
  242.  
  243.     NAME
  244.  
  245.         Ceil -- Get floating-point limits.
  246.  
  247.     SYNOPSIS
  248.  
  249.         z = Ceil(x)
  250.  
  251.     FUNCTION
  252.  
  253.         Returns the smallest whole number not less than the specified
  254.         real number, x.
  255.  
  256.     EXAMPLE
  257.  
  258.         SAY Ceil(-0.291268)
  259.  
  260. rexx_math.library/Cos                                    rexx_math.library/Cos
  261.  
  262.     NAME
  263.  
  264.         Cos -- Cosine function.
  265.  
  266.     SYNOPSIS
  267.  
  268.         z = Cos(x)
  269.  
  270.     FUNCTION
  271.  
  272.         Calculates the cosine of x. The value of x may be any
  273.         real number.
  274.  
  275.     EXAMPLE
  276.  
  277.         SAY Cos(0)
  278.  
  279. rexx_math.library/CosH                                  rexx_math.library/CosH
  280.  
  281.     NAME
  282.  
  283.         CosH -- Hyperbolic cosine function.
  284.  
  285.     SYNOPSIS
  286.  
  287.         z = CosH(x)
  288.  
  289.     FUNCTION
  290.  
  291.         Calculates the hyperbolic cosine of x. The value of x may be
  292.         any real number.
  293.  
  294.     EXAMPLE
  295.  
  296.         SAY CosH(-0.291268)
  297.  
  298. rexx_math.library/Cot                                    rexx_math.library/Cot
  299.  
  300.     NAME
  301.  
  302.         Cot -- CoTangent function.
  303.  
  304.     SYNOPSIS
  305.  
  306.         z = Cot(x)
  307.  
  308.     FUNCTION
  309.  
  310.         Calculates the cotangent of x. The value of x may be any
  311.         real number.
  312.  
  313.     EXAMPLE
  314.  
  315.         SAY Cot(-0.291268)
  316.  
  317. rexx_math.library/Csc                                    rexx_math.library/Csc
  318.  
  319.     NAME
  320.  
  321.         Csc -- Cosecant function.
  322.  
  323.     SYNOPSIS
  324.  
  325.         z = Csc(x)
  326.  
  327.     FUNCTION
  328.  
  329.         Calculates the cosecant of x. The value of x may be any
  330.         real number, but not equal to (k + 1/2)Pi, k relative.
  331.  
  332.     EXAMPLE
  333.  
  334.         SAY Csc(0.5)
  335.  
  336. rexx_math.library/Exp                                    rexx_math.library/Exp
  337.  
  338.     NAME
  339.  
  340.         Exp -- Exponential function.
  341.  
  342.     SYNOPSIS
  343.  
  344.         z = Exp(x)
  345.  
  346.     FUNCTION
  347.  
  348.         Calculates the exponential of x. The value of x may be any
  349.         real number.
  350.  
  351.     EXAMPLE
  352.  
  353.         SAY Exp(-0.291268)
  354.  
  355. rexx_math.library/Fact                                  rexx_math.library/Fact
  356.  
  357.     NAME
  358.  
  359.         Fact -- Factorial function.
  360.  
  361.     SYNOPSIS
  362.  
  363.         z = Fact(x)
  364.  
  365.     FUNCTION
  366.  
  367.         Calculates the factorial of x. The value of x must be any
  368.         positive, integer number, lower than 170.
  369.  
  370.     EXAMPLE
  371.  
  372.         SAY Fact(5)
  373.  
  374. rexx_math.library/Floor                                rexx_math.library/Floor
  375.  
  376.     NAME
  377.  
  378.         Floor -- Get the floor of a real number.
  379.  
  380.     SYNOPSIS
  381.  
  382.         z = Floor(x)
  383.  
  384.     FUNCTION
  385.  
  386.         Calculates the largest integer not greater than x.
  387.  
  388.     EXAMPLE
  389.  
  390.         SAY Floor(-0.291268)
  391.  
  392. rexx_math.library/Log                                    rexx_math.library/Log
  393.  
  394.     NAME
  395.  
  396.         Log -- Natural logarithm function.
  397.  
  398.     SYNOPSIS
  399.  
  400.         z = Log(x)
  401.  
  402.     FUNCTION
  403.  
  404.         Calculates the natural logarithm of x. The value of x must be
  405.         any real number greater than zero.
  406.  
  407.     EXAMPLE
  408.  
  409.         SAY Log(1)
  410.  
  411. rexx_math.library/Log10                                rexx_math.library/Log10
  412.  
  413.     NAME
  414.  
  415.         Log10 -- Base 10 logarithm function.
  416.  
  417.     SYNOPSIS
  418.  
  419.         z = Log10(x)
  420.  
  421.     FUNCTION
  422.  
  423.         Calculates the base 10 logarithm of x. The value of x must
  424.         be any real number greater than zero.
  425.  
  426.     EXAMPLE
  427.  
  428.         SAY Log10(1000)
  429.  
  430. rexx_math.library/NInt                                  rexx_math.library/NInt
  431.  
  432.     NAME
  433.  
  434.         NInt -- Nearest integer of any value.
  435.  
  436.     SYNOPSIS
  437.  
  438.         z = NInt(x)
  439.  
  440.     FUNCTION
  441.  
  442.         Calculates the nearest integer of x. The value of x may
  443.         be any real number.
  444.  
  445.     EXAMPLE
  446.  
  447.         SAY NInt(-0.291268)
  448.  
  449. rexx_math.library/Pow                                    rexx_math.library/Pow
  450.  
  451.     NAME
  452.  
  453.         Pow -- Raise a number to a power.
  454.  
  455.     SYNOPSIS
  456.  
  457.         z = Pow(x,y)
  458.  
  459.     FUNCTION
  460.  
  461.         Raises the value of x to the power of y. The value of x must
  462.         be greater than zero, but y may be any real number.
  463.  
  464.     EXAMPLE
  465.  
  466.         SAY Pow(2,32)
  467.  
  468. rexx_math.library/Sec                                    rexx_math.library/Sec
  469.  
  470.     NAME
  471.  
  472.         Sec -- Secant function.
  473.  
  474.     SYNOPSIS
  475.  
  476.         z = Sec(x)
  477.  
  478.     FUNCTION
  479.  
  480.         Calculates the secant of x. The value of x may be any
  481.         real number, but not equal to any multiple of Pi.
  482.  
  483.     EXAMPLE
  484.  
  485.         SAY Sec(0.5)
  486.  
  487. rexx_math.library/Sin                                    rexx_math.library/Sin
  488.  
  489.     NAME
  490.  
  491.         Sin -- Sine function.
  492.  
  493.     SYNOPSIS
  494.  
  495.         z = Sin(x)
  496.  
  497.     FUNCTION
  498.  
  499.         Calculates the sine of x. The value of x may be any
  500.         real number.
  501.  
  502.     EXAMPLE
  503.  
  504.         SAY Sin(0)
  505.  
  506. rexx_math.library/SinH                                  rexx_math.library/SinH
  507.  
  508.     NAME
  509.  
  510.         SinH -- Hyperbolic Sine function.
  511.  
  512.     SYNOPSIS
  513.  
  514.         z = SinH(x)
  515.  
  516.     FUNCTION
  517.  
  518.         Calculates the hyperbolic sine of x. The value of x may be
  519.         any real number.
  520.  
  521.     EXAMPLE
  522.  
  523.         SAY SinH(-0.291268)
  524.  
  525. rexx_math.library/Sqrt                                  rexx_math.library/Sqrt
  526.  
  527.     NAME
  528.  
  529.         Sqrt -- Square root function.
  530.  
  531.     SYNOPSIS
  532.  
  533.         z = Sqrt(x)
  534.  
  535.     FUNCTION
  536.  
  537.         Calculates the square root of x. The value of x must be any
  538.         positive number (any real greater or equal to zero).
  539.  
  540.     EXAMPLE
  541.  
  542.         SAY Sqrt(4096)
  543.  
  544. rexx_math.library/Tan                                    rexx_math.library/Tan
  545.  
  546.     NAME
  547.  
  548.         Tan -- Tangent function.
  549.  
  550.     SYNOPSIS
  551.  
  552.         z = Tan(x)
  553.  
  554.     FUNCTION
  555.  
  556.         Calculates the tangent of x. The value of x may be any
  557.         real number.
  558.  
  559.     EXAMPLE
  560.  
  561.         SAY Tan(0)
  562.  
  563. rexx_math.library/TanH                                  rexx_math.library/TanH
  564.  
  565.     NAME
  566.  
  567.         TanH -- Hyperbolic tangent function.
  568.  
  569.     SYNOPSIS
  570.  
  571.         z = TanH(x)
  572.  
  573.     FUNCTION
  574.  
  575.         Calculates the hyperbolic tangent of x. The value of x may be
  576.         any real number.
  577.  
  578.     EXAMPLE
  579.  
  580.         SAY TanH(-0.291268)
  581.  
  582.  
  583.