Imported Upstream version 3.2.2

[debian/gnuradio] / gnuradio-core / src / lib / filter / gri_mmse_fir_interpolator_cc.h

diff --git a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
index 527c3ec3bef6e5f1014c2b7b901ad851fc8de75b..daf8b19b832e5c1f662a7343b4bd48c59b07d0e0 100644 (file)
--- a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
+++ b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2002 Free Software Foundation, Inc.
+ * Copyright 2002,2007 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -29,6 +29,7 @@ class gr_fir_ccf;
 
 /*!
  * \brief Compute intermediate samples between signal samples x(k*Ts)
+ * \ingroup filter_primitive
  *
  * This implements a Mininum Mean Squared Error interpolator with 8 taps.
  * It is suitable for signals where the bandwidth of interest B = 1/(4*Ts)
@@ -49,8 +50,10 @@ public:
 
   /*!
    * \brief compute a single interpolated output value.
-   * \p input must have ntaps() valid entries.
+   *
+   * \p input must have ntaps() valid entries and be 8-byte aligned.
    * input[0] .. input[ntaps() - 1] are referenced to compute the output value.
+   * \throws std::invalid_argument if input is not 8-byte aligned.
    *
    * \p mu must be in the range [0, 1] and specifies the fractional delay.
    *