diff trunk/carfac/agc.h @ 688:e50aee5046b1

Style fixes. - Fix most lint errors found by http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py - Clean up commenting style. - Alphabetize #includes and using statements.
author ronw@google.com
date Tue, 11 Jun 2013 20:41:15 +0000
parents d0612798f6de
children
line wrap: on
line diff
--- a/trunk/carfac/agc.h	Tue Jun 11 17:59:08 2013 +0000
+++ b/trunk/carfac/agc.h	Tue Jun 11 20:41:15 2013 +0000
@@ -24,8 +24,11 @@
 #define CARFAC_AGC_H
 
 #include <vector>
+
 #include "common.h"
 
+// Automatic gain control (AGC) parameters, which are used to design the AGC
+// filters.
 struct AGCParams {
   AGCParams() {
     num_stages = 4;
@@ -53,6 +56,8 @@
   std::vector<FPType> agc2_scales;
 };
 
+// Automatic gain control filter coefficients, which are derived from a set of
+// AGCParams.
 struct AGCCoeffs {
   int num_agc_stages;
   FPType agc_stage_gain;
@@ -71,10 +76,11 @@
   FPType decim;
 };
 
+// Automatic gain control filter state.
 struct AGCState {
   ArrayX agc_memory;
   ArrayX input_accum;
   int decim_phase;
 };
 
-#endif  // CARFAC_AGC_H
\ No newline at end of file
+#endif  // CARFAC_AGC_H