git.gag.com Git - debian/gnuradio/blob - 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  * \ingroup misc
  29  *
  30  * Generates a maximal length pseudo-random sequence of length 2^degree-1
  31  */
  32
  33 class gri_glfsr
  34 {
  35  private:
  36   int d_shift_register;
  37   int d_mask;
  38
  39  public:
  40
  41   gri_glfsr(int mask, int seed) { d_shift_register = seed; d_mask = mask; }
  42   static int glfsr_mask(int degree);
  43
  44   unsigned char next_bit() {
  45     unsigned char bit = d_shift_register & 1;
  46     d_shift_register >>= 1;
  47     if (bit)
  48       d_shift_register ^= d_mask;
  49     return bit;
  50   }
  51
  52   int mask() const { return d_mask; }
  53 };
  54
  55 #endif /* INCLUDED_GRI_GLFSR_H */