GFftWavetable.hpp
5.9 KB
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
/***************************************************************************
* GFftWavetable.hpp - Lookup table class for Fast Fourier transformation *
* ----------------------------------------------------------------------- *
* copyright (C) 2016-2018 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* 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 3 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, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GFftWavetable.hpp
* @brief Lookup table class interface definition for Fast Fourier transformation
* @author Juergen Knoedlseder
*/
#ifndef GFFTWAVETABLE_HPP
#define GFFTWAVETABLE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include <complex>
#include "GBase.hpp"
/* __ Forward declarations _______________________________________________ */
/***********************************************************************//**
* @class GFftWavetable
*
* @brief Lookup table class for Fast Fourier Transformation
***************************************************************************/
class GFftWavetable : public GBase {
public:
// Constructors and destructors
GFftWavetable(void);
explicit GFftWavetable(const int& size);
GFftWavetable(const GFftWavetable& wavetable);
virtual ~GFftWavetable(void);
// Operators
GFftWavetable& operator=(const GFftWavetable& wavetable);
std::complex<double>& operator[](const int& index);
const std::complex<double>& operator[](const int& index) const;
// Methods
void clear(void);
GFftWavetable* clone(void) const;
std::string classname(void) const;
int size(void) const;
const int& index(const int& factor) const;
int factors(void) const;
int factor(const int& index) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GFftWavetable& wavetable);
void free_members(void);
void set_members(const int& n);
void set_factors(const int& n);
// Protected members
std::vector<int> m_factors; //!< Wavetable factors
std::vector<int> m_twiddle; //!< Start index of factors
std::vector<std::complex<double> > m_trig; //!< Trigonometric coefficients
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GFftWavetable").
***************************************************************************/
inline
std::string GFftWavetable::classname(void) const
{
return ("GFftWavetable");
}
/***********************************************************************//**
* @brief Return reference to trigonometric coefficient
*
* @param[in] index Trigonometric coefficient index [0,...,size()-1].
*
* Returns a reference to the trigonometric coefficient with the specified
* @p index.
***************************************************************************/
inline
std::complex<double>& GFftWavetable::operator[](const int& index)
{
return (m_trig[index]);
}
/***********************************************************************//**
* @brief Return reference to trigonometric coefficient (const version)
*
* @param[in] index Trigonometric coefficient index [0,...,size()-1].
*
* Returns a const reference to the trigonometric coefficient with the
* specified @p index.
***************************************************************************/
inline
const std::complex<double>& GFftWavetable::operator[](const int& index) const
{
return (m_trig[index]);
}
/***********************************************************************//**
* @brief Return start index for a given factor
*
* @param[in] factor Factor index [0,...,factors()-1].
*
* Returns the index of the first trigonometric coefficient for a given
* @p factor.
***************************************************************************/
inline
const int& GFftWavetable::index(const int& factor) const
{
return (m_twiddle[factor]);
}
/***********************************************************************//**
* @brief Return number of trigonometric coefficients
*
* @return Number of trigonometric coefficients.
***************************************************************************/
inline
int GFftWavetable::size(void) const
{
return ((int)m_trig.size());
}
/***********************************************************************//**
* @brief Return number of factorisation factors
*
* @return Number of factorisation factors.
***************************************************************************/
inline
int GFftWavetable::factors(void) const
{
return ((int)m_factors.size());
}
#endif /* GFFTWAVETABLE_HPP */