Mercurial > hg > octave-lyh

diff scripts/general/cplxpair.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents eb63fbe60fab
children c1fff751b5a8
line wrap: on
line diff
--- a/scripts/general/cplxpair.m
+++ b/scripts/general/cplxpair.m
@@ -20,19 +20,19 @@
 ## @deftypefn {Function File} {} cplxpair (@var{z}, @var{tol}, @var{dim})
 ## Sort the numbers @var{z} into complex conjugate pairs ordered by 
 ## increasing real part.  With identical real parts, order by increasing
-## imaginary magnitude. Place the negative imaginary complex number
-## first within each pair. Place all the real numbers after all the 
+## imaginary magnitude.  Place the negative imaginary complex number
+## first within each pair.  Place all the real numbers after all the 
 ## complex pairs (those with @code{abs (imag (@var{z}) / @var{z}) < 
 ## @var{tol})}, where the default value of @var{tol} is @code{100 * 
 ## @var{eps}}.
 ##
 ## By default the complex pairs are sorted along the first non-singleton
-## dimension of @var{z}. If @var{dim} is specified, then the complex
+## dimension of @var{z}.  If @var{dim} is specified, then the complex
 ## pairs are sorted along this dimension.
 ##
-## Signal an error if some complex numbers could not be paired. Requires
+## Signal an error if some complex numbers could not be paired.  Requires
 ## all complex numbers to be exact conjugates within tol, or signals an 
-## error. Note that there are no guarantees on the order of the returned
+## error.  Note that there are no guarantees on the order of the returned
 ## pairs with identical real parts but differing imaginary parts.
 ##
 ## @c Using 'smallexample' to make text fit in page when using 'smallbook'