0bc1ee07c99b47b770f531242e96dc3d58a713c7
[olsrd.git] / src / mantissa.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: mantissa.c,v 1.9 2007/08/28 20:45:17 bernd67 Exp $
40  */
41
42 #include "mantissa.h"
43
44 /**
45  *Function that converts a double to a mantissa/exponent
46  *product as described in RFC3626:
47  *
48  * value = C*(1+a/16)*2^b [in seconds]
49  *
50  *  where a is the integer represented by the four highest bits of the
51  *  field and b the integer represented by the four lowest bits of the
52  *  field.
53  *
54  *@param interval the time interval to process
55  *
56  *@return a 8-bit mantissa/exponent product
57  */
58
59 olsr_u8_t
60 double_to_me(const double interval)
61 {
62     olsr_u8_t a, b;
63
64     /* It is sufficent to compare the integer part since we test on >=.
65      * So we have now only a floating point division and the rest of the loop
66      * are only integer operations.
67      */
68     const unsigned int unscaled_interval = interval / VTIME_SCALE_FACTOR;
69     b = 0;
70     while (unscaled_interval >= (1U << b)) {
71         b++;
72     }
73
74     if(b == 0) {
75         a = 1;
76         b = 0;
77     } else {
78         b--;
79         if (b > 15) {
80             a = 15;
81             b = 15;
82         } else {
83             /* And again some maths simplification from the former version:
84              *    a = 16 * ((double)interval / (VTIME_SCALE_FACTOR * (double)(1 << b)) - 1)
85              * Since interval is already double:
86              *    a = 16 * (interval / (VTIME_SCALE_FACTOR * (double)(1 << b)) - 1)
87              * first, we can get rid of parentheses and change the * to a /
88              *    a = 16 * (interval / VTIME_SCALE_FACTOR / (double)(1 << b) - 1)
89              * then we make an integer addition from the floating point addition
90              *    a = (int)(16.0 * interval / VTIME_SCALE_FACTOR / (double)(1 << b)) - 16
91              * and we loose an unnecessary cast
92              *    a = (int)(16.0 * interval / VTIME_SCALE_FACTOR / (1 << b)) - 16
93              */
94             a = (int)(16.0 * interval / VTIME_SCALE_FACTOR / (1 << b)) - 16;
95             b += a >> 4;
96             a &= 0x0f;
97         }
98     }
99     //printf("Generated mantissa/exponent(%d/%d): %d from %f\n", a, b, (olsr_u8_t) (a*16+b), interval);  //printf("Resolves back to: %f\n", me_to_double(((a<<4)|(b&0x0F))));
100     return (a << 4) | (b & 0x0F);
101 }
102
103 /**
104  * Function for converting a mantissa/exponent 8bit value back
105  * to double as described in RFC3626:
106  *
107  * value = C*(1+a/16)*2^b [in seconds]
108  *
109  *  where a is the integer represented by the four highest bits of the
110  *  field and b the integer represented by the four lowest bits of the
111  *  field.
112  *
113  * me is the 8 bit mantissa/exponent value
114  *
115  * To avoid expensive floating maths, we transform the equation:
116  *     value = C * (1 + a / 16) * 2^b
117  * first, we make an int addition from the floating point addition:
118  *     value = C * ((16 + a) / 16) * 2^b
119  * then we get rid of a pair of parentheses
120  *     value = C * (16 + a) / 16 * 2^b
121  * and now we make an int multiplication from the floating point one
122  *     value = C * (16 + a) * 2^b / 16
123  * so that we can make a shift from the multiplication
124  *     value = C * ((16 + a) << b) / 16
125  * and sionce C and 16 are constants
126  *     value = ((16 + a) << b) * C / 16
127  */
128 double me_to_double(const olsr_u8_t me)
129 {
130     const olsr_u8_t a = me >> 4;
131     const olsr_u8_t b = me & 0x0F;
132     return ((16 + a) << b) * VTIME_SCALE_FACTOR / 16.0;
133 }