File: dsort.m

package info (click to toggle)
octave-control 4.1.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,924 kB
  • sloc: fortran: 122,524; cpp: 6,954; objc: 210; makefile: 40; xml: 33; sh: 3
file content (72 lines) | stat: -rw-r--r-- 2,078 bytes parent folder | download | duplicates (5)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
## Copyright (C) 2016  Mark Bronsfeld
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {@var{s} =} dsort(@var{p})
## @deftypefnx {Function File} {[@var{s}, @var{ndx}] =} dsort(@var{p})
## Sort discrete-time poles by magnitude (in decreasing order).
##
## @strong{Inputs}
## @table @var
## @item p
## Input vector containing discrete-time poles.
## @end table
##
## @strong{Outputs}
## @table @var
## @item s
## Vector with sorted poles.
## @item ndx
## Vector containing the indices used in the sort.
## @end table
##
## @seealso{eig, esort, pole, pzmap, sort, zero}
## @end deftypefn

## Author: Mark Bronsfeld <m.brnsfld@googlemail.com>
## Created: December 2016
## Version: 0.2

function [s, ndx] = dsort(p)
        if(nargin == 1)
                if(!isvector(p))
                error("dsort: argument must be a vector");
                endif
        else
                print_usage();
        endif

        [s, ndx] = sort(p, 'descend');
endfunction

%!shared s_exp, ndx_exp, s_obs, ndx_obs
%! p = [-0.2410+0.5573i;
%!      -0.2410-0.5573i;
%!      0.1503;
%!      -0.0972;
%!      -0.2590];
%! s_exp = [    -0.2410+0.5573i;
%!              -0.2410-0.5573i;
%!              -0.2590;
%!              0.1503;
%!              -0.0972];
%! ndx_exp = [  1;
%!              2;
%!              5;
%!              3;
%!              4];
%! [s_obs, ndx_obs] = dsort(p);
%!assert(s_obs, s_exp, 0);
%!assert(ndx_obs, ndx_exp, 0);