home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Misc / TRSICAT.LZX / CATS_CD2_TRSI / Inc&AD2.1 / Text_Autodocs / mathffp.doc < prev    next >
Encoding:
Text File  |  1992-09-11  |  6.3 KB  |  368 lines
  1. TABLE OF CONTENTS
  2.  
  3. mathffp.library/SPAbs
  4. mathffp.library/SPAdd
  5. mathffp.library/SPCeil
  6. mathffp.library/SPCmp
  7. mathffp.library/SPDiv
  8. mathffp.library/SPFix
  9. mathffp.library/SPFloor
  10. mathffp.library/SPFlt
  11. mathffp.library/SPMul
  12. mathffp.library/SPNeg
  13. mathffp.library/SPSub
  14. mathffp.library/SPTst
  15. mathffp.library/SPAbs                                   mathffp.library/SPAbs
  16.  
  17. NAME
  18.     SPAbs -- Obtain the absolute value of the fast floating point number.
  19.  
  20. SYNOPSIS
  21.     fnum2 = SPAbs(fnum1)
  22.     D0          D0
  23.  
  24.     float SPAbs(float fnum1);
  25.  
  26. FUNCTION
  27.     Accepts a floating point number and returns the absolute value of
  28.     said number.
  29.  
  30. INPUTS
  31.     fnum1     - floating point number.
  32.  
  33. RESULT
  34.     fnum2     - floating point absolute value of fnum1.
  35.  
  36. BUGS
  37.     None
  38.  
  39. SEE ALSO
  40.  
  41.  
  42. mathffp.library/SPAdd                                   mathffp.library/SPAdd
  43.  
  44. NAME
  45.     SPAdd -- Add two floating point numbers.
  46.  
  47. SYNOPSIS
  48.     fnum3 = SPAdd(fnum1, fnum2)
  49.     D0          D1     D0
  50.  
  51.     float SPAdd(float fnum1, float fnum2);
  52.  
  53. FUNCTION
  54.     Accepts two floating point numbers and returns the arithmetic
  55.     sum of said numbers.
  56.  
  57. INPUTS
  58.     fnum1     - floating point number to add.
  59.     fnum2     - other floating point number to add.
  60.  
  61. RESULT
  62.     fnum3     - floating point number, sum of fnum1 and fnum2.
  63.  
  64. BUGS
  65.     None.
  66.  
  67. SEE ALSO
  68.  
  69. mathffp.library/SPCeil                                 mathffp.library/SPCeil
  70.  
  71.    NAME
  72.     SPCeil -- Compute Ceil function of a number.
  73.  
  74.    SYNOPSIS
  75.     x = SPCeil(y)
  76.     D0         D0
  77.  
  78.     float SPCeil(float y);
  79.  
  80.    FUNCTION
  81.     Calculate the least integer greater than or equal to x and return it.
  82.     This identity is true.  Ceil(x) = -Floor(-x).
  83.  
  84.    INPUTS
  85.     y     - Motorola Fast Floating Point Format Number.
  86.  
  87.    RESULT
  88.     x     - Motorola Fast Floating Point Format Number.
  89.  
  90.    BUGS
  91.     None.
  92.  
  93.    SEE ALSO
  94.     SPFloor()
  95.  
  96. mathffp.library/SPCmp                                   mathffp.library/SPCmp
  97.  
  98. NAME
  99.     SPCmp -- Compares two floating point numbers.
  100.  
  101. SYNOPSIS
  102.     result = SPCmp(fnum1, fnum2)
  103.     D0               D0     D1
  104.  
  105.     int SPCmp(float fnum1, float fnum2);
  106.  
  107. FUNCTION
  108.  
  109.     Accepts two floating point numbers and returns the condition
  110.     codes set to indicate the result of said comparison.  Additionally,
  111.     the integer functional result is returned to indicate the result
  112.     of said comparison.
  113.  
  114. INPUTS
  115.     fnum1     - floating point number.
  116.     fnum2     - floating point number.
  117.  
  118. RESULT
  119.     Condition codes set to reflect the following branches:
  120.  
  121.         GT - fnum2 >  fnum1
  122.         GE - fnum2 >= fnum1
  123.         EQ - fnum2 =  fnum1
  124.         NE - fnum2 != fnum1
  125.         LT - fnum2 <  fnum1
  126.         LE - fnum2 <= fnum1
  127.  
  128.     Integer functional result as:
  129.  
  130.         +1 => fnum1 > fnum2
  131.         -1 => fnum1 < fnum2
  132.          0 => fnum1 = fnum2
  133.  
  134. BUGS
  135.     None.
  136.  
  137. SEE ALSO
  138.  
  139. mathffp.library/SPDiv                                   mathffp.library/SPDiv
  140.  
  141. NAME
  142.     SPDiv -- Divide two floating point numbers.
  143.  
  144. SYNOPSIS
  145.     fnum3 = SPDiv(fnum1, fnum2)
  146.     D0          D1     D0
  147.  
  148.     float SPDiv(float fnum1, float fnum2);
  149.  
  150. FUNCTION
  151.     Accepts two floating point numbers and returns the arithmetic
  152.     division of said numbers.
  153.  
  154. INPUTS
  155.     fnum1     - floating point number.
  156.     fnum2    - floating point number.
  157.  
  158. RESULT
  159.  
  160.     fnum3     - floating point number.
  161.  
  162. BUGS
  163.     None.
  164.  
  165. SEE ALSO
  166.  
  167. mathffp.library/SPFix                                   mathffp.library/SPFix
  168.  
  169. NAME
  170.     SPFix -- Convert fast floating point number to integer.
  171.  
  172. SYNOPSIS
  173.     inum = SPFix(fnum)
  174.     D0         D0
  175.  
  176.     int SPFix(float fnum);
  177.  
  178. FUNCTION
  179.     Accepts a floating point number and returns the truncated
  180.     integer portion of said number.
  181.  
  182. INPUTS
  183.  
  184.     fnum     - floating point number.
  185.  
  186. RESULT
  187.  
  188.     inum     - signed integer number.
  189.  
  190. BUGS
  191.     None.
  192.  
  193. SEE ALSO
  194.  
  195. mathffp.library/SPFloor                               mathffp.library/SPFloor
  196.  
  197.    NAME
  198.     SPFloor -- compute Floor function of a number.
  199.  
  200.    SYNOPSIS
  201.     x = SPFloor(y)
  202.     D0         D0
  203.  
  204.     float SPFloor(float y);
  205.  
  206.    FUNCTION
  207.     Calculate the largest integer less than or equal to x and return it.
  208.  
  209.    INPUTS
  210.     y     - Motorola Fast Floating Point number.
  211.  
  212.    RESULT
  213.     x     - Motorola Fast Floating Point number.
  214.  
  215.    BUGS
  216.     None.
  217.  
  218.    SEE ALSO
  219.     SPCeil()
  220.  
  221. mathffp.library/SPFlt                                   mathffp.library/SPFlt
  222.  
  223. NAME
  224.     SPFlt -- Convert integer number to fast floating point.
  225.  
  226.  
  227. SYNOPSIS
  228.     fnum = SPFlt(inum)
  229.     D0         D0
  230.  
  231.     float SPFlt(int inum);
  232.  
  233. FUNCTION
  234.     Accepts an integer and returns the converted
  235.     floating point result of said number.
  236.  
  237. INPUTS
  238.     inum     - signed integer number
  239.  
  240. RESULT
  241.     fnum     - floating point number
  242.  
  243. BUGS
  244.     None.
  245.  
  246. SEE ALSO
  247.  
  248. mathffp.library/SPMul                                   mathffp.library/SPMul
  249.  
  250. NAME
  251.     SPMul -- Multiply two floating point numbers.
  252.  
  253. SYNOPSIS
  254.     fnum3 = SPMul(fnum1, fnum2)
  255.     D0          D1     D0
  256.  
  257.     float SPMul(float fnum1, float fnum2);
  258.  
  259. FUNCTION
  260.     Accepts two floating point numbers and returns the arithmetic
  261.     multiplication of said numbers.
  262.  
  263. INPUTS
  264.     fnum1     - floating point number
  265.     fnum2     - floating point number
  266.  
  267. RESULT
  268.     fnum3     - floating point number
  269.  
  270. BUGS
  271.     None
  272.  
  273. SEE ALSO
  274.  
  275. mathffp.library/SPNeg                                   mathffp.library/SPNeg
  276.  
  277. NAME
  278.     SPNeg -- Negate the supplied floating point number.
  279.  
  280. SYNOPSIS
  281.     fnum2 = SPNeg(fnum1)
  282.     D0          D0
  283.  
  284.     float SPNeg(float fnum1);
  285.  
  286. FUNCTION
  287.     Accepts a floating point number and returns the value
  288.     of said number after having been subtracted from 0.0.
  289.  
  290. INPUTS
  291.     fnum1     - floating point number.
  292.  
  293. RESULT
  294.     fnum2     - floating point negation of fnum1.
  295.  
  296. BUGS
  297.     None
  298.  
  299. SEE ALSO
  300.  
  301.  
  302. mathffp.library/SPSub                                   mathffp.library/SPSub
  303.  
  304. NAME
  305.     SPSub -- Subtract two floating point numbers.
  306.  
  307. SYNOPSIS
  308.     fnum3 = SPSub(fnum1, fnum2)
  309.     D0          D1     D0
  310.  
  311.     float SPSub(float fnum1, float fnum2);
  312.  
  313. FUNCTION
  314.     Accepts two floating point numbers and returns the arithmetic
  315.     subtraction of said numbers.
  316.  
  317. INPUTS
  318.     fnum1     - floating point number.
  319.     fnum2     - floating point number.
  320.  
  321. RESULT
  322.     fnum3     - floating point number.
  323.  
  324. BUGS
  325.     None.
  326.  
  327. SEE ALSO
  328.  
  329. mathffp.library/SPTst                                   mathffp.library/SPTst
  330.  
  331. NAME
  332.     SPTst - Compares a float against zero (0.0).
  333.  
  334. SYNOPSIS
  335.     result = SPTst(fnum)
  336.     D0           D1
  337.  
  338.     int SPTst(float fnum);
  339.  
  340. FUNCTION
  341.     Accepts a floating point number and returns the condition
  342.     codes set to indicate the result of a comparison against
  343.     the value of zero (0.0).  Additionally, the integer functional
  344.     result is returned.
  345.  
  346. INPUTS
  347.     fnum     - floating point number.
  348.  
  349. RESULT
  350.     Condition codes set to reflect the following branches:
  351.  
  352.         EQ - fnum =  0.0
  353.         NE - fnum != 0.0
  354.         PL - fnum >= 0.0
  355.         MI - fnum <  0.0
  356.  
  357.     Integer functional result as:
  358.  
  359.         +1 => fnum > 0.0
  360.         -1 => fnum < 0.0
  361.          0 => fnum = 0.0
  362.  
  363. BUGS
  364.     None.
  365.  
  366. SEE ALSO
  367.  
  368.