Mercurial > hg > octave-lyh
changeset 3416:493df428100e
[project @ 2000-01-11 07:03:30 by jwe]
author | jwe |
---|---|
date | Tue, 11 Jan 2000 07:03:33 +0000 |
parents | 48aa44151317 |
children | cb56e4bd79ca |
files | scripts/ChangeLog scripts/audio/setaudio.m scripts/control/DEMOcontrol.m scripts/control/com2str.m scripts/control/controldemo.m scripts/control/dezero.m scripts/control/dre.m scripts/control/hinfsyn_ric.m scripts/strings/upper.m |
diffstat | 9 files changed, 89 insertions(+), 29 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,15 @@ +2000-01-11 Ben Sapp <bsapp@nua.lampf.lanl.gov> + + * strings/upper.m: Add missing `-*- texinfo -*-' tag to doc string. + + * audio/setaudio.m: Texinfoize doc string. + * control/com2str.m: Likewise. + * control/controldemo.m: Likewise. + * control/DEMOcontrol.m: Likewise. + * control/dezero.m: Likewise. + * control/dre.m: Likewise. + * control/hinfsyn_ric.m: Likewise. + 2000-01-05 Ben Sapp <bsapp@nua.lampf.lanl.gov> * io/printf.m: Add @seealso{...} to doc string.
--- a/scripts/audio/setaudio.m +++ b/scripts/audio/setaudio.m @@ -17,9 +17,11 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: setaudio ([w_type [, value]]) +## -*- texinfo -*- +## @deftypefn{Function File} setaudio ([@var{w_type} [, @var{value}]]) ## -## executes the shell command `mixer [w_type [, value]]' +## executes the shell command `mixer [@var{w_type} [, @var{value}]]' +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 5 October 1994
--- a/scripts/control/DEMOcontrol.m +++ b/scripts/control/DEMOcontrol.m @@ -38,8 +38,8 @@ ## Command examples are interactively run for users to observe the use ## of OCST functions. ## @end deftypefn - -## Demo programs: bddemo.m, frdemo.m, analdemo.m, moddmeo.m, rldemo.m +## @seealso{Demo Programs: bddemo.m, frdemo.m, analdemo.m, +## moddmeo.m, rldemo.m} ## Author: David Clem ## Created: August 15, 1994
--- a/scripts/control/com2str.m +++ b/scripts/control/com2str.m @@ -15,14 +15,21 @@ ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. - -## usage retval = com2str(zz{,flg}) + +## -*- texinfo -*- +## @deftypefn {Function File} {@var{retval} =} com2str(@var{zz}[,@var{flg}]) ## ## convert complex number to a string -## zz: complex number -## flg: format flag +## @strong{Inputs} +## @table @var +## @item zz +## complex number +## @item flg +## format flag ## 0 (default): -1, 0, 1, 1i, 1 + 0.5i ## 1 (for use with zpout): -1, 0, + 1, + 1i, + 1 + 0.5i +## @end table +## @end deftypefn function retval = com2str (zz, flg)
--- a/scripts/control/controldemo.m +++ b/scripts/control/controldemo.m @@ -16,8 +16,12 @@ ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. +## -*- texinfo -*- +## @deftypefn {Function File} { } controldemo ## Controls toolbox demo. -## Demo programs: bddemo.m, frdemo.m, analdemo.m, moddmeo.m, rldemo.m +## @end deftypefn +## @seealso{Demo programs: bddemo.m, frdemo.m, analdemo.m, +## moddmeo.m, rldemo.m ## Author: David Clem ## Created: August 15, 1994
--- a/scripts/control/dezero.m +++ b/scripts/control/dezero.m @@ -17,9 +17,10 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: dezero (s) -## +## -*- texinfo -*- +## @deftypefn {Functin File} {@var{t} =} dezero (@var{s}) ## Remove trailing blank entries and all zero entries from the string s. +## @end deftypefn ## Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at> ## Adapted-By: jwe
--- a/scripts/control/dre.m +++ b/scripts/control/dre.m @@ -16,29 +16,58 @@ ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. -## [tvals,Plist] = dre(sys,Q,R,Qf,t0,tf{,Ptol,maxits}); +## -*- 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}]); ## Solve the differential Riccati equation +## @ifinfo +## @example ## -d P/dt = A'P + P A - P B inv(R) B' P + Q ## P(tf) = Qf +## @example +## @end ifinfo +## @iftex +## @tex +## \(-\frac{dP}{dt} = A^{T}P+PA-PBR^{-1}B^{T}P+Q\) +## @end tex +## @end iftex ## for the LTI system sys. Solution of standard LTI ## state feedback optimization ## min \int_{t_0}^{t_f} x' Q x + u' R u dt + x(t_f)' Qf x(t_f) ## optimal input is ## u = - inv(R) B' P(t) x -## inputs: -## sys: continuous time system data structure -## Q: state integral penalty -## R: input integral penalty -## Qf: state terminal penalty -## t0,tf: limits on the integral -## Ptol: tolerance (used to select time samples; see below); default = 0.1 -## max number of refinement iterations (default=10) -## outputs: -## tvals: time values at which P(t) is computed -## Plist: list values of P(t); nth(Plist,ii) is P(tvals(ii)). +## @strong{Inputs} +## @table +## @item sys +## continuous time system data structure +## @item Q +## state integral penalty +## @item R +## input integral penalty +## @item Qf +## state terminal penalty +## @item t0 +## @itemx tf +## limits on the integral +## @item Ptol +## tolerance (used to select time samples; see below); default = 0.1 +## @item maxits +## number of refinement iterations (default=10) +## @end table +## @strong{Outputs} +## @table +## @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}) +## is @var{P}(@var{tvals}(@var{ii})). ## -## tvals is selected so that || nth(Plist,ii) - nth(Plist,ii-1) || < Ptol +## @item tvals +## @example +## is selected so that || nth(Plist,ii) - nth(Plist,ii-1) || < Ptol ## for ii=2:length(tvals) +## @end example +## @end table +## @end deftypefn function [tvals, Plist] = dre (sys, Q, R, Qf, t0, tf, Ptol, maxits)
--- a/scripts/control/hinfsyn_ric.m +++ b/scripts/control/hinfsyn_ric.m @@ -16,14 +16,17 @@ ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. -## usage: [Xinf,x_ha_err] = hinfsyn_ric(A,BB,C1,d1dot,R,ptol) -## -## forms +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{Xinf},@var{x_ha_err}] =} hinfsyn_ric(@var{A},@var{BB}.@var{C1},@var{d1dot},@var{R},@var{ptol}) +## @table +## @item forms ## xx = ([BB; -C1'*d1dot]/R) * [d1dot'*C1 BB']; ## Ha = [A 0*A; -C1'*C1 -A'] - xx; +## @end table ## and solves associated Riccati equation ## returns error code -## x_ha_err: +## @table +## @item x_ha_err ## 0: successful ## 1: Xinf has imaginary eigenvalues ## 2: Hx not Hamiltonian @@ -31,7 +34,8 @@ ## 4: Xinf not symmetric ## 5: Xinf not positive definite ## 6: R is singular - +## @end table +## @end deftypefn function [Xinf, x_ha_err] = hinfsyn_ric (A, BB, C1, d1dot, R, ptol) x_ha_err = 0; # assume success
--- a/scripts/strings/upper.m +++ b/scripts/strings/upper.m @@ -17,6 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## -*- texinfo -*- ## @deftypefn {Function File} {@var{S} =} upper(@var{s}) ## Transform all letters in a string to upper case. ## @end deftypefn