comparison 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.

 
 #ifndef CARFAC_AGC_H
 #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;
     agc_stage_gain = 2.0;
     time_constants.resize(num_stages);

   std::vector<int> decimation;
   std::vector<FPType> agc1_scales;
   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;
   FPType agc_epsilon;
   int decimation;

   FPType agc_gain;
   FPType detect_scale;
   FPType decim;
 };
 
+// Automatic gain control filter state.
 struct AGCState {
   ArrayX agc_memory;
   ArrayX input_accum;
   int decim_phase;
 };