octave_packages/control-2.3.52/@tfpoly/tfpoly2str.m

   1 ## Copyright (C) 2009   Lukas F. Reichlin
   2 ##
   3 ## This file is part of LTI Syncope.
   4 ##
   5 ## LTI Syncope is free software: you can redistribute it and/or modify
   6 ## it under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation, either version 3 of the License, or
   8 ## (at your option) any later version.
   9 ##
  10 ## LTI Syncope is distributed in the hope that it will be useful,
  11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ## GNU General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 ## -*- texinfo -*-
  19 ## @deftypefn {Function File} {@var{str} =} tfpoly2str (@var{p})
  20 ## @deftypefnx {Function File} {@var{str} =} tfpoly2str (@var{p}, @var{tfvar})
  21 ## Return the string of a polynomial with string @var{tfvar} as variable.
  22 ## @end deftypefn
  23
  24 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  25 ## Created: September 2009
  26 ## Version: 0.1
  27
  28 function str = tfpoly2str (p, tfvar = "x")
  29
  30   str = "";
  31
  32   lp = numel (p.poly);
  33
  34   if (lp > 0)
  35     ## first element (highest order)
  36     a = p.poly(1);
  37
  38     if (a < 0)
  39       cs = "-";
  40     else
  41       cs = "";
  42     endif
  43
  44     if (lp == 1)
  45       str = [cs, num2str(abs (a), 4)];
  46     else
  47       if (abs (a) == 1)
  48         str = [cs, __variable__(tfvar, lp-1)];
  49       else
  50         str = [cs, __coefficient__(a), " ", __variable__(tfvar, lp-1)];
  51       endif
  52     endif
  53
  54     if (lp > 1)
  55       ## elements in the middle
  56       for k = 2 : lp-1
  57         a = p.poly(k);
  58
  59         if (a != 0)
  60           if (a < 0)
  61             cs = " - ";
  62           else
  63             cs = " + ";
  64           endif
  65
  66           if (abs (a) == 1)
  67             str = [str, cs, __variable__(tfvar, lp-k)];
  68           else
  69             str = [str, cs, __coefficient__(a), " ", __variable__(tfvar, lp-k)];
  70           endif
  71         endif
  72       endfor
  73
  74       ## last element (lowest order)
  75       a = p.poly(lp);
  76
  77       if (a != 0)
  78         if (a < 0)
  79           cs = " - ";
  80         else
  81           cs = " + ";
  82         endif
  83
  84         str = [str, cs, num2str(abs (a), 4)];
  85       endif
  86     endif
  87   endif
  88
  89 endfunction
  90
  91
  92 function str = __coefficient__ (a)
  93
  94   b = abs (a);
  95
  96   if (b == 1)
  97     str = "";
  98   else
  99     str = num2str (b, 4);
 100   endif
 101
 102 endfunction
 103
 104
 105 function str = __variable__ (tfvar, n)
 106
 107   if (n == 1)
 108     str = tfvar;
 109   else
 110     str = [tfvar, "^", num2str(n)];
 111   endif
 112
 113 endfunction