summaryrefslogtreecommitdiff
path: root/macros/cplxreal.sci
blob: b06fac3ffc51c89e4e95a884f04cdfbad665674c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*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)
  if (nargin < 1 || nargin > 3)
    error("invalid inputs");
  end
  if (isempty (z))
    zc = zeros (size (z,1),size(z,2));
    zr = zeros (size (z,1),size(z,2));
    return;
  end
  if (nargin < 2 || isempty (tol))
    tol = 100 * %eps ;
  end
  if (nargin >= 3)
    zcp = cplxpair(z,tol,dim);
  else
    zcp = cplxpair (z , tol);
  end
  nz = max(size (z) );
  idx = nz;
  while ((idx > 0) && (zcp(idx) == 0 || (abs (imag (zcp(idx))) ./ abs (zcp(idx))) <= tol))
    zcp(idx) = real (zcp(idx));
    idx = idx - 1;
  end
  if (pmodulo (idx, 2) ~= 0)
    error ("cplxreal: odd number of complex values was returned from cplxpair");
  end
  zc = zcp(2:2:idx);
  zr = zcp(idx+1:nz);
endfunction