From 65802450f601f4f009a5c24a028fe6ffb2ba556a Mon Sep 17 00:00:00 2001
From: simon
Date: Tue, 28 Oct 2008 14:36:18 +0000
Subject: added comment

---
 src/signalProcessing/includes/fft.h  | 19 +++++++++++++++++--
 src/signalProcessing/includes/ifft.h | 17 +++++++++++++++++
 2 files changed, 34 insertions(+), 2 deletions(-)

(limited to 'src/signalProcessing/includes')

diff --git a/src/signalProcessing/includes/fft.h b/src/signalProcessing/includes/fft.h
index da88d709..3766639b 100644
--- a/src/signalProcessing/includes/fft.h
+++ b/src/signalProcessing/includes/fft.h
@@ -20,9 +20,24 @@
 #include "lapack.h"
 #include "fft_internal.h"
 
-void cfftma ( floatComplex* in , int rows, int cols, floatComplex* out);
 
-void zfftma ( doubleComplex* in , int rows, int cols, doubleComplex* out);
+/*
+** compute the fast fourier transform of a vector
+** param in  : the input matrix in complex float precision
+** param rows: number of rows of the input matrix
+** param cols: number of cols of the input matrix
+** param out : the transformed matrix in complex float precision
+*/
+
 void cfftma ( floatComplex* in , int rows, int cols, floatComplex* out);
+/*
+** compute the fast fourier transform of a vector
+** param in  : the input matrix in complex double precision
+** param rows: number of rows of the input matrix
+** param cols: number of cols of the input matrix
+** param out : the transformed matrix in complex double precision
+*/
+void zfftma ( doubleComplex* in , int rows, int cols, doubleComplex* out);
+
 #endif /* !__FFT_H__ */
 
diff --git a/src/signalProcessing/includes/ifft.h b/src/signalProcessing/includes/ifft.h
index 3ba39485..5f698a5b 100644
--- a/src/signalProcessing/includes/ifft.h
+++ b/src/signalProcessing/includes/ifft.h
@@ -20,7 +20,24 @@
 #include "lapack.h"
 #include "fft_internal.h"
 
+/*
+** compute the inverse fast fourier transform of a vector
+** param in  : the input matrix in complex double precision
+** param rows: number of rows of the input matrix
+** param cols: number of cols of the input matrix
+** param out : the transformed matrix in complex double precision
+*/
+
+
 void zifftma ( doubleComplex* in , int rows, int cols, doubleComplex* out);
+/*
+** compute the inverse fast fourier transform of a vector
+** param in  : the input matrix in complex float precision
+** param rows: number of rows of the input matrix
+** param cols: number of cols of the input matrix
+** param out : the transformed matrix in complex float precision
+*/
+
 void cifftma ( floatComplex* in , int rows, int cols, floatComplex* out);
 
 
-- 
cgit