Improvements to comments etc.
[AROS.git] / workbench / libs / mathtrans / splog.c
blob2a3dabbc1e3a9f5f60d9330b423680a33a348e9c
1 /*
2 Copyright © 1995-2008, The AROS Development Team. All rights reserved.
3 $Id$
4 */
6 #include "mathtrans_intern.h"
8 /*****************************************************************************
10 NAME */
12 AROS_LH1(float, SPLog,
14 /* SYNOPSIS */
15 AROS_LHA(float, fnum1, D0),
17 /* LOCATION */
18 struct Library *, MathTransBase, 14, MathTrans)
20 /* FUNCTION
21 Calculate logarithm (base e) of the given ffp number
23 INPUTS
25 RESULT
26 ffp-number
28 flags:
29 zero : result is zero
30 negative : result is negative
31 overflow : argument was negative
33 BUGS
35 INTERNALS
36 ALGORITHM:
38 If the Argument is negative set overflow-flag and return 0.
39 If the Argument is 0 return 0xffffffff.
41 All other cases:
43 (ld is the logarithm with base 2)
44 (ln is the logarithm with base e)
46 fnum1 = M * 2^E
48 ln fnum1 = ln ( M * 2^E ) =
50 = ln M + ln 2^E =
52 = ln M + E * ln (2) =
54 ld M ld 2
55 = ----- + E * ----- = [ld 2 = 1]
56 ld e ld e
58 ld M + E
59 = --------
60 ld e
62 ld e can be precalculated, of course.
63 For calculating ld M see file intern_spld.c
65 *****************************************************************************/
67 AROS_LIBFUNC_INIT
69 LONG ld_M, Exponent, Mask = 0x40, i, Sign;
71 /* check for negative sign */
72 if ((char) fnum1 < 0)
74 SetSR(Overflow_Bit, Zero_Bit | Negative_Bit | Overflow_Bit);
75 return 0;
78 /* check for argument == 0 -> return (-infinity) */
79 if (fnum1 == 0) return FFP_Ninfty;
81 /* convert the Exponent of the argument (fnum1) to the ffp-format */
82 Exponent = (fnum1 & FFPExponent_Mask) - 0x40;
83 if (Exponent < 0 )
85 Exponent =-Exponent;
86 Sign = FFPSign_Mask;
88 else
90 Sign = 0;
93 /* find the number of the highest set bit in the exponent */
94 if (Exponent != 0)
96 i = 0;
97 while ( (Mask & Exponent) == 0)
99 i ++;
100 Mask >>= 1;
102 Exponent <<= (25 + i);
103 Exponent |= (0x47 - i + Sign);
106 ld_M = intern_SPLd((fnum1 & FFPMantisse_Mask) | 0x40);
108 /* ld M + E
109 ** ln(fnum1) = --------
110 ** ld e
113 return SPMul( SPAdd(ld_M, Exponent), InvLde);
115 AROS_LIBFUNC_EXIT