octave_packages/control-2.3.52/@lti/isstable.m

   1 ## Copyright (C) 2009, 2010   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{bool} =} isstable (@var{sys})
  20 ## @deftypefnx {Function File} {@var{bool} =} isstable (@var{sys}, @var{tol})
  21 ## Determine whether LTI system is stable.
  22 ##
  23 ## @strong{Inputs}
  24 ## @table @var
  25 ## @item sys
  26 ## LTI system.
  27 ## @item tol
  28 ## Optional tolerance for stability.  Default value is 0.
  29 ## @end table
  30 ##
  31 ## @strong{Outputs}
  32 ## @table @var
  33 ## @item bool = 0
  34 ## System is not stable.
  35 ## @item bool = 1
  36 ## System is stable.
  37 ## @end table
  38 ##
  39 ## @example
  40 ## @group
  41 ##   real (p) < -tol*(1 + abs (p))    continuous-time
  42 ##   abs (p) < 1 - tol                discrete-time
  43 ## @end group
  44 ## @end example
  45 ## @end deftypefn
  46
  47 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  48 ## Created: October 2009
  49 ## Version: 0.2
  50
  51 function bool = isstable (sys, tol = 0)
  52
  53   if (nargin > 2)
  54     print_usage ();
  55   endif
  56
  57   pol = pole (sys);
  58   ct = isct (sys);
  59
  60   bool = __is_stable__ (pol, ct, tol);
  61
  62 endfunction