Home > freetb4matlab > general > cplxpair.m

cplxpair

PURPOSE ^

% Sort the numbers @var{z} into complex conjugate pairs ordered by

SYNOPSIS ^

function y = cplxpair (z, tol, dim)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn  {Function File} {} cplxpair (@var{z})
% @deftypefnx {Function File} {} cplxpair (@var{z}, @var{tol})
% @deftypefnx {Function File} {} cplxpair (@var{z}, @var{tol}, @var{dim})
% Sort the numbers @var{z} into complex conjugate pairs ordered by 
% increasing real part.  Place the negative imaginary complex number
% first within each pair.  Place all the real numbers (those with
% @code{abs (imag (@var{z}) / @var{z}) < @var{tol})}) after the
% complex pairs.
%
% If @var{tol} is unspecified the default value is 100*@code{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
% pairs are sorted along this dimension.
%
% Signal an error if some complex numbers could not be paired.  Signal an
% error if all complex numbers are not exact conjugates (to within
% @var{tol}).  Note that there is no defined order for pairs with identical
% real parts but differing imaginary parts.
%
% @c Set example in small font to prevent overfull line
% @smallexample
% cplxpair (exp(2i*pi*[0:4]'/5)) == exp(2i*pi*[3; 2; 4; 1; 0]/5)
% @end smallexample
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003