Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_fxpt.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 #ifndef INCLUDED_GR_FXPT_H
23 #define INCLUDED_GR_FXPT_H
24
25 #include <gr_types.h>
26
27 /*!
28  * \brief fixed point sine and cosine and friends.
29  *
30  *   fixed pt   radians
31  *  ---------   --------
32  *   -2**31       -pi
33  *        0         0
34  *  2**31-1        pi - epsilon
35  *
36  */
37 class gr_fxpt
38 {
39   static const int WORDBITS = 32;
40   static const int NBITS = 10;
41   static const float s_sine_table[1 << NBITS][2];
42   static const float PI = 3.14159265358979323846;
43   static const float TWO_TO_THE_31 = 2147483648.0;
44 public:
45
46   static gr_int32
47   float_to_fixed (float x)
48   {
49     return (gr_int32) ((float) x * TWO_TO_THE_31 / PI);
50   }
51
52   static float
53   fixed_to_float (gr_int32 x)
54   {
55     return x * (PI / TWO_TO_THE_31);
56   }
57
58   /*!
59    * \brief Given a fixed point angle x, return float sine (x)
60    */
61   static float
62   sin (gr_int32 x)
63   {
64     gr_uint32 ux = x;
65     int index = ux >> (WORDBITS - NBITS);
66     return s_sine_table[index][0] * (ux >> 1) + s_sine_table[index][1];
67   }
68
69   /*
70    * \brief Given a fixed point angle x, return float cosine (x)
71    */
72   static float
73   cos (gr_int32 x)
74   {
75     gr_uint32 ux = x + 0x40000000;
76     int index = ux >> (WORDBITS - NBITS);
77     return s_sine_table[index][0] * (ux >> 1) + s_sine_table[index][1];
78   }
79
80 };
81
82 #endif /* INCLUDED_GR_FXPT_H */