GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
glfsr.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2007,2012 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_DIGITAL_GLFSR_H
24#define INCLUDED_DIGITAL_GLFSR_H
25
27
28namespace gr {
29namespace digital {
30
31/*!
32 * \brief Galois Linear Feedback Shift Register using specified polynomial mask
33 * \ingroup waveform_generators_blk
34 *
35 * \details
36 * Generates a maximal length pseudo-random sequence of length 2^degree-1
37 */
39{
40private:
41 int d_shift_register;
42 int d_mask;
43
44public:
45 glfsr(int mask, int seed)
46 {
47 d_shift_register = seed;
48 d_mask = mask;
49 }
51
52 static int glfsr_mask(int degree);
53
54 unsigned char next_bit()
55 {
56 unsigned char bit = d_shift_register & 1;
57 d_shift_register >>= 1;
58 if (bit)
59 d_shift_register ^= d_mask;
60 return bit;
61 }
62
63 int mask() const { return d_mask; }
64};
65
66} /* namespace digital */
67} /* namespace gr */
68
69#endif /* INCLUDED_DIGITAL_GLFSR_H */
Galois Linear Feedback Shift Register using specified polynomial mask.
Definition: glfsr.h:39
int mask() const
Definition: glfsr.h:63
unsigned char next_bit()
Definition: glfsr.h:54
glfsr(int mask, int seed)
Definition: glfsr.h:45
static int glfsr_mask(int degree)
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45