diff options
Diffstat (limited to 'gr-digital/include/digital_glfsr_source_f.h')
| -rw-r--r-- | gr-digital/include/digital_glfsr_source_f.h | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/gr-digital/include/digital_glfsr_source_f.h b/gr-digital/include/digital_glfsr_source_f.h index 77d7b0f741..eb5e9554b3 100644 --- a/gr-digital/include/digital_glfsr_source_f.h +++ b/gr-digital/include/digital_glfsr_source_f.h @@ -37,15 +37,7 @@ digital_make_glfsr_source_f(int degree, bool repeat=true, /*! * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0. - * \ingroup source_blk - * - * \param degree Degree of shift register must be in [1, 32]. If mask - * is 0, the degree determines a default mask (see - * digital_impl_glfsr.cc for the mapping). - * \param repeat Set to repeat sequence. - * \param mask Allows a user-defined bit mask for indexes of the shift - * register to feed back. - * \param seed Initial setting for values in shift register. + * \ingroup waveform_generators_blk */ class DIGITAL_API digital_glfsr_source_f : public gr_sync_block { @@ -60,6 +52,17 @@ class DIGITAL_API digital_glfsr_source_f : public gr_sync_block unsigned int d_index; unsigned int d_length; + /*! + * Build a Galois LFSR pseudo-random source generating block. + * + * \param degree Degree of shift register must be in [1, 32]. If mask + * is 0, the degree determines a default mask (see + * digital_impl_glfsr.cc for the mapping). + * \param repeat Set to repeat sequence. + * \param mask Allows a user-defined bit mask for indexes of the shift + * register to feed back. + * \param seed Initial setting for values in shift register. + */ digital_glfsr_source_f(int degree, bool repeat, int mask, int seed); |