Mercurial > hg > octave-max
changeset 3500:7923abdeb4e5
[project @ 2000-01-31 06:35:00 by jwe]
line wrap: on
line diff
--- a/scripts/control/base/__bodquist__.m +++ b/scripts/control/base/__bodquist__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{f}, @var{w}, @var{rsys} =} __bodquist__ (@var{sys}, @var{w}, @var{out_idx}, @var{in_idx}) +## @deftypefn {Function File} {[@var{f}, @var{w}, @var{rsys}] =} __bodquist__ (@var{sys}, @var{w}, @var{out_idx}, @var{in_idx}) ## used internally by bode, nyquist; compute system frequency response. ## ## @strong{Inputs}
--- a/scripts/control/base/__freqresp__.m +++ b/scripts/control/base/__freqresp__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{out} =} __freqresp__ (@var{sys}, @var{USEW}@{,@var{w}@}); +## @deftypefn {Function File} {} __freqresp__ (@var{sys}, @var{USEW}, @var{w}) ## Frequency response function - used internally by @code{bode}, @code{nyquist}. ## minimal argument checking; "do not attempt to do this at home" ##
--- a/scripts/control/base/__stepimp__.m +++ b/scripts/control/base/__stepimp__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{y}, @var{t}] = } __stepimp__ (@var{sitype}, @var{sys} [, @var{inp}, @var{tstop}, @var{n}]) +## @deftypefn {Function File} {[@var{y}, @var{t}] =} __stepimp__ (@var{sitype}, @var{sys} [, @var{inp}, @var{tstop}, @var{n}]) ## Impulse or step response for a linear system. ## The system can be discrete or multivariable (or both). ## This m-file contains the "common code" of step and impulse.
--- a/scripts/control/base/bddemo.m +++ b/scripts/control/base/bddemo.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} bddemo (@var{inputs}) +## @deftypefn {Function File} {} bddemo (@var{inputs}) ## Octave Controls toolbox demo: Block Diagram Manipulations demo ## @end deftypefn
--- a/scripts/control/base/bode.m +++ b/scripts/control/base/bode.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{mag}, @var{phase}, @var{w}] =} bode(@var{sys}@{,@var{w}, @var{out_idx}, @var{in_idx}@}) +## @deftypefn {Function File} {[@var{mag}, @var{phase}, @var{w}] =} bode(@var{sys}, @var{w}, @var{out_idx}, @var{in_idx}) ## If no output arguments are given: produce Bode plots of a system; otherwise, ## compute the frequency response of a system data structure ## @@ -38,7 +38,7 @@ ## @item @math{G(z)} is the system transfer function. ## @end itemize ## -## @strong{ Default} the default frequency range is selected as follows: (These +## @strong{Default} the default frequency range is selected as follows: (These ## steps are NOT performed if @var{w} is specified) ## @enumerate ## @item via routine __bodquist__, isolate all poles and zeros away from
--- a/scripts/control/base/bode_bounds.m +++ b/scripts/control/base/bode_bounds.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{wmin}, @var{wmax}] =} bode_bounds (@var{zer}, @var{pol}, @var{dflg}@{, @var{tsam} @}) +## @deftypefn {Function File} {[@var{wmin}, @var{wmax}] =} bode_bounds (@var{zer}, @var{pol}, @var{dflg}, @var{tsam}) ## Get default range of frequencies based on cutoff frequencies of system ## poles and zeros. ## Frequency range is the interval [10^wmin,10^wmax]
--- a/scripts/control/base/ctrb.m +++ b/scripts/control/base/ctrb.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{Qs} =} ctrb(@var{sys} @{, @var{b}@}) -## @deftypefnx {Function File} {@var{Qs} =} ctrb(@var{A}, @var{B}) +## @deftypefn {Function File} {} ctrb(@var{sys}, @var{b}) +## @deftypefnx {Function File} {} ctrb(@var{A}, @var{B}) ## Build controllability matrix ## @example ## 2 n-1
--- a/scripts/control/base/damp.m +++ b/scripts/control/base/damp.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} damp(@var{p}@{, @var{tsam}@}) +## @deftypefn {Function File} {} damp(@var{p}, @var{tsam}) ## Displays eigenvalues, natural frequencies and damping ratios ## of the eigenvalues of a matrix @var{p} or the @var{A}-matrix of a ## system @var{p}, respectively.
--- a/scripts/control/base/dcgain.m +++ b/scripts/control/base/dcgain.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{gm} =} dcgain (@var{sys}@{, tol@}) +## @deftypefn {Function File} {} dcgain (@var{sys}, tol) ## Returns dc-gain matrix. If dc-gain is infinite ## an empty matrix is returned. ## The argument @var{tol} is an optional tolerance for the condition
--- a/scripts/control/base/dgram.m +++ b/scripts/control/base/dgram.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{m} =} dgram (@var{a}, @var{b}) +## @deftypefn {Function File} {} dgram (@var{a}, @var{b}) ## Return controllability grammian of discrete time system ## @example ## x(k+1) = a x(k) + b u(k)
--- a/scripts/control/base/dlyap.m +++ b/scripts/control/base/dlyap.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} dlyap (@var{a}, @var{b}) +## @deftypefn {Function File} {} dlyap (@var{a}, @var{b}) ## Solve the discrete-time Lyapunov equation ## ## @strong{Inputs}
--- a/scripts/control/base/dre.m +++ b/scripts/control/base/dre.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{tvals},@var{Plist}] =} dre (@var{sys},@var{Q},@var{R},@var{Qf},@var{t0},@var{tf}[,@var{Ptol},@var{maxits}]); +## @deftypefn {Function File} {[@var{tvals}, @var{Plist}] =} dre (@var{sys}, @var{Q}, @var{R}, @var{Qf}, @var{t0}, @var{tf}[, @var{Ptol}, @var{maxits}]); ## Solve the differential Riccati equation ## @ifinfo ## @example @@ -77,7 +77,7 @@ ## @item tvals ## time values at which @var{P}(@var{t}) is computed ## @item Plist -## list values of @var{P}(@var{t}); nth(@var{Plist},@var{ii}) +## list values of @var{P}(@var{t}); nth (@var{Plist}, @var{ii}) ## is @var{P}(@var{tvals}(@var{ii})). ## ## @item tvals
--- a/scripts/control/base/freqchkw.m +++ b/scripts/control/base/freqchkw.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} freqchkw (@var{w}) +## @deftypefn {Function File} {} freqchkw (@var{w}) ## Used by @code{__freqresp__} to check that input frequency vector @var{w} ## is valid. ## Returns boolean value.
--- a/scripts/control/base/gram.m +++ b/scripts/control/base/gram.m @@ -17,11 +17,11 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{m} =} gram (@var{a}, @var{b}) +## @deftypefn {Function File} {} gram (@var{a}, @var{b}) ## Return controllability grammian @var{m} of the continuous time system -## @math{ dx/dt = a x + b u}. +## @math{dx/dt = a x + b u}. ## -## @var{m} satisfies @math{ a m + m a' + b b' = 0 }. +## @var{m} satisfies @math{a m + m a' + b b' = 0}. ## @end deftypefn ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/control/base/impulse.m +++ b/scripts/control/base/impulse.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{y}, @var{t}] =} impulse (@var{sys}@{, @var{inp},@var{tstop}, @var{n}@}) +## @deftypefn {Function File} {[@var{y}, @var{t}] =} impulse (@var{sys}, @var{inp}, @var{tstop}, @var{n}) ## Impulse response for a linear system. ## The system can be discrete or multivariable (or both). ## If no output arguments are specified, @code{impulse}
--- a/scripts/control/base/lsim.m +++ b/scripts/control/base/lsim.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} lsim (@var{sys}, @var{u}, @var{t}@{,@var{x0}@}) +## @deftypefn {Function File} {} lsim (@var{sys}, @var{u}, @var{t}, @var{x0}) ## Produce output for a linear simulation of a system ## ## Produces a plot for the output of the system, sys.
--- a/scripts/control/base/ltifr.m +++ b/scripts/control/base/ltifr.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{out} =} ltifr (@var{A}, @var{B}, @var{w}) -## @deftypefnx {Function File} {@var{out} =} ltifr (@var{sys}, @var{w}) +## @deftypefn {Function File} {} ltifr (@var{A}, @var{B}, @var{w}) +## @deftypefnx {Function File} {} ltifr (@var{sys}, @var{w}) ## Linear time invariant frequency response of single input systems ## @strong{Inputs} ## @table @var
--- a/scripts/control/base/nyquist.m +++ b/scripts/control/base/nyquist.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{realp}, @var{imagp}, @var{w}] =} nyquist (@var{sys}@{, @var{w}, @var{out_idx}, @var{in_idx}, @var{atol}@}) -## @deftypefnx {Function File } {} nyquist (@var{sys}@{, @var{w}, @var{out_idx}, @var{in_idx}, @var{atol}@}) +## @deftypefn {Function File} {[@var{realp}, @var{imagp}, @var{w}] =} nyquist (@var{sys}, @var{w}, @var{out_idx}, @var{in_idx}, @var{atol}) +## @deftypefnx {Function File} {} nyquist (@var{sys}, @var{w}, @var{out_idx}, @var{in_idx}, @var{atol}) ## Produce Nyquist plots of a system; if no output arguments are given, Nyquist ## plot is printed to the screen. ##
--- a/scripts/control/base/obsv.m +++ b/scripts/control/base/obsv.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -##@deftypefn {Function File} {@var{Qb} =} obsv (@var{sys}@{, @var{c}@}) +##@deftypefn {Function File} {} obsv (@var{sys}, @var{c}) ## Build observability matrix ## @example ## @group
--- a/scripts/control/base/place.m +++ b/scripts/control/base/place.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{K} =} place (@var{sys}, @var{P}) +## @deftypefn {Function File} {} place (@var{sys}, @var{P}) ## Computes the matrix K such that if the state ## is feedback with gain K, then the eigenvalues of the closed loop ## system (i.e. A-BK) are those specified in the vector P.
--- a/scripts/control/base/rldemo.m +++ b/scripts/control/base/rldemo.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -##@deftypefn {Function File} {@var{outputs} =} rldemo (@var{inputs}) +##@deftypefn {Function File} {} rldemo (@var{inputs}) ##Octave Controls toolbox demo: Root Locus demo ##@end deftypefn
--- a/scripts/control/base/rlocus.m +++ b/scripts/control/base/rlocus.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} rlocus (@var{inputs}) +## @deftypefn {Function File} {} rlocus (@var{inputs}) ## @format ## [rldata, k] = rlocus(sys[,increment,min_k,max_k]) ## Displays root locus plot of the specified SISO system.
--- a/scripts/control/base/step.m +++ b/scripts/control/base/step.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{y}, @var{t}] =} step (@var{sys}@{, @var{inp},@var{tstop}, @var{n}@}) +## @deftypefn {Function File} {[@var{y}, @var{t}] =} step (@var{sys}, @var{inp}, @var{tstop}, @var{n}) ## Step response for a linear system. ## The system can be discrete or multivariable (or both). ## If no output arguments are specified, @code{step}
--- a/scripts/control/base/tzero.m +++ b/scripts/control/base/tzero.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} tzero (@var{a}, @var{b}, @var{c}, @var{d}@{, @var{opt}@}) -## @deftypefnx {Function File} {} tzero (@var{sys}@{,@var{opt}@}) +## @deftypefn {Function File} {} tzero (@var{a}, @var{b}, @var{c}, @var{d}, @var{opt}) +## @deftypefnx {Function File} {} tzero (@var{sys}, @var{opt}) ## Compute transmission zeros of a continuous ## @example ## .
--- a/scripts/control/base/tzero2.m +++ b/scripts/control/base/tzero2.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{zr} =} tzero2 (@var{a}, @var{b}, @var{c}, @var{d}, @var{bal}) +## @deftypefn {Function File} {} tzero2 (@var{a}, @var{b}, @var{c}, @var{d}, @var{bal}) ## Compute the transmission zeros of a, b, c, d. ## ## bal = balancing option (see balance); default is "B".
--- a/scripts/control/hinf/h2norm.m +++ b/scripts/control/hinf/h2norm.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function Fil} {@var{retval} =} h2norm(@var{sys}) +## @deftypefn {Function Fil} {} h2norm(@var{sys}) ## Computes the H2 norm of a system data structure (continuous time only) ## ## Reference:
--- a/scripts/control/hinf/hinf_ctr.m +++ b/scripts/control/hinf/hinf_ctr.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } {@var{K} =} hinf_ctr(@var{dgs}, @var{F}, @var{H}, @var{Z}, @var{g}) +## @deftypefn {Function File} {} hinf_ctr(@var{dgs}, @var{F}, @var{H}, @var{Z}, @var{g}) ## Called by @code{hinfsyn} to compute the H_inf optimal controller. ## ## @strong{Inputs}
--- a/scripts/control/hinf/hinfnorm.m +++ b/scripts/control/hinf/hinfnorm.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{g}, @var{gmin}, @var{gmax}] =} hinfnorm(@var{sys}@{, @var{tol}, @var{gmin}, @var{gmax}, @var{ptol}@}) +## @deftypefn {Function File} {[@var{g}, @var{gmin}, @var{gmax}] =} hinfnorm(@var{sys}, @var{tol}, @var{gmin}, @var{gmax}, @var{ptol}) ## Computes the H infinity norm of a system data structure. ## ## @strong{Inputs}
--- a/scripts/control/hinf/hinfsyn.m +++ b/scripts/control/hinf/hinfsyn.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{K}, @var{g}, @var{GW}, @var{Xinf}, @var{Yinf}] =} hinfsyn(@var{Asys}, @var{nu}, @var{ny}, @var{gmin}, @var{gmax}, @var{gtol}@{, @var{ptol}, @var{tol}@}) +## @deftypefn {Function File} {[@var{K}, @var{g}, @var{GW}, @var{Xinf}, @var{Yinf}] =} hinfsyn(@var{Asys}, @var{nu}, @var{ny}, @var{gmin}, @var{gmax}, @var{gtol}, @var{ptol}, @var{tol}) ## ## @strong{Inputs} input system is passed as either ## @table @var
--- a/scripts/control/hinf/hinfsyn_ric.m +++ b/scripts/control/hinf/hinfsyn_ric.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{Xinf},@var{x_ha_err}] =} hinfsyn_ric(@var{A},@var{BB}.@var{C1},@var{d1dot},@var{R},@var{ptol}) +## @deftypefn {Function File} {[@var{Xinf}, @var{x_ha_err}] =} hinfsyn_ric (@var{A}, @var{BB}, @var{C1}, @var{d1dot}, @var{R}, @var{ptol}) ## Forms ## @example ## xx = ([BB; -C1'*d1dot]/R) * [d1dot'*C1 BB'];
--- a/scripts/control/hinf/is_dgkf.m +++ b/scripts/control/hinf/is_dgkf.m @@ -60,13 +60,13 @@ ## @item Bu ## (@var{n} x @var{nu}) @var{Ru}-transformed controlled input matrix; ## -## @strong{Note} @math{B = [Bw Bu] } +## @strong{Note} @math{B = [Bw Bu]} ## @item Cz ## (@var{nz} x @var{n}) Qz-transformed error output matrix ## @item Cy ## (@var{ny} x @var{n}) @var{Ry}-transformed measured output matrix ## -## @strong{Note} @math{C = [Cz; Cy] } +## @strong{Note} @math{C = [Cz; Cy]} ## @item Dzu ## @item Dyw ## off-diagonal blocks of transformed @var{D} matrix that enter
--- a/scripts/control/hinf/wgt1o.m +++ b/scripts/control/hinf/wgt1o.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{wsys} =} wgt1o (@var{vl}, @var{vh}, @var{fc}) +## @deftypefn {Function File} {} wgt1o (@var{vl}, @var{vh}, @var{fc}) ## State space description of a first order weighting function. ## ## Weighting function are needed by the H2/H_infinity design procedure.
--- a/scripts/control/obsolete/dezero.m +++ b/scripts/control/obsolete/dezero.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Functin File} {@var{t} =} dezero (@var{s}) +## @deftypefn {Functin File} {} dezero (@var{s}) ## Remove trailing blank entries and all zero entries from the string s. ## @end deftypefn
--- a/scripts/control/obsolete/qzval.m +++ b/scripts/control/obsolete/qzval.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } { @var{x} =} qzval (@var{A}, @var{B}) +## @deftypefn {Function File} {} qzval (@var{A}, @var{B}) ## Compute generalized eigenvalues of the matrix pencil ## @ifinfo ## @example
--- a/scripts/control/obsolete/swapcols.m +++ b/scripts/control/obsolete/swapcols.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } { outputs =} swapcols ( inputs ) +## @deftypefn {Function File} {} swapcols (inputs) ## @format ## function B = swapcols(A) ## permute columns of A into reverse order
--- a/scripts/control/obsolete/swaprows.m +++ b/scripts/control/obsolete/swaprows.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } { outputs =} swaprows ( inputs ) +## @deftypefn {Function File} {} swaprows (inputs) ## @format ## function B = swaprows(A) ## permute rows of A into reverse order
--- a/scripts/control/obsolete/syschnames.m +++ b/scripts/control/obsolete/syschnames.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } {@var{retsys} =} syschnames (@var{sys}, @var{opt}, @var{list}, @var{names}) +## @deftypefn {Function File} {} syschnames (@var{sys}, @var{opt}, @var{list}, @var{names}) ## Superseded by @code{syssetsignals} ## @end deftypefn
--- a/scripts/control/system/__syschnamesl__.m +++ b/scripts/control/system/__syschnamesl__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{old_names} =} __syschnamesl__ (@var{olist}, @var{old_names}, @var{inames}, @var{listname}) +## @deftypefn {Function File} {} __syschnamesl__ (@var{olist}, @var{old_names}, @var{inames}, @var{listname}) ## used internally in syschnames ## item olist: index list ## old_names: original list names
--- a/scripts/control/system/__syscont_disc__.m +++ b/scripts/control/system/__syscont_disc__.m @@ -21,7 +21,7 @@ ## Used internally in syscont and sysdisc. ## ## @strong{Inputs} -## @var{ sys} is a system data structure. +## @var{sys} is a system data structure. ## ## @strong{Outputs} ## @table @var
--- a/scripts/control/system/__sysdefioname__.m +++ b/scripts/control/system/__sysdefioname__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{ioname} =} __sysdefioname__ (@var{n},@var{str} @{,@var{m}@}) +## @deftypefn {Function File} {} __sysdefioname__ (@var{n}, @var{str}, @var{m}) ## return default input or output names given @var{n}, @var{str}, @var{m}. ## @var{n} is the final value, @var{str} is the string prefix, and @var{m} ## is start value
--- a/scripts/control/system/__sysdefstname__.m +++ b/scripts/control/system/__sysdefstname__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{stname} =} __sysdefstname__ (@var{n}, @var{nz}) +## @deftypefn {Function File} {} __sysdefstname__ (@var{n}, @var{nz}) ## return default state names given @var{n}, @var{nz} ## ## used internally, minimal argument checking
--- a/scripts/control/system/__sysgroupn__.m +++ b/scripts/control/system/__sysgroupn__.m @@ -17,8 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{names} =} __sysgroupn__ (@var{names}) -## names = __sysgroupn__(names) +## @deftypefn {Function File} {} __sysgroupn__ (@var{names}) ## Locate and mark duplicate names ## inputs: ## names: list of signal names
--- a/scripts/control/system/__tf2sysl__.m +++ b/scripts/control/system/__tf2sysl__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{vec} =} __tf2sysl__ (@var{vec}) +## @deftypefn {Function File} {} __tf2sysl__ (@var{vec}) ## used internally in tf2sys. ## strip leading zero coefficients to get the true polynomial length ## @end deftypefn
--- a/scripts/control/system/buildssic.m +++ b/scripts/control/system/buildssic.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} buildssic(@var{Clst}, @var{Ulst}, @var{Olst}, @var{Ilst}, @var{s1}, @var{s2}, @var{s3}, @var{s4}, @var{s5}, @var{s6}, @var{s7}, @var{s8}) +## @deftypefn {Function File} {} buildssic(@var{Clst}, @var{Ulst}, @var{Olst}, @var{Ilst}, @var{s1}, @var{s2}, @var{s3}, @var{s4}, @var{s5}, @var{s6}, @var{s7}, @var{s8}) ## ## Form an arbitrary complex (open or closed loop) system in ## state-space form from several systems. "@code{buildssic}" can
--- a/scripts/control/system/c2d.m +++ b/scripts/control/system/c2d.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{dsys} =} c2d (@var{sys}@{, @var{opt}, @var{T}@}) -## @deftypefnx {Function File} {@var{dsys} =} c2d (@var{sys}@{, @var{T}@}) +## @deftypefn {Function File} {} c2d (@var{sys}, @var{opt}, @var{T}) +## @deftypefnx {Function File} {} c2d (@var{sys}, @var{T}) ## ## @strong{Inputs} ## @table @var
--- a/scripts/control/system/d2c.m +++ b/scripts/control/system/d2c.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{csys} =} d2c (@var{sys}@{,@var{tol}@}) -## @deftypefnx {Function File} {@var{csys} =} d2c (@var{sys}, @var{opt}) +## @deftypefn {Function File} {} d2c (@var{sys}, @var{tol}) +## @deftypefnx {Function File} {} d2c (@var{sys}, @var{opt}) ## Convert discrete (sub)system to a purely continuous system. Sampling ## time used is @code{sysgettsam(@var{sys})} ## @@ -38,9 +38,9 @@ ## followed by a steepest descent algorithm to identify continuous time ## @var{A}, @var{B}, to get a better fit to the original data. ## -## If called as @code{d2c}(@var{sys},@var{tol}), @var{tol=}positive scalar, -## the @code{"log"} option is used. The default value for @var{tol} is -## @code{1e-8}. +## If called as @code{d2c (@var{sys}, @var{tol})}, with @var{tol} +## positive scalar, the @code{"log"} option is used. The default value +## for @var{tol} is @code{1e-8}. ## @item "bi" ## Conversion is performed via bilinear transform ## @math{z = (1 + s T / 2)/(1 - s T / 2)} where @var{T} is the
--- a/scripts/control/system/dmr2d.m +++ b/scripts/control/system/dmr2d.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{dsys}, @var{fidx}] =} dmr2d (@var{sys}, @var{idx}, @var{sprefix}, @var{Ts2} @{,@var{cuflg}@}) +## @deftypefn {Function File} {[@var{dsys}, @var{fidx}] =} dmr2d (@var{sys}, @var{idx}, @var{sprefix}, @var{Ts2}, @var{cuflg}) ## convert a multirate digital system to a single rate digital system ## states specified by @var{idx}, @var{sprefix} are sampled at @var{Ts2}, all ## others are assumed sampled at @var{Ts1} = @code{sysgettsam(@var{sys})}.
--- a/scripts/control/system/fir2sys.m +++ b/scripts/control/system/fir2sys.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} fir2sys (@var{num}@{, @var{tsam}, @var{inname}, @var{outname} @}) +## @deftypefn {Function File} {} fir2sys (@var{num}, @var{tsam}, @var{inname}, @var{outname}) ## construct a system data structure from FIR description ## ## @strong{Inputs:}
--- a/scripts/control/system/is_abcd.m +++ b/scripts/control/system/is_abcd.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} is_abcd (@var{a}@{, @var{b}, @var{c}, @var{d}@}) +## @deftypefn {Function File} {} is_abcd (@var{a}, @var{b}, @var{c}, @var{d}) ## Returns @var{retval} = 1 if the dimensions of @var{a}, @var{b}, ## @var{c}, @var{d} are compatible, otherwise @var{retval} = 0 with an ## appropriate diagnostic message printed to the screen. The matrices
--- a/scripts/control/system/is_controllable.m +++ b/scripts/control/system/is_controllable.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_controllable (@var{sys}@{, @var{tol}@}) -## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_controllable (@var{a}@{, @var{b}, @var{tol}@}) +## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_controllable (@var{sys}, @var{tol}) +## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_controllable (@var{a}, @var{b}, @var{tol}) ## Logical check for system controllability. ## ## @strong{Inputs}
--- a/scripts/control/system/is_detectable.m +++ b/scripts/control/system/is_detectable.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_detectable (@var{a}, @var{c}@{, @var{tol}@}) -## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_detectable (@var{sys}@{, @var{tol}@}) +## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_detectable (@var{a}, @var{c}, @var{tol}) +## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_detectable (@var{sys}, @var{tol}) ## Test for detactability (observability of unstable modes) of ## (@var{a},@var{c}). ##
--- a/scripts/control/system/is_digital.m +++ b/scripts/control/system/is_digital.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} is_digital (@var{sys}) +## @deftypefn {Function File} {} is_digital (@var{sys}) ## Return nonzero if system is digital; ## inputs: ## sys: system data structure
--- a/scripts/control/system/is_observable.m +++ b/scripts/control/system/is_observable.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval},@var{U}] =} is_observable (@var{a}, @var{c}@{,@var{tol}@}) -## @deftypefnx {Function File} {[@var{retval},@var{U}] =} is_observable (@var{sys}@{, @var{tol}@}) +## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_observable (@var{a}, @var{c}, @var{tol}) +## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_observable (@var{sys}, @var{tol}) ## Logical check for system observability. ## ## Default: tol = 10*norm(a,'fro')*eps
--- a/scripts/control/system/is_sample.m +++ b/scripts/control/system/is_sample.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} is_sample (@var{Ts}) +## @deftypefn {Function File} {} is_sample (@var{Ts}) ## return true if @var{Ts} is a valid sampling time ## (real,scalar, > 0) ## @end deftypefn
--- a/scripts/control/system/is_siso.m +++ b/scripts/control/system/is_siso.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} is_siso (@var{sys}) +## @deftypefn {Function File} {} is_siso (@var{sys}) ## return nonzero if the system data structure ## @var{sys} is single-input, single-output. ## @end deftypefn
--- a/scripts/control/system/is_stabilizable.m +++ b/scripts/control/system/is_stabilizable.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_stabilizable (@var{sys}@{, @var{tol}@}) -## @deftypefnx {Function File } {[@var{retval}, @var{U}] =} is_stabilizable (@var{a}@{, @var{b} ,@var{tol}@}) +## @deftypefn {Function File} {[@var{retval}, @var{U}] =} is_stabilizable (@var{sys}, @var{tol}) +## @deftypefnx {Function File} {[@var{retval}, @var{U}] =} is_stabilizable (@var{a}, @var{b}, @var{tol}) ## Logical check for system stabilizability (i.e., all unstable modes are controllable). ## ## Test for stabilizability is performed via an ordered Schur decomposition
--- a/scripts/control/system/is_stable.m +++ b/scripts/control/system/is_stable.m @@ -17,9 +17,9 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} is_stable (@var{a}@{,@var{tol},@var{dflg}@}) -## @deftypefnx {Function File} {@var{retval} =} is_stable (@var{sys}@{,@var{tol}@}) -## Returns retval = 1 if the matrix @var{a} or the system @var{sys} +## @deftypefn {Function File} {} is_stable (@var{a}, @var{tol}, @var{dflg}) +## @deftypefnx {Function File} {} is_stable (@var{sys}, @var{tol}) +## Returns 1 if the matrix @var{a} or the system @var{sys} ## is stable, or 0 if not. ## ## @strong{Inputs}
--- a/scripts/control/system/jet707.m +++ b/scripts/control/system/jet707.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outsys} =} jet707 () +## @deftypefn {Function File} {} jet707 () ## Creates linearized state space model of a Boeing 707-321 aircraft ## at v=80m/s. (M = 0.26, Ga0 = -3 deg, alpha0 = 4 deg, kappa = 50 deg) ## System inputs: (1) thrust and (2) elevator angle
--- a/scripts/control/system/moddemo.m +++ b/scripts/control/system/moddemo.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} moddemo (@var{inputs}) +## @deftypefn {Function File} {} moddemo (@var{inputs}) ## Octave Controls toolbox demo: Model Manipulations demo ## @end deftypefn
--- a/scripts/control/system/ord2.m +++ b/scripts/control/system/ord2.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outsys} =} ord2 (@var{nfreq}, @var{damp}@{[, @var{gain}@}) +## @deftypefn {Function File} {} ord2 (@var{nfreq}, @var{damp}, @var{gain}) ## Creates a continuous 2nd order system with parameters: ## @strong{Inputs} ## @table @var
--- a/scripts/control/system/parallel.m +++ b/scripts/control/system/parallel.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sysp} =} parallel (@var{Asys}, @var{Bsys}) +## @deftypefn {Function File} {} parallel (@var{Asys}, @var{Bsys}) ## Forms the parallel connection of two systems. ## ## ____________________
--- a/scripts/control/system/ss2sys.m +++ b/scripts/control/system/ss2sys.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} ss2sys (@var{a}, @var{b}, @var{c}@{,@var{d}, @var{tsam}, @var{n}, @var{nz}, @var{stname}, @var{inname}, @var{outname}, @var{outlist}@}) +## @deftypefn {Function File} {} ss2sys (@var{a}, @var{b}, @var{c}, @var{d}, @var{tsam}, @var{n}, @var{nz}, @var{stname}, @var{inname}, @var{outname}, @var{outlist}) ## Create system structure from state-space data. May be continous, ## discrete, or mixed (sampeled-data) ## @@ -97,13 +97,13 @@ ## @end example ## with dynamic equations: ## @ifinfo -## @math{ d/dt xc(t) = acc*xc(t) + acd*xd(k*tsam) + bc*u(t)} +## @math{d/dt xc(t) = acc*xc(t) + acd*xd(k*tsam) + bc*u(t)} ## -## @math{ xd((k+1)*tsam) = adc*xc(k*tsam) + add*xd(k*tsam) + bd*u(k*tsam)} +## @math{xd((k+1)*tsam) = adc*xc(k*tsam) + add*xd(k*tsam) + bd*u(k*tsam)} ## -## @math{ yc(t) = ccc*xc(t) + ccd*xd(k*tsam) + dc*u(t)} +## @math{yc(t) = ccc*xc(t) + ccd*xd(k*tsam) + dc*u(t)} ## -## @math{ yd(k*tsam) = cdc*xc(k*tsam) + cdd*xd(k*tsam) + dd*u(k*tsam)} +## @math{yd(k*tsam) = cdc*xc(k*tsam) + cdd*xd(k*tsam) + dd*u(k*tsam)} ## @end ifinfo ## @iftex ## @tex
--- a/scripts/control/system/ss2tf.m +++ b/scripts/control/system/ss2tf.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} ss2tf (@var{inputs}) +## @deftypefn {Function File} {} ss2tf (@var{inputs}) ## @format ## [num,den] = ss2tf(a,b,c,d) ## Conversion from tranfer function to state-space.
--- a/scripts/control/system/ss2zp.m +++ b/scripts/control/system/ss2zp.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} ss2zp (@var{inputs}) +## @deftypefn {Function File} {} ss2zp (@var{inputs}) ## @format ## Converts a state space representation to a set of poles and zeros. ##
--- a/scripts/control/system/starp.m +++ b/scripts/control/system/starp.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} starp (@var{inputs}) +## @deftypefn {Function File} {} starp (@var{inputs}) ## @format ## ## sys = starp(P, K, ny, nu)
--- a/scripts/control/system/sys2ss.m +++ b/scripts/control/system/sys2ss.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{a}, @var{b}, @var{c}, @var{d}, @var{tsam},@var{n}, @var{nz}, @var{stname}, @var{inname}, @var{outname}, @var{yd}] =} sys2ss (@var{sys}) +## @deftypefn {Function File} {[@var{a}, @var{b}, @var{c}, @var{d}, @var{tsam}, @var{n}, @var{nz}, @var{stname}, @var{inname}, @var{outname}, @var{yd}] =} sys2ss (@var{sys}) ## Extract state space representation from system data structure. ## ## @strong{Inputs}
--- a/scripts/control/system/sysadd.m +++ b/scripts/control/system/sysadd.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} sysadd (@var{Gsys}, @var{Hsys}) +## @deftypefn {Function File} {} sysadd (@var{Gsys}, @var{Hsys}) ## returns @var{sys} = @var{Gsys} + @var{Hsys}. ## @itemize @bullet ## @item Exits with
--- a/scripts/control/system/sysappend.m +++ b/scripts/control/system/sysappend.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} sysappend (@var{sys}, @var{b}@{, @var{c}, @var{d}, @var{outname}, @var{inname}, @var{yd}@}) +## @deftypefn {Function File} {} sysappend (@var{sys}, @var{b}, @var{c}, @var{d}, @var{outname}, @var{inname}, @var{yd}) ## appends new inputs and/or outputs to a system ## ## @strong{Inputs}
--- a/scripts/control/system/syschtsam.m +++ b/scripts/control/system/syschtsam.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} syschtsam (@var{sys}, @var{tsam}) +## @deftypefn {Function File} {} syschtsam (@var{sys}, @var{tsam}) ## This function changes the sampling time (tsam) of the system. Exits with ## an error if sys is purely continuous time. ## @end deftypefn
--- a/scripts/control/system/sysconnect.m +++ b/scripts/control/system/sysconnect.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} sysconnect (@var{sys}, @var{out_idx},@var{in_idx}@{,@var{order}, @var{tol}@}) +## @deftypefn {Function File} {} sysconnect (@var{sys}, @var{out_idx}, @var{in_idx}, @var{order}, @var{tol}) ## Close the loop from specified outputs to respective specified inputs ## ## @strong{Inputs}
--- a/scripts/control/system/sysdimensions.m +++ b/scripts/control/system/sysdimensions.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{n}, @var{nz}, @var{m}, @var{p}, @var{yd}] =} sysdimensions (@var{sys}@{, @var{opt}@}) +## @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}. ##
--- a/scripts/control/system/sysdup.m +++ b/scripts/control/system/sysdup.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} sysdup (@var{Asys}, @var{out_idx}, @var{in_idx}) +## @deftypefn {Function File} {} sysdup (@var{Asys}, @var{out_idx}, @var{in_idx}) ## Duplicate specified input/output connections of a system ## ## @strong{Inputs}
--- a/scripts/control/system/sysgetsignals.m +++ b/scripts/control/system/sysgetsignals.m @@ -18,8 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{stname}, @var{inname}, @var{outname}, @var{yd}] =} sysgetsignals (@var{sys}) -## @deftypefnx{Function File} {@var{siglist} =} sysgetsignals (@var{sys},@var{sigid}) -## @deftypefnx{Function File} {@var{signame} =} sysgetsignals (@var{sys},@var{sigid},@var{signum}@{, @var{strflg}@}) +## @deftypefnx{Function File} {@var{siglist} =} sysgetsignals (@var{sys}, @var{sigid}) +## @deftypefnx{Function File} {@var{signame} =} sysgetsignals (@var{sys}, @var{sigid}, @var{signum}, @var{strflg}) ## Get signal names from a system ## ## @strong{Inputs}
--- a/scripts/control/system/sysgettype.m +++ b/scripts/control/system/sysgettype.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{systype} =} sysgettype (@var{sys}) +## @deftypefn {Function File} {} sysgettype (@var{sys}) ## return the initial system type of the system ## ## @strong{Inputs}
--- a/scripts/control/system/sysgroup.m +++ b/scripts/control/system/sysgroup.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} sysgroup (@var{Asys}, @var{Bsys}) +## @deftypefn {Function File} {} sysgroup (@var{Asys}, @var{Bsys}) ## Combines two systems into a single system ## ## @strong{Inputs}
--- a/scripts/control/system/sysmult.m +++ b/scripts/control/system/sysmult.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} sysmult (@var{Asys}, @var{Bsys}) +## @deftypefn {Function File} {} sysmult (@var{Asys}, @var{Bsys}) ## Compute @math{sys = Asys*Bsys} (series connection): ## @example ## @group
--- a/scripts/control/system/sysout.m +++ b/scripts/control/system/sysout.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} sysout (@var{sys}@{, @var{opt}@}) +## @deftypefn {Function File} {} sysout (@var{sys}, @var{opt}) ## print out a system data structure in desired format ## @table @var ## @item sys
--- a/scripts/control/system/sysprune.m +++ b/scripts/control/system/sysprune.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} sysprune (@var{Asys}, @var{out_idx}, @var{in_idx}) +## @deftypefn {Function File} {} sysprune (@var{Asys}, @var{out_idx}, @var{in_idx}) ## Extract specified inputs/outputs from a system ## ## @strong{Inputs}
--- a/scripts/control/system/sysreorder.m +++ b/scripts/control/system/sysreorder.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{pv} =} sysreorder (@var{vlen}, @{var{list}) +## @deftypefn {Function File} {} sysreorder (@var{vlen}, @var{list}) ## ## @strong{Inputs} ## @var{vlen}=vector length, @var{list}= a subset of @code{[1:vlen]},
--- a/scripts/control/system/sysscale.m +++ b/scripts/control/system/sysscale.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} sysscale (@var{sys}, @var{outscale}, @var{inscale}@{, @var{outname}, @var{inname}@}) +## @deftypefn {Function File} {} sysscale (@var{sys}, @var{outscale}, @var{inscale}, @var{outname}, @var{inname}) ## scale inputs/outputs of a system. ## ## @strong{Inputs}
--- a/scripts/control/system/syssetsignals.m +++ b/scripts/control/system/syssetsignals.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} syssetsignals (@var{sys}, @var{opt}, @var{names}@{, @var{sig_idx}@}) +## @deftypefn {Function File} {} syssetsignals (@var{sys}, @var{opt}, @var{names}, @var{sig_idx}) ## change the names of selected inputs, outputs and states. ## @strong{Inputs} ## @table @var
--- a/scripts/control/system/syssub.m +++ b/scripts/control/system/syssub.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} syssub (@var{Gsys}, @var{Hsys}) +## @deftypefn {Function File} {} syssub (@var{Gsys}, @var{Hsys}) ## returns @math{sys = Gsys - Hsys} ## ## Method: @var{Gsys} and @var{Hsys} are connected in parallel
--- a/scripts/control/system/sysupdate.m +++ b/scripts/control/system/sysupdate.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 0211 ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} sysupdate (@var{sys}, @var{opt}) +## @deftypefn {Function File} {} sysupdate (@var{sys}, @var{opt}) ## Update the internal representation of a system. ## ## @strong{Inputs}
--- a/scripts/control/system/tf2ss.m +++ b/scripts/control/system/tf2ss.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} tf2ss (@var{inputs}) +## @deftypefn {Function File} {} tf2ss (@var{inputs}) ## @format ## Conversion from tranfer function to state-space. ## The state space system
--- a/scripts/control/system/tf2sys.m +++ b/scripts/control/system/tf2sys.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} tf2sys (@var{num}, @var{den} @{, @var{tsam}, @var{inname}, @var{outname} @}) +## @deftypefn {Function File} {} tf2sys (@var{num}, @var{den}, @var{tsam}, @var{inname}, @var{outname}) ## build system data structure from transfer function format data ## ## @strong{Inputs}
--- a/scripts/control/system/tf2zp.m +++ b/scripts/control/system/tf2zp.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} tf2zp (@var{inputs}) +## @deftypefn {Function File} {} tf2zp (@var{inputs}) ## Converts transfer functions to poles / zeros. ## ## [zer,pol,k] = tf2zp(num,den) returns the zeros and poles of the SISO system
--- a/scripts/control/system/tfout.m +++ b/scripts/control/system/tfout.m @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} tfout (@var{num}, @var{denom}@{, @var{x}@}) -## Print formatted transfer function @math{n(s)/d(s) } to the screen. +## @deftypefn {Function File} {} tfout (@var{num}, @var{denom}, @var{x}) +## Print formatted transfer function @math{n(s)/d(s)} to the screen. ## @var{x} defaults to the string @code{"s"} ## @end deftypefn ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue,
--- a/scripts/control/system/ugain.m +++ b/scripts/control/system/ugain.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outsys} =} ugain (@var{n}) +## @deftypefn {Function File} {} ugain (@var{n}) ## Creates a system with unity gain, no states. ## This trivial system is sometimes needed to create arbitrary ## complex systems from simple systems with buildssic.
--- a/scripts/control/system/zp2sys.m +++ b/scripts/control/system/zp2sys.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{sys} =} zp2sys (@var{zer},@var{pol},@var{k}@{,@var{tsam},@var{inname},@var{outname}@}) +## @deftypefn {Function File} {} zp2sys (@var{zer}, @var{pol}, @var{k}, @var{tsam}, @var{inname}, @var{outname}) ## Create system data structure from zero-pole data. ## ## @strong{Inputs}
--- a/scripts/control/system/zpout.m +++ b/scripts/control/system/zpout.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} zpout (@var{zer}, @var{pol}, @var{k}@{, @var{x}@}) +## @deftypefn {Function File} {} zpout (@var{zer}, @var{pol}, @var{k}, @var{x}) ## print formatted zero-pole form to the screen. ## @var{x} defaults to the string @code{"s"} ## @end deftypefn
--- a/scripts/control/util/__outlist__.m +++ b/scripts/control/util/__outlist__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} __outlist__ (@var{lmat}@{, @var{tabchar}, @var{yd}, @var{ilist} @}) +## @deftypefn {Function File} {} __outlist__ (@var{lmat}, @var{tabchar}, @var{yd}, @var{ilist}) ## Prints an enumerated list of strings. ## internal use only; minimal argument checking performed ## @@ -30,7 +30,7 @@ ## @item yd ## indices of strings to append with the string "(discrete)" ## (used by @var{sysout}; minimal checking of this argument) -## @math{yd = [] } indicates all outputs are continuous +## @math{yd = []} indicates all outputs are continuous ## @item ilist ## index numbers to print with names. ##
--- a/scripts/control/util/__zgpbal__.m +++ b/scripts/control/util/__zgpbal__.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retsys} =} __zgpbal__ (@var{Asys}) +## @deftypefn {Function File} {} __zgpbal__ (@var{Asys}) ## ## used internally in @code{tzero}; minimal argument checking performed ##
--- a/scripts/control/util/axis2dlim.m +++ b/scripts/control/util/axis2dlim.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn{Function File} {@var{axvec} =} axis2dlim (@var{axdata}) +## @deftypefn{Function File} {} axis2dlim (@var{axdata}) ## determine axis limits for 2-d data(column vectors); leaves a 10% margin ## around the plots. ## puts in margins of +/- 0.1 if data is one dimensional (or a single point)
--- a/scripts/control/util/prompt.m +++ b/scripts/control/util/prompt.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} prompt (@var{inputs}) +## @deftypefn {Function File} {} prompt (@var{inputs}) ## @format ## function prompt([str]) ## Prompt user to continue
--- a/scripts/control/util/sortcom.m +++ b/scripts/control/util/sortcom.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} sortcom (@var{inputs}) +## @deftypefn {Function File} {} sortcom (@var{inputs}) ## @format ## [yy,idx] = sortcom(xx[,opt]): sort a complex vector ## xx: complex vector
--- a/scripts/control/util/swap.m +++ b/scripts/control/util/swap.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{outputs} =} swap (@var{inputs}) +## @deftypefn {Function File} {} swap (@var{inputs}) ## @format ## [a1,b1] = swap(a,b) ## interchange a and b
--- a/scripts/control/util/zgfmul.m +++ b/scripts/control/util/zgfmul.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} zgfmul (@var{a}, @var{b}, @var{c}, @var{d}, @var{x}) +## @deftypefn {Function File} {} zgfmul (@var{a}, @var{b}, @var{c}, @var{d}, @var{x}) ## ## Compute product of zgep incidence matrix @var{F} with vector @var{x}. ## Used by zgepbal (in zgscal) as part of generalized conjugate gradient
--- a/scripts/control/util/zgfslv.m +++ b/scripts/control/util/zgfslv.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} zgfslv (@var{n}, @var{m}, @var{p}, @var{b}) +## @deftypefn {Function File} {} zgfslv (@var{n}, @var{m}, @var{p}, @var{b}) ## Solve system of equations for dense zgep problem. ## @end deftypefn
--- a/scripts/control/util/zginit.m +++ b/scripts/control/util/zginit.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{zz} =} zginit (@var{a}, @var{b}, @var{c}, @var{d}) +## @deftypefn {Function File} {} zginit (@var{a}, @var{b}, @var{c}, @var{d}) ## Construct right hand side vector zz ## for the zero-computation generalized eigenvalue problem ## balancing procedure. Called by zgepbal.
--- a/scripts/control/util/zgscal.m +++ b/scripts/control/util/zgscal.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} zgscal (@var{f}, @var{z}, @var{n}, @var{m}, @var{p}) +## @deftypefn {Function File} {} zgscal (@var{f}, @var{z}, @var{n}, @var{m}, @var{p}) ## Generalized conjugate gradient iteration to ## solve zero-computation generalized eigenvalue problem balancing equation ## @math{fx=z};
--- a/scripts/control/util/zgsgiv.m +++ b/scripts/control/util/zgsgiv.m @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[a, b] =} zgsgiv (@var{c}, @var{s}, @var{a}, @var{b}) -## apply givens rotation c,s to row vectors @var{a},@var{b} +## Apply givens rotation c,s to row vectors @var{a}, @var{b}. ## No longer used in zero-balancing (__zgpbal__); kept for backward ## compatibility. ## @end deftypefn
--- a/scripts/control/util/zgshsr.m +++ b/scripts/control/util/zgshsr.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} zgshsr (@var{y}) +## @deftypefn {Function File} {} zgshsr (@var{y}) ## apply householder vector based on @math{e^(m)} to ## (column vector) y. ## Called by zgfslv
--- a/scripts/general/postpad.m +++ b/scripts/general/postpad.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} postpad (@var{x}, @var{l}, @var{c}) +## @deftypefn {Function File} {} postpad (@var{x}, @var{l}, @var{c}) ## See prepad. ## @end deftypefn
--- a/scripts/general/prepad.m +++ b/scripts/general/prepad.m @@ -18,15 +18,15 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} prepad (@var{x}, @var{l}, @var{c}) -## @deftypefnx {Function File} {@var{x} =} postpad (@var{x}, @var{l}, @var{c}) +## @deftypefn {Function File} {} prepad (@var{x}, @var{l}, @var{c}) +## @deftypefnx {Function File} {} postpad (@var{x}, @var{l}, @var{c}) ## ## Prepends (appends) the scalar value @var{c} to the vector @var{x} ## until it is of length @var{l}. If the third argument is not ## supplied, a value of 0 is used. ## -## If @code{length (x) > l}, elements from the beginning (end) of -## @var{x} are removed until a vector of length l is obtained. +## If @code{length (@var{x}) > @var{l}}, elements from the beginning (end) of +## @var{x} are removed until a vector of length @var{l} is obtained. ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/miscellaneous/path.m +++ b/scripts/miscellaneous/path.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{p} =} path (@dots{}) +## @deftypefn {Function File} {} path (@dots{}) ## Modify or display Octave's @code{LOADPATH}. ## ## If @var{nargin} and @var{nargout} are zero, display the elements of
--- a/scripts/miscellaneous/texas_lotto.m +++ b/scripts/miscellaneous/texas_lotto.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{winning_numbers} =} texas_lotto () +## @deftypefn {Function File} {} texas_lotto () ## Pick 6 unique numbers between 1 and 50 that are guaranteed to win ## the Texas Lotto. ## @end deftypefn
--- a/scripts/plot/__pltopt1__.m +++ b/scripts/plot/__pltopt1__.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{fmt} =} __pltopt1__ (@var{caller}, @var{opt}) +## @deftypefn {Function File} {} __pltopt1__ (@var{caller}, @var{opt}) ## Really decode plot option strings. ## @end deftypefn ## @seealso{__pltopt__}
--- a/scripts/plot/__pltopt__.m +++ b/scripts/plot/__pltopt__.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{fmt} =} __pltopt__ (@var{caller}, @var{opt}) +## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt}) ## Decode plot option strings. ## ## If @var{opt} is a valid option string, return a string of the form
--- a/scripts/signal/arch_rnd.m +++ b/scripts/signal/arch_rnd.m @@ -15,10 +15,10 @@ ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} arch_rnd (@var{a}, @var{b}, @var{t}) -## Simulate an ARCH sequence, @var{y}, of length @var{t} with AR +## @deftypefn {Function File} {} arch_rnd (@var{a}, @var{b}, @var{t}) +## Simulate an ARCH sequence of length @var{t} with AR ## coefficients @var{b} and CH coefficients @var{a}. I.e., the result -## follows the model +## @math{y(t)} follows the model ## ## @example ## y(t) = b(1) + b(2) * y(t-1) + @dots{} + b(lb) * y(t-lb+1) + e(t),
--- a/scripts/signal/synthesis.m +++ b/scripts/signal/synthesis.m @@ -15,7 +15,7 @@ ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{x} =} synthesis (@var{y}, @var{c}) +## @deftypefn {Function File} {} synthesis (@var{y}, @var{c}) ## Compute a signal from its short-time Fourier transform @var{y} and a ## 3-element vector @var{c} specifying window size, increment, and ## window type.
--- a/scripts/specfun/log2.m +++ b/scripts/specfun/log2.m @@ -15,7 +15,7 @@ ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {@var{y} =} log2 (@var{x}) +## @deftypefn {Mapping Function} {} log2 (@var{x}) ## @deftypefnx {Mapping Function} {[@var{f}, @var{e}]} log2 (@var{x}) ## Compute the base-2 logarithm of @var{x}. With two outputs, returns ## @var{f} and @var{e} such that
--- a/scripts/strings/com2str.m +++ b/scripts/strings/com2str.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{retval} =} com2str(@var{zz}, @var{flg}) +## @deftypefn {Function File} {} com2str(@var{zz}, @var{flg}) ## ## convert complex number to a string ## @strong{Inputs}
--- a/scripts/strings/isletter.m +++ b/scripts/strings/isletter.m @@ -18,7 +18,7 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{bool} =} isletter(@var{s}) +## @deftypefn {Function File} {} isletter(@var{s}) ## Returns true if @var{s} is a letter false otherwise. ## @end deftypefn ## @seealso{isalpha}
--- a/src/DLD-FUNCTIONS/qz.cc +++ b/src/DLD-FUNCTIONS/qz.cc @@ -187,7 +187,7 @@ \n\ Computes the generalized eigenvalues @var{lambda} of @math{(A - sB)}.\n\ \n\ -@item @code{[AA, BB, Q, Z @{, V, W, lambda@}] = qz (A, B)}\n\ +@item @code{[AA, BB, Q, Z, V, W, lambda] = qz (A, B)}\n\ \n\ Computes qz decomposition, generalized eigenvectors, and \n\ generalized eigenvalues of @math{(A - sB)}\n\