home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21eb.zip / octave / SCRIPTS.ZIP / scripts.fat / control / sortcom.m < prev    next >
Text File  |  1999-04-29  |  3KB  |  80 lines
  1. # Copyright (C) 1996 A. Scottedward Hodel 
  2. #
  3. # This file is part of Octave. 
  4. #
  5. # Octave is free software; you can redistribute it and/or modify it 
  6. # under the terms of the GNU General Public License as published by the 
  7. # Free Software Foundation; either version 2, or (at your option) any 
  8. # later version. 
  9. # 
  10. # Octave is distributed in the hope that it will be useful, but WITHOUT 
  11. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
  12. # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
  13. # for more details.
  14. # 
  15. # You should have received a copy of the GNU General Public License 
  16. # along with Octave; see the file COPYING.  If not, write to the Free 
  17. # Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 
  18.  
  19. function [yy,idx] = sortcom(xx,opt)
  20. # [yy,idx] = sortcom(xx[,opt]): sort a complex vector
  21. # xx: complex vector
  22. # opt: sorting option:
  23. #    "re": real part (default)
  24. #    "mag": by magnitude
  25. #    "im": by imaginary part
  26. #
  27. #  if opt != "im" then values with common real part/magnitude are
  28. #     sorted by imaginary part, i.e. a - jb followed by a + jb. 
  29. #     [Complex conjugate pairs may not be grouped consecutively if more than 2
  30. #     numbers share a common real part/magnitude]
  31. # yy: sorted values
  32. # idx: permutation vector: yy = xx(idx)
  33.  
  34. # Written by A. S. Hodel June 1995
  35.  
  36.   if( nargin < 1 | nargin > 2 )
  37.      usage("yy = sortcom(xx[,opt]");
  38.   elseif( !(is_vec(xx) | isempty(xx) ))
  39.     error("sortcom: first argument must be a vector");
  40.   endif
  41.  
  42.   if(nargin == 1)         opt = "re";
  43.   else
  44.     if (!isstr(opt))
  45.       error("sortcom: second argument must be a string");
  46.     endif
  47.   endif
  48.  
  49.   if(isempty(xx))
  50.     yy = idx = [];
  51.   else
  52.     if(strcmp(opt,"re"))        datavec = real(xx);
  53.     elseif(strcmp(opt,"im"))    datavec = imag(xx);
  54.     elseif(strcmp(opt,"mag"))   datavec = abs(xx);
  55.     else                        error(["sortcom: illegal option = ", opt])
  56.     endif
  57.   
  58.     [datavec,idx] = sort(datavec);
  59.     yy= xx(idx);
  60.     
  61.     if(strcmp(opt,"re") | strcmp(opt,"mag"))
  62.       # sort so that complex conjugate pairs appear together
  63.       
  64.       ddiff = diff(datavec);
  65.       zidx = find(ddiff == 0);
  66.   
  67.       # sort common datavec values
  68.       if(!isempty(zidx))
  69.         for iv=crt_set(datavec(zidx))
  70.           vidx = find(datavec == iv);
  71.           [vals,imidx] = sort(imag(yy(vidx)));
  72.           yy(vidx)  = yy(vidx(imidx));
  73.           idx(vidx) = idx(vidx(imidx));
  74.         endfor
  75.       endif
  76.     endif
  77.   endif  
  78. endfunction
  79.   
  80.