src/cvec.h: add formula
authorPaul Brossier <piem@piem.org>
Sun, 26 Mar 2017 15:38:41 +0000 (17:38 +0200)
committerPaul Brossier <piem@piem.org>
Sun, 26 Mar 2017 15:38:41 +0000 (17:38 +0200)
src/cvec.h

index be4bbab..7c826b6 100644 (file)
@@ -235,6 +235,8 @@ void cvec_zeros(cvec_t *s);
   \param s input cvec to compress
   \param lambda value to use for normalisation
 
+  \f$ S_k = log( \lambda * S_k + 1 ) \f$
+
 */
 void cvec_logmag(cvec_t *s, smpl_t lambda);