Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gnuradio-core / src / lib / general / gri_glfsr.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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 3, 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
23 #ifndef INCLUDED_GRI_GLFSR_H
24 #define INCLUDED_GRI_GLFSR_H
25
26 /*!
27  * \brief Galois Linear Feedback Shift Register using specified polynomial mask
28  *
29  * Generates a maximal length pseudo-random sequence of length 2^degree-1
30  */
31
32 class gri_glfsr
33 {
34  private:
35   int d_shift_register;
36   int d_mask;
37
38  public:
39
40   gri_glfsr(int mask, int seed) { d_shift_register = seed; d_mask = mask; }
41   static int glfsr_mask(int degree);
42
43   unsigned char next_bit() {
44     unsigned char bit = d_shift_register & 1;
45     d_shift_register >>= 1;
46     if (bit)
47       d_shift_register ^= d_mask;
48     return bit;
49   }
50
51   int mask() const { return d_mask; }
52 };
53
54 #endif /* INCLUDED_GRI_GLFSR_H */