octave_packages/control-2.3.52/__modred_check_alpha__.m

   1 ## Copyright (C) 2011   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 ## check alpha for model reduction commands
  20
  21 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  22 ## Created: November 2011
  23 ## Version: 0.1
  24
  25 function alpha = __modred_check_alpha__ (alpha, dt)
  26
  27   if (! is_real_scalar (alpha))
  28     error ("modred: argument alpha must be a real scalar");
  29   endif
  30   if (dt)  # discrete-time
  31     if (alpha < 0 || alpha > 1)
  32       error ("modred: require 0 <= ALPHA <= 1");
  33     endif
  34   else     # continuous-time
  35     if (alpha > 0)
  36       error ("modred: require ALPHA <= 0");
  37     endif
  38   endif
  39
  40 endfunction