Mercurial > hg > octave-nkf

comparison scripts/general/cplxpair.m @ 9141:c1fff751b5a8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update section 17.1 (Utility Functions) of arith.txi Split section into "Exponents and Logarithms" and "Utility Functions" Use Tex in many more of the doc strings for pretty printing in pdf format.
author Rik <rdrider0-list@yahoo.com>
date Mon, 20 Apr 2009 17:16:09 -0700
parents 1bf0ce0930be
children 5247e89688e1
comparison
equal deleted inserted replaced
9140:c309e028185e 9141:c1fff751b5a8
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} cplxpair (@var{z}, @var{tol}, @var{dim}) 20 ## @deftypefn {Function File} {} cplxpair (@var{z})
21 ## @deftypefnx {Function File} {} cplxpair (@var{z}, @var{tol})
22 ## @deftypefnx {Function File} {} cplxpair (@var{z}, @var{tol}, @var{dim})
21 ## Sort the numbers @var{z} into complex conjugate pairs ordered by 23 ## Sort the numbers @var{z} into complex conjugate pairs ordered by
22 ## increasing real part. With identical real parts, order by increasing 24 ## increasing real part. Place the negative imaginary complex number
23 ## imaginary magnitude. Place the negative imaginary complex number 25 ## first within each pair. Place all the real numbers (those with
24 ## first within each pair. Place all the real numbers after all the 26 ## @code{abs (imag (@var{z}) / @var{z}) < @var{tol})}) after the
25 ## complex pairs (those with @code{abs (imag (@var{z}) / @var{z}) < 27 ## complex pairs.
26 ## @var{tol})}, where the default value of @var{tol} is @code{100 * 28 ##
27 ## @var{eps}}. 29 ## If @var{tol} is unspecified the default value is 100*@var{eps}.
28 ## 30 ##
29 ## By default the complex pairs are sorted along the first non-singleton 31 ## By default the complex pairs are sorted along the first non-singleton
30 ## dimension of @var{z}. If @var{dim} is specified, then the complex 32 ## dimension of @var{z}. If @var{dim} is specified, then the complex
31 ## pairs are sorted along this dimension. 33 ## pairs are sorted along this dimension.
32 ## 34 ##
33 ## Signal an error if some complex numbers could not be paired. Requires 35 ## Signal an error if some complex numbers could not be paired. Requires
34 ## all complex numbers to be exact conjugates within tol, or signals an 36 ## all complex numbers to be exact conjugates within @var{tol}, or signals an
35 ## error. Note that there are no guarantees on the order of the returned 37 ## error. Note that there are no guarantees on the order of the returned
36 ## pairs with identical real parts but differing imaginary parts. 38 ## pairs with identical real parts but differing imaginary parts.
37 ## 39 ##
38 ## @c Using 'smallexample' to make text fit in page when using 'smallbook' 40 ## @c Using 'smallexample' to make text fit in page when using 'smallbook'
39 ## @smallexample 41 ## @smallexample