diff options
Diffstat (limited to 'macros/cplxreal.sci')
| -rw-r--r-- | macros/cplxreal.sci | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/macros/cplxreal.sci b/macros/cplxreal.sci index b06fac3..7df35ef 100644 --- a/macros/cplxreal.sci +++ b/macros/cplxreal.sci @@ -1,26 +1,27 @@ -/*Description - Sort the numbers z into complex-conjugate-valued and real-valued elements. - The positive imaginary complex numbers of each complex conjugate pair are returned in zc and the real numbers are returned in zr. - Signal an error if some complex numbers could not be paired. - Signal an error if all complex numbers are not exact conjugates (to within tol). - Note that there is no defined order for pairs with identical real parts but differing imaginary parts. -Calling Sequence: - [zc, zr] = cplxreal (z) - [zc, zr] = cplxreal (z, tol) - [zc, zr] = cplxreal (z, tol, dim) -Parameters - Inputs - z - A vector of numbers or Matrix - tol - tol is a weighting factor in the range [0, 1) which determines the tolerance of the matching. - The default value is 100 * eps and the resulting tolerance for a given complex pair is tol * abs (z(i))). - dim - By default the complex pairs are sorted along the first non-singleton dimension of z. If dim is specified, then the complex pairs are sorted along this dimension. - Outputs - zc - complex conjugate pair - zr - real numbers -Example: - with 2 real zeros, one of them equal to 0 - [zc, zr] = cplxreal (roots ([1, 0, 0, 1, 0])) */ function [zc, zr] = cplxreal (z, tol, dim) +// Description +// Sort the numbers z into complex-conjugate-valued and real-valued elements. +// The positive imaginary complex numbers of each complex conjugate pair are returned in zc and the real numbers are returned in zr. +// Signal an error if some complex numbers could not be paired. +// Signal an error if all complex numbers are not exact conjugates (to within tol). +// Note that there is no defined order for pairs with identical real parts but differing imaginary parts. +// Calling Sequence: +// [zc, zr] = cplxreal (z) +// [zc, zr] = cplxreal (z, tol) +// [zc, zr] = cplxreal (z, tol, dim) +// Parameters +// Inputs +// z - A vector of numbers or Matrix +// tol - tol is a weighting factor in the range [0, 1) which determines the tolerance of the matching. +// The default value is 100 * eps and the resulting tolerance for a given complex pair is tol * abs (z(i))). +// dim - By default the complex pairs are sorted along the first non-singleton dimension of z. If dim is specified, then the complex pairs are sorted along this dimension. +// Outputs +// zc - complex conjugate pair +// zr - real numbers +// Example: +// with 2 real zeros, one of them equal to 0 +// [zc, zr] = cplxreal (roots ([1, 0, 0, 1, 0])) + if (nargin < 1 || nargin > 3) error("invalid inputs"); end |