File: cfixed.h

package info (click to toggle)
libitpp 4.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 7,520 kB
  • ctags: 6,341
  • sloc: cpp: 51,608; sh: 9,248; makefile: 636; fortran: 8
file content (259 lines) | stat: -rw-r--r-- 8,824 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/*!
 * \file
 * \brief Definitions of a complex fixed-point data type CFixed
 * \author Johan Bergman
 *
 * -------------------------------------------------------------------------
 *
 * IT++ - C++ library of mathematical, signal processing, speech processing,
 *        and communications classes and functions
 *
 * Copyright (C) 1995-2008  (see AUTHORS file for a list of contributors)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * -------------------------------------------------------------------------
 */

#ifndef CFIXED_H
#define CFIXED_H

#ifndef _MSC_VER
#  include <itpp/config.h>
#else
#  include <itpp/config_msvc.h>
#endif

#include <itpp/fixed/cfix.h>


namespace itpp {

  /*!
   * \addtogroup fixed
   * @{
   */

  /*!
    \brief Templated complex fixed-point data type

    See the Detailed Description in the \ref fixed module.
  */
  template<int w, e_mode e=TC, o_mode o=WRAP, q_mode q=TRN>
  class CFixed : public CFix {
  public:
    //! Default constructor
    CFixed(double r=0.0, double i=0.0, int s=0, Stat *ptr=0)
      : CFix(r, i, s, w, e, o, q, ptr) {}
    //! Constructor
    CFixed(std::complex<double> x, double dummy=0.0, int s=0, Stat *ptr=0)
      : CFix(x, 0.0, s, w, e, o, q, ptr) {}
    //! Constructor
    explicit CFixed(Stat *ptr)
      : CFix(0.0, 0.0, 0, w, e, o, q, ptr) {}
    //! Constructor
    CFixed(const Fix &r, const Fix &i=0.0, Stat *ptr=0)
      : CFix(r, i, w, e, o, q, ptr) {}
    //! Constructor
    CFixed(const CFix &x, double dummy=0.0, Stat *ptr=0)
      : CFix(x, 0.0, w, e, o, q, ptr) {}
    //! Destructor
    virtual ~CFixed() {}

    //! Assignment from CFix
    CFixed& operator=(const CFix &x)
    {
      shift = x.shift;
      re = apply_o_mode(x.re);
      im = apply_o_mode(x.im);
      return *this;
    }
    //! Assignment from Fix
    CFixed& operator=(const Fix &x)
    {
      shift = x.shift;
      re = apply_o_mode(x.re);
      im = 0;
      return *this;
    }
    //! Assignment from complex<double>. Fractional part is truncated
    CFixed& operator=(const std::complex<double> &x)
    {
      shift = 0;
      re = apply_o_mode(fixrep(real(x)));
      im = apply_o_mode(fixrep(imag(x)));
      return *this;
    }
    //! Assignment from int
    CFixed& operator=(int x)
    {
      shift = 0;
      re = apply_o_mode(x);
      im = 0;
      return *this;
    }
  protected:
  };

  /*! @} */

  //! Typedefs for CFixed (cfixed1, cfixed2, ..., cfixed64)
  typedef CFixed<1, TC, WRAP> cfixed1;
//! \cond
  typedef CFixed<2, TC, WRAP> cfixed2;
  typedef CFixed<3, TC, WRAP> cfixed3;
  typedef CFixed<4, TC, WRAP> cfixed4;
  typedef CFixed<5, TC, WRAP> cfixed5;
  typedef CFixed<6, TC, WRAP> cfixed6;
  typedef CFixed<7, TC, WRAP> cfixed7;
  typedef CFixed<8, TC, WRAP> cfixed8;
  typedef CFixed<9, TC, WRAP> cfixed9;
  typedef CFixed<10, TC, WRAP> cfixed10;
  typedef CFixed<11, TC, WRAP> cfixed11;
  typedef CFixed<12, TC, WRAP> cfixed12;
  typedef CFixed<13, TC, WRAP> cfixed13;
  typedef CFixed<14, TC, WRAP> cfixed14;
  typedef CFixed<15, TC, WRAP> cfixed15;
  typedef CFixed<16, TC, WRAP> cfixed16;
  typedef CFixed<17, TC, WRAP> cfixed17;
  typedef CFixed<18, TC, WRAP> cfixed18;
  typedef CFixed<19, TC, WRAP> cfixed19;
  typedef CFixed<20, TC, WRAP> cfixed20;
  typedef CFixed<21, TC, WRAP> cfixed21;
  typedef CFixed<22, TC, WRAP> cfixed22;
  typedef CFixed<23, TC, WRAP> cfixed23;
  typedef CFixed<24, TC, WRAP> cfixed24;
  typedef CFixed<25, TC, WRAP> cfixed25;
  typedef CFixed<26, TC, WRAP> cfixed26;
  typedef CFixed<27, TC, WRAP> cfixed27;
  typedef CFixed<28, TC, WRAP> cfixed28;
  typedef CFixed<29, TC, WRAP> cfixed29;
  typedef CFixed<30, TC, WRAP> cfixed30;
  typedef CFixed<31, TC, WRAP> cfixed31;
  typedef CFixed<32, TC, WRAP> cfixed32;
  typedef CFixed<33, TC, WRAP> cfixed33;
  typedef CFixed<34, TC, WRAP> cfixed34;
  typedef CFixed<35, TC, WRAP> cfixed35;
  typedef CFixed<36, TC, WRAP> cfixed36;
  typedef CFixed<37, TC, WRAP> cfixed37;
  typedef CFixed<38, TC, WRAP> cfixed38;
  typedef CFixed<39, TC, WRAP> cfixed39;
  typedef CFixed<40, TC, WRAP> cfixed40;
  typedef CFixed<41, TC, WRAP> cfixed41;
  typedef CFixed<42, TC, WRAP> cfixed42;
  typedef CFixed<43, TC, WRAP> cfixed43;
  typedef CFixed<44, TC, WRAP> cfixed44;
  typedef CFixed<45, TC, WRAP> cfixed45;
  typedef CFixed<46, TC, WRAP> cfixed46;
  typedef CFixed<47, TC, WRAP> cfixed47;
  typedef CFixed<48, TC, WRAP> cfixed48;
  typedef CFixed<49, TC, WRAP> cfixed49;
  typedef CFixed<50, TC, WRAP> cfixed50;
  typedef CFixed<51, TC, WRAP> cfixed51;
  typedef CFixed<52, TC, WRAP> cfixed52;
  typedef CFixed<53, TC, WRAP> cfixed53;
  typedef CFixed<54, TC, WRAP> cfixed54;
  typedef CFixed<55, TC, WRAP> cfixed55;
  typedef CFixed<56, TC, WRAP> cfixed56;
  typedef CFixed<57, TC, WRAP> cfixed57;
  typedef CFixed<58, TC, WRAP> cfixed58;
  typedef CFixed<59, TC, WRAP> cfixed59;
  typedef CFixed<60, TC, WRAP> cfixed60;
  typedef CFixed<61, TC, WRAP> cfixed61;
  typedef CFixed<62, TC, WRAP> cfixed62;
  typedef CFixed<63, TC, WRAP> cfixed63;
  typedef CFixed<64, TC, WRAP> cfixed64;
  //! \endcond

  //! Typedefs for saturated CFixed (scfixed1, scfixed2, ..., scfixed64)
  typedef CFixed<1, TC, WRAP> cfixed1;
  //! \cond
  typedef CFixed<1, TC, SAT> scfixed1;
  typedef CFixed<2, TC, SAT> scfixed2;
  typedef CFixed<3, TC, SAT> scfixed3;
  typedef CFixed<4, TC, SAT> scfixed4;
  typedef CFixed<5, TC, SAT> scfixed5;
  typedef CFixed<6, TC, SAT> scfixed6;
  typedef CFixed<7, TC, SAT> scfixed7;
  typedef CFixed<8, TC, SAT> scfixed8;
  typedef CFixed<9, TC, SAT> scfixed9;
  typedef CFixed<10, TC, SAT> scfixed10;
  typedef CFixed<11, TC, SAT> scfixed11;
  typedef CFixed<12, TC, SAT> scfixed12;
  typedef CFixed<13, TC, SAT> scfixed13;
  typedef CFixed<14, TC, SAT> scfixed14;
  typedef CFixed<15, TC, SAT> scfixed15;
  typedef CFixed<16, TC, SAT> scfixed16;
  typedef CFixed<17, TC, SAT> scfixed17;
  typedef CFixed<18, TC, SAT> scfixed18;
  typedef CFixed<19, TC, SAT> scfixed19;
  typedef CFixed<20, TC, SAT> scfixed20;
  typedef CFixed<21, TC, SAT> scfixed21;
  typedef CFixed<22, TC, SAT> scfixed22;
  typedef CFixed<23, TC, SAT> scfixed23;
  typedef CFixed<24, TC, SAT> scfixed24;
  typedef CFixed<25, TC, SAT> scfixed25;
  typedef CFixed<26, TC, SAT> scfixed26;
  typedef CFixed<27, TC, SAT> scfixed27;
  typedef CFixed<28, TC, SAT> scfixed28;
  typedef CFixed<29, TC, SAT> scfixed29;
  typedef CFixed<30, TC, SAT> scfixed30;
  typedef CFixed<31, TC, SAT> scfixed31;
  typedef CFixed<32, TC, SAT> scfixed32;
  typedef CFixed<33, TC, SAT> scfixed33;
  typedef CFixed<34, TC, SAT> scfixed34;
  typedef CFixed<35, TC, SAT> scfixed35;
  typedef CFixed<36, TC, SAT> scfixed36;
  typedef CFixed<37, TC, SAT> scfixed37;
  typedef CFixed<38, TC, SAT> scfixed38;
  typedef CFixed<39, TC, SAT> scfixed39;
  typedef CFixed<40, TC, SAT> scfixed40;
  typedef CFixed<41, TC, SAT> scfixed41;
  typedef CFixed<42, TC, SAT> scfixed42;
  typedef CFixed<43, TC, SAT> scfixed43;
  typedef CFixed<44, TC, SAT> scfixed44;
  typedef CFixed<45, TC, SAT> scfixed45;
  typedef CFixed<46, TC, SAT> scfixed46;
  typedef CFixed<47, TC, SAT> scfixed47;
  typedef CFixed<48, TC, SAT> scfixed48;
  typedef CFixed<49, TC, SAT> scfixed49;
  typedef CFixed<50, TC, SAT> scfixed50;
  typedef CFixed<51, TC, SAT> scfixed51;
  typedef CFixed<52, TC, SAT> scfixed52;
  typedef CFixed<53, TC, SAT> scfixed53;
  typedef CFixed<54, TC, SAT> scfixed54;
  typedef CFixed<55, TC, SAT> scfixed55;
  typedef CFixed<56, TC, SAT> scfixed56;
  typedef CFixed<57, TC, SAT> scfixed57;
  typedef CFixed<58, TC, SAT> scfixed58;
  typedef CFixed<59, TC, SAT> scfixed59;
  typedef CFixed<60, TC, SAT> scfixed60;
  typedef CFixed<61, TC, SAT> scfixed61;
  typedef CFixed<62, TC, SAT> scfixed62;
  typedef CFixed<63, TC, SAT> scfixed63;
  typedef CFixed<64, TC, SAT> scfixed64;

  // ----------------------------------------------------------------------
  // Instantiations
  // ----------------------------------------------------------------------
#ifdef HAVE_EXTERN_TEMPLATE
  extern template class CFixed<64, TC, WRAP>;
#endif // HAVE_EXTERN_TEMPLATE

  //! \endcond

} // namespace itpp

#endif // #ifndef CFIXED_H