home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / libs / rexmooslib.lha / MOOS / Docs / english / rexx_math.doc < prev    next >
Encoding:
Text File  |  1997-02-03  |  9.8 KB  |  577 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.00 (30.01.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.     BUGS
  79.  
  80. rexx_math.library/Abs                                    rexx_math.library/Abs
  81.  
  82.     NAME
  83.  
  84.         Abs -- Absolute value.
  85.  
  86.     SYNOPSIS
  87.  
  88.         z = Abs(x)
  89.  
  90.     FUNCTION
  91.  
  92.         Returns the absolute value of x. The given argument, x, may be
  93.         any real number.
  94.  
  95.     EXAMPLE
  96.  
  97.         SAY Abs(-0.291268)
  98.  
  99. rexx_math.library/ACos                                  rexx_math.library/ACos
  100.  
  101.     NAME
  102.  
  103.         ACos -- ArcCosine function.
  104.  
  105.     SYNOPSIS
  106.  
  107.         z = ACos(x)
  108.  
  109.     FUNCTION
  110.  
  111.         Calculates the arccosine of x. The value of x must be in the
  112.         range of [-1,1] (its absolute value is lower or equal to 1).
  113.  
  114.     EXAMPLE
  115.  
  116.         SAY ACos(-0.291268)
  117.  
  118. rexx_math.library/ACosH                                rexx_math.library/ACosH
  119.  
  120.     NAME
  121.  
  122.         ACosH -- Hyperbolic arccosine function.
  123.  
  124.     SYNOPSIS
  125.  
  126.         z = ACosH(x)
  127.  
  128.     FUNCTION
  129.  
  130.         Calculates the hyperbolic arccosine of x. The value of x must
  131.         be any real number greater or equal to 1.
  132.  
  133.     EXAMPLE
  134.  
  135.         SAY ACosH(1)
  136.  
  137. rexx_math.library/ASin                                  rexx_math.library/ASin
  138.  
  139.     NAME
  140.  
  141.         ASin -- ArcSine function.
  142.  
  143.     SYNOPSIS
  144.  
  145.         z = ASin(x)
  146.  
  147.     FUNCTION
  148.  
  149.         Calculates the arcsine of x. The value of x must be in the
  150.         range of [-1,1] (its absolute value is lower or equal to 1).
  151.  
  152.     EXAMPLE
  153.  
  154.         SAY ASin(-0.291268)
  155.  
  156. rexx_math.library/ASinH                                rexx_math.library/ASinH
  157.  
  158.     NAME
  159.  
  160.         ASinH -- Hyperbolic arcsine function.
  161.  
  162.     SYNOPSIS
  163.  
  164.         z = ASinH(x)
  165.  
  166.     FUNCTION
  167.  
  168.         Calculates the hyperbolic arcsine of x. The value of x may be
  169.         any real number.
  170.  
  171.     EXAMPLE
  172.  
  173.         SAY ASinH(-0.291268)
  174.  
  175. rexx_math.library/ATan                                  rexx_math.library/ATan
  176.  
  177.     NAME
  178.  
  179.         ATan -- ArcTangent function.
  180.  
  181.     SYNOPSIS
  182.  
  183.         z = ATan(x)
  184.  
  185.     FUNCTION
  186.  
  187.         Calculates the arctangent of x. The value of x may be any
  188.         real number.
  189.  
  190.     EXAMPLE
  191.  
  192.         SAY ATan(-0.291268)
  193.  
  194. rexx_math.library/ATan2                                rexx_math.library/ATan2
  195.  
  196.     NAME
  197.  
  198.         ATan2 -- ArcTangent of x/y.
  199.  
  200.     SYNOPSIS
  201.  
  202.         z = ATan2(x,y)
  203.  
  204.     FUNCTION
  205.  
  206.         Calculates the arctangent of x/y. The value of x may be any
  207.         real number. The value of y might be not equal to zero, but
  208.         the function returns the rigth value for the limit according
  209.         with the sign of x.
  210.  
  211.     EXAMPLE
  212.  
  213.         SAY ATan2(1,0)  /* ==>  pi/2 */
  214.         SAY ATan2(-1,0) /* ==> -pi/2 */
  215.  
  216. rexx_math.library/ATanH                                rexx_math.library/ATanH
  217.  
  218.     NAME
  219.  
  220.         ATanH -- Hyperbolic arctangent function.
  221.  
  222.     SYNOPSIS
  223.  
  224.         z = ATanH(x)
  225.  
  226.     FUNCTION
  227.  
  228.         Calculates the hyperbolic arctangent of x. The value of x must
  229.         be in the range of ]-1,1[.
  230.  
  231.     EXAMPLE
  232.  
  233.         SAY ATanH(-0.291268)
  234.  
  235. rexx_math.library/Ceil                                  rexx_math.library/Ceil
  236.  
  237.     NAME
  238.  
  239.         Ceil -- Get floating-point limits.
  240.  
  241.     SYNOPSIS
  242.  
  243.         z = Ceil(x)
  244.  
  245.     FUNCTION
  246.  
  247.         Returns the smallest whole number not less than the specified
  248.         real number, x.
  249.  
  250.     EXAMPLE
  251.  
  252.         SAY Ceil(-0.291268)
  253.  
  254. rexx_math.library/Cos                                    rexx_math.library/Cos
  255.  
  256.     NAME
  257.  
  258.         Cos -- Cosine function.
  259.  
  260.     SYNOPSIS
  261.  
  262.         z = Cos(x)
  263.  
  264.     FUNCTION
  265.  
  266.         Calculates the cosine of x. The value of x may be any
  267.         real number.
  268.  
  269.     EXAMPLE
  270.  
  271.         SAY Cos(0)
  272.  
  273. rexx_math.library/CosH                                  rexx_math.library/CosH
  274.  
  275.     NAME
  276.  
  277.         CosH -- Hyperbolic cosine function.
  278.  
  279.     SYNOPSIS
  280.  
  281.         z = CosH(x)
  282.  
  283.     FUNCTION
  284.  
  285.         Calculates the hyperbolic cosine of x. The value of x may be
  286.         any real number.
  287.  
  288.     EXAMPLE
  289.  
  290.         SAY CosH(-0.291268)
  291.  
  292. rexx_math.library/Cot                                    rexx_math.library/Cot
  293.  
  294.     NAME
  295.  
  296.         Cot -- CoTangent function.
  297.  
  298.     SYNOPSIS
  299.  
  300.         z = Cot(x)
  301.  
  302.     FUNCTION
  303.  
  304.         Calculates the cotangent of x. The value of x may be any
  305.         real number.
  306.  
  307.     EXAMPLE
  308.  
  309.         SAY Cot(-0.291268)
  310.  
  311. rexx_math.library/Csc                                    rexx_math.library/Csc
  312.  
  313.     NAME
  314.  
  315.         Csc -- Cosecant function.
  316.  
  317.     SYNOPSIS
  318.  
  319.         z = Csc(x)
  320.  
  321.     FUNCTION
  322.  
  323.         Calculates the cosecant of x. The value of x may be any
  324.         real number, but not equal to (k + 1/2)Pi, k relative.
  325.  
  326.     EXAMPLE
  327.  
  328.         SAY Csc(0.5)
  329.  
  330. rexx_math.library/Exp                                    rexx_math.library/Exp
  331.  
  332.     NAME
  333.  
  334.         Exp -- Exponential function.
  335.  
  336.     SYNOPSIS
  337.  
  338.         z = Exp(x)
  339.  
  340.     FUNCTION
  341.  
  342.         Calculates the exponential of x. The value of x may be any
  343.         real number.
  344.  
  345.     EXAMPLE
  346.  
  347.         SAY Exp(-0.291268)
  348.  
  349. rexx_math.library/Fact                                  rexx_math.library/Fact
  350.  
  351.     NAME
  352.  
  353.         Fact -- Factorial function.
  354.  
  355.     SYNOPSIS
  356.  
  357.         z = Fact(x)
  358.  
  359.     FUNCTION
  360.  
  361.         Calculates the factorial of x. The value of x must be any
  362.         positive, integer number, lower than 170.
  363.  
  364.     EXAMPLE
  365.  
  366.         SAY Fact(5)
  367.  
  368. rexx_math.library/Floor                                rexx_math.library/Floor
  369.  
  370.     NAME
  371.  
  372.         Floor -- Get the floor of a real number.
  373.  
  374.     SYNOPSIS
  375.  
  376.         z = Floor(x)
  377.  
  378.     FUNCTION
  379.  
  380.         Calculates the largest integer not greater than x.
  381.  
  382.     EXAMPLE
  383.  
  384.         SAY Floor(-0.291268)
  385.  
  386. rexx_math.library/Log                                    rexx_math.library/Log
  387.  
  388.     NAME
  389.  
  390.         Log -- Natural logarithm function.
  391.  
  392.     SYNOPSIS
  393.  
  394.         z = Log(x)
  395.  
  396.     FUNCTION
  397.  
  398.         Calculates the natural logarithm of x. The value of x must be
  399.         any real number greater than zero.
  400.  
  401.     EXAMPLE
  402.  
  403.         SAY Log(1)
  404.  
  405. rexx_math.library/Log10                                rexx_math.library/Log10
  406.  
  407.     NAME
  408.  
  409.         Log10 -- Base 10 logarithm function.
  410.  
  411.     SYNOPSIS
  412.  
  413.         z = Log10(x)
  414.  
  415.     FUNCTION
  416.  
  417.         Calculates the base 10 logarithm of x. The value of x must
  418.         be any real number greater than zero.
  419.  
  420.     EXAMPLE
  421.  
  422.         SAY Log10(1000)
  423.  
  424. rexx_math.library/NInt                                  rexx_math.library/NInt
  425.  
  426.     NAME
  427.  
  428.         NInt -- Nearest integer of any value.
  429.  
  430.     SYNOPSIS
  431.  
  432.         z = NInt(x)
  433.  
  434.     FUNCTION
  435.  
  436.         Calculates the nearest integer of x. The value of x may
  437.         be any real number.
  438.  
  439.     EXAMPLE
  440.  
  441.         SAY NInt(-0.291268)
  442.  
  443. rexx_math.library/Pow                                    rexx_math.library/Pow
  444.  
  445.     NAME
  446.  
  447.         Pow -- Raise a number to a power.
  448.  
  449.     SYNOPSIS
  450.  
  451.         z = Pow(x,y)
  452.  
  453.     FUNCTION
  454.  
  455.         Raises the value of x to the power of y. The value of x must
  456.         be greater than zero, but y may be any real number.
  457.  
  458.     EXAMPLE
  459.  
  460.         SAY Pow(2,32)
  461.  
  462. rexx_math.library/Sec                                    rexx_math.library/Sec
  463.  
  464.     NAME
  465.  
  466.         Sec -- Secant function.
  467.  
  468.     SYNOPSIS
  469.  
  470.         z = Sec(x)
  471.  
  472.     FUNCTION
  473.  
  474.         Calculates the secant of x. The value of x may be any
  475.         real number, but not equal to any multiple of Pi.
  476.  
  477.     EXAMPLE
  478.  
  479.         SAY Sec(0.5)
  480.  
  481. rexx_math.library/Sin                                    rexx_math.library/Sin
  482.  
  483.     NAME
  484.  
  485.         Sin -- Sine function.
  486.  
  487.     SYNOPSIS
  488.  
  489.         z = Sin(x)
  490.  
  491.     FUNCTION
  492.  
  493.         Calculates the sine of x. The value of x may be any
  494.         real number.
  495.  
  496.     EXAMPLE
  497.  
  498.         SAY Sin(0)
  499.  
  500. rexx_math.library/SinH                                  rexx_math.library/SinH
  501.  
  502.     NAME
  503.  
  504.         SinH -- Hyperbolic Sine function.
  505.  
  506.     SYNOPSIS
  507.  
  508.         z = SinH(x)
  509.  
  510.     FUNCTION
  511.  
  512.         Calculates the hyperbolic sine of x. The value of x may be
  513.         any real number.
  514.  
  515.     EXAMPLE
  516.  
  517.         SAY SinH(-0.291268)
  518.  
  519. rexx_math.library/Sqrt                                  rexx_math.library/Sqrt
  520.  
  521.     NAME
  522.  
  523.         Sqrt -- Square root function.
  524.  
  525.     SYNOPSIS
  526.  
  527.         z = Sqrt(x)
  528.  
  529.     FUNCTION
  530.  
  531.         Calculates the square root of x. The value of x must be any
  532.         positive number (any real greater or equal to zero).
  533.  
  534.     EXAMPLE
  535.  
  536.         SAY Sqrt(4096)
  537.  
  538. rexx_math.library/Tan                                    rexx_math.library/Tan
  539.  
  540.     NAME
  541.  
  542.         Tan -- Tangent function.
  543.  
  544.     SYNOPSIS
  545.  
  546.         z = Tan(x)
  547.  
  548.     FUNCTION
  549.  
  550.         Calculates the tangent of x. The value of x may be any
  551.         real number.
  552.  
  553.     EXAMPLE
  554.  
  555.         SAY Tan(0)
  556.  
  557. rexx_math.library/TanH                                  rexx_math.library/TanH
  558.  
  559.     NAME
  560.  
  561.         TanH -- Hyperbolic tangent function.
  562.  
  563.     SYNOPSIS
  564.  
  565.         z = TanH(x)
  566.  
  567.     FUNCTION
  568.  
  569.         Calculates the hyperbolic tangent of x. The value of x may be
  570.         any real number.
  571.  
  572.     EXAMPLE
  573.  
  574.         SAY TanH(-0.291268)
  575.  
  576.  
  577.