Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / control-2.3.52 / impulse.m

diff --git a/octave_packages/control-2.3.52/impulse.m b/octave_packages/control-2.3.52/impulse.m
new file mode 100644 (file)
index 0000000..0e79080
--- /dev/null
+++ b/octave_packages/control-2.3.52/impulse.m
@@ -0,0 +1,75 @@
+## Copyright (C) 2009   Lukas F. Reichlin
+##
+## This file is part of LTI Syncope.
+##
+## LTI Syncope 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.
+##
+## LTI Syncope 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 LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys})
+## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys}, @var{t})
+## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys}, @var{tfinal})
+## @deftypefnx{Function File} {[@var{y}, @var{t}, @var{x}] =} impulse (@var{sys}, @var{tfinal}, @var{dt})
+## Impulse response of LTI system.
+## If no output arguments are given, the response is printed on the screen.
+##
+## @strong{Inputs}
+## @table @var
+## @item sys
+## LTI model.
+## @item t
+## Time vector.  Should be evenly spaced.  If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item tfinal
+## Optional simulation horizon.  If not specified, it is calculated by
+## the poles of the system to reflect adequately the response transients.
+## @item dt
+## Optional sampling time.  Be sure to choose it small enough to capture transient
+## phenomena.  If not specified, it is calculated by the poles of the system.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item y
+## Output response array.  Has as many rows as time samples (length of t)
+## and as many columns as outputs.
+## @item t
+## Time row vector.
+## @item x
+## State trajectories array.  Has @code{length (t)} rows and as many columns as states.
+## @end table
+##
+## @seealso{initial, lsim, step}
+## @end deftypefn
+
+## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
+## Created: October 2009
+## Version: 0.1
+
+function [y_r, t_r, x_r] = impulse (sys, tfinal = [], dt = [])
+
+  ## TODO: multiplot feature:   impulse (sys1, "b", sys2, "r", ...)
+
+  if (nargin == 0 || nargin > 3)
+    print_usage ();
+  endif
+
+  [y, t, x] = __time_response__ (sys, "impulse", ! nargout, tfinal, dt, [], inputname (1));
+
+  if (nargout)
+    y_r = y;
+    t_r = t;
+    x_r = x;
+  endif
+
+endfunction