Home > freetb4matlab > control > sysdimensions.m

sysdimensions

PURPOSE ^

% return the number of states, inputs, and/or outputs in the system

SYNOPSIS ^

function [n, nz, m, p, yd] = sysdimensions (sys, opt)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {[@var{n}, @var{nz}, @var{m}, @var{p}, @var{yd}] =} sysdimensions (@var{sys}, @var{opt})
% return the number of states, inputs, and/or outputs in the system
% @var{sys}.
%
% @strong{Inputs}
% @table @var
% @item sys
% system data structure
%
% @item opt
% String indicating which dimensions are desired.  Values:
% @table @code
% @item 'all'
% (default) return all parameters as specified under Outputs below.
%
% @item 'cst'
% return @var{n}= number of continuous states
%
% @item 'dst'
% return @var{n}= number of discrete states
%
% @item 'in'
% return @var{n}= number of inputs
%
% @item 'out'
% return @var{n}= number of outputs
% @end table
% @end table
%
% @strong{Outputs}
% @table @var
% @item  n
%  number of continuous states (or individual requested dimension as specified
% by @var{opt}).
% @item  nz
%  number of discrete states
% @item  m
%  number of system inputs
% @item  p
%  number of system outputs
% @item  yd
%  binary vector; @var{yd}(@var{ii}) is nonzero if output @var{ii} is
% discrete.
% @math{yd(ii) = 0} if output @var{ii} is continuous
% @end table
% @seealso{sysgetsignals, sysgettsam}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003