Mercurial > octave

diff src/DLD-FUNCTIONS/fft2.cc @ 11553:01f703952eff

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docstrings for functions in DLD-FUNCTIONS directory. Use same variable names in error() strings and in documentation.
author Rik <octave@nomad.inbox5.com>
date Sun, 16 Jan 2011 22:13:23 -0800
parents fd0a3ac60b0e
children 12df7854fa7c
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/fft2.cc	Sat Jan 15 15:13:06 2011 -0800
+++ b/src/DLD-FUNCTIONS/fft2.cc	Sun Jan 16 22:13:23 2011 -0800
@@ -62,12 +62,12 @@
     {
       double dval = args(1).double_value ();
       if (xisnan (dval))
-        error ("%s: NaN is invalid as the N_ROWS", fcn);
+        error ("%s: number of rows (N) cannot be NaN", fcn);
       else
         {
           n_rows = NINTbig (dval);
           if (n_rows < 0)
-            error ("%s: number of rows must be greater than zero", fcn);
+            error ("%s: number of rows (N) must be greater than zero", fcn);
         }
     }
 
@@ -79,12 +79,12 @@
     {
       double dval = args(2).double_value ();
       if (xisnan (dval))
-        error ("%s: NaN is invalid as the N_COLS", fcn);
+        error ("%s: number of columns (M) cannot be NaN", fcn);
       else
         {
           n_cols = NINTbig (dval);
           if (n_cols < 0)
-            error ("%s: number of columns must be greater than zero", fcn);
+            error ("%s: number of columns (M) must be greater than zero", fcn);
         }
     }
 
@@ -169,16 +169,17 @@
 
 DEFUN_DLD (fft2, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} fft2 (@var{a}, @var{n}, @var{m})\n\
-Compute the two-dimensional FFT of @var{a} using subroutines from\n"
+@deftypefn  {Loadable Function} {} fft2 (@var{A})\n\
+@deftypefnx {Loadable Function} {} fft2 (@var{A}, @var{m}, @var{n})\n\
+Compute the two-dimensional FFT of @var{A} using subroutines from\n"
 FFTSRC
-".  The optional arguments @var{n} and @var{m} may be used specify the\n\
-number of rows and columns of @var{a} to use.  If either of these is\n\
-larger than the size of @var{a}, @var{a} is resized and padded with\n\
+".  The optional arguments @var{m} and @var{n} may be used specify the\n\
+number of rows and columns of @var{A} to use.  If either of these is\n\
+larger than the size of @var{A}, @var{A} is resized and padded with\n\
 zeros.\n\
 \n\
-If @var{a} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
-of @var{a} is treated separately\n\
+If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
+of @var{A} is treated separately\n\
 @seealso {ifft2, fft, fftn, fftw}\n\
 @end deftypefn")
 {
@@ -188,16 +189,17 @@
 
 DEFUN_DLD (ifft2, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} ifft2 (@var{a}, @var{n}, @var{m})\n\
-Compute the inverse two-dimensional FFT of @var{a} using subroutines from\n"
+@deftypefn  {Loadable Function} {} ifft2 (@var{A})\n\
+@deftypefnx {Loadable Function} {} ifft2 (@var{A}, @var{m}, @var{n})\n\
+Compute the inverse two-dimensional FFT of @var{A} using subroutines from\n"
 FFTSRC
-".  The optional arguments @var{n} and @var{m} may be used specify the\n\
-number of rows and columns of @var{a} to use.  If either of these is\n\
-larger than the size of @var{a}, @var{a} is resized and padded with\n\
+".  The optional arguments @var{m} and @var{n} may be used specify the\n\
+number of rows and columns of @var{A} to use.  If either of these is\n\
+larger than the size of @var{A}, @var{A} is resized and padded with\n\
 zeros.\n\
 \n\
-If @var{a} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
-of @var{a} is treated separately\n\
+If @var{A} is a multi-dimensional matrix, each two-dimensional sub-matrix\n\
+of @var{A} is treated separately\n\
 @seealso {fft2, ifft, ifftn, fftw}\n\
 @end deftypefn")
 {