diff carfac/carfac_common.h @ 611:0fbaf443ec82

Carfac C++ revision 3, indluding more style improvements. The output structs are now classes again, and have separate storage methods for each output structure along with flags in the Run and RunSegment methods to allow for only storing NAPs if desired.

--- a/carfac/carfac_common.h	Thu May 16 17:33:23 2013 +0000
+++ b/carfac/carfac_common.h	Fri May 17 19:52:45 2013 +0000
@@ -49,8 +49,6 @@
 
 // This section is where the base include operations for the CARFAC project
 // occur.
-// <iostream> is used for debugging output, but it could go in final version.
-#include <iostream>
 // <math.h> is used during coefficient calculations and runtime operations.
 #include <math.h>
 // <vector> is used in place of 2d Eigen Arrays for the AGC memory
@@ -73,8 +71,8 @@
 typedef Eigen::Array<FPType, Dynamic, 1> FloatArray;  // This is a 1d array.
 typedef Eigen::Array<FPType, Dynamic, Dynamic> FloatArray2d;  // This is 2d.
 
-// Two psychoacoustics helper functions are defined here for use by the
-// different processing stages in calculating coeffecients.
+// Two helper functions are defined here for use by the different model stages
+// in calculating coeffecients and during model runtime.
 
 // Function: ERBHz
 // Auditory filter nominal Equivalent Rectangular Bandwidth
@@ -82,7 +80,8 @@
 FPType ERBHz(FPType cf_hz, FPType erb_break_freq, FPType erb_q);
 
 // Function CARFACDetect
-// TODO explain a bit more
+// This returns the IHC detection nonilnearity function of the filter output
+// values.  This is here because it is called both in design and run phases.
 FloatArray CARFACDetect (FloatArray x);
 
 #endif
\ No newline at end of file