Mercurial > octave-nkf
changeset 3449:858695b3ed62
[project @ 2000-01-18 04:08:59 by jwe]
line wrap: on
line diff
--- a/doc/interpreter/grammar.txi Mon Jan 17 20:38:35 2000 +0000 +++ b/doc/interpreter/grammar.txi Tue Jan 18 04:09:14 2000 +0000 @@ -3,7 +3,7 @@ @c For copying conditions, see the file gpl.texi. @node Grammar, Copying, Emacs, Top -@chapter Grammar +@appendix Grammar @cindex grammar rules @cindex language definition
--- a/doc/interpreter/signal.txi Mon Jan 17 20:38:35 2000 +0000 +++ b/doc/interpreter/signal.txi Tue Jan 18 04:09:14 2000 +0000 @@ -28,3 +28,63 @@ @DOCSTRING(freqz) @DOCSTRING(sinc) + +@c XXX FIXME XXX -- someone needs to organize these... + +@DOCSTRING(arch_fit) + +@DOCSTRING(arch_rnd) + +@DOCSTRING(arch_test) + +@DOCSTRING(arma_rnd) + +@DOCSTRING(autocor) + +@DOCSTRING(autocov) + +@DOCSTRING(autoreg_matrix) + +@DOCSTRING(bartlett) + +@DOCSTRING(blackman) + +@DOCSTRING(diffpara) + +@DOCSTRING(durbinlevinson) + +@DOCSTRING(fftshift) + +@DOCSTRING(fractdiff) + +@DOCSTRING(hamming) + +@DOCSTRING(hanning) + +@DOCSTRING(hurst) + +@DOCSTRING(periodogram) + +@DOCSTRING(rectangle_lw) + +@DOCSTRING(rectangle_sw) + +@DOCSTRING(sinetone) + +@DOCSTRING(sinewave) + +@DOCSTRING(spectral_adf) + +@DOCSTRING(spectral_xdf) + +@DOCSTRING(spencer) + +@DOCSTRING(stft) + +@DOCSTRING(synthesis) + +@DOCSTRING(triangle_lw) + +@DOCSTRING(triangle_sw) + +@DOCSTRING(yulewalker)
--- a/scripts/ChangeLog Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/ChangeLog Tue Jan 18 04:09:14 2000 +0000 @@ -1,6 +1,64 @@ 2000-01-17 John W. Eaton <jwe@bevo.che.wisc.edu> * strings/bin2dec.m: Texinfoize doc string. + * plot/__plr1__.m: Ditto. + * plot/__pltopt__.m: Ditto. + * plot/__plt__.m: Ditto. + * plot/__plt2vv__.m: Ditto. + * plot/__plr2__.m: Ditto. + * plot/__plr__.m: Ditto. + * plot/__plt1__.m: Ditto. + * plot/__plt2__.m: Ditto. + * plot/__plt2mm__.m: Ditto. + * plot/__plt2mv__.m: Ditto. + * plot/__plt2ss__.m: Ditto. + * miscellaneous/paren.m: Ditto. + * miscellaneous/comma.m: Ditto. + * miscellaneous/semicolon.m: Ditto. + * miscellaneous/path.m: Ditto. + * miscellaneous/list_primes.m: Ditto. + * miscellaneous/flops.m: Ditto. + * miscellaneous/dump_prefs.m: Ditto. + * miscellaneous/bug_report.m: Ditto. + * linear-algebra/dot.m: Ditto + * linear-algebra/dmult.m: Ditto. + * general/randperm.m: Ditto. + * general/logical.m: Ditto. + * general/is_duplicate_entry.m: Ditto. + * signal/arch_fit.m: Ditto. + * signal/arch_rnd.m: Ditto. + * signal/arch_test.m: Ditto. + * signal/arma_rnd.m: Ditto. + * signal/autocor.m: Ditto. + * signal/autocov.m: Ditto. + * signal/autoreg_matrix.m: Ditto. + * signal/bartlett.m: Ditto. + * signal/blackman.m: Ditto. + * signal/detrend.m: Ditto. + * signal/diffpara.m: Ditto. + * signal/durbinlevinson.m: Ditto. + * signal/fftconv.m: Ditto. + * signal/fftfilt.m: Ditto. + * signal/fftshift.m: Ditto. + * signal/fractdiff.m: Ditto. + * signal/freqz.m: Ditto. + * signal/hamming.m: Ditto. + * signal/hanning.m: Ditto. + * signal/hurst.m: Ditto. + * signal/periodogram.m: Ditto. + * signal/rectangle_lw.m: Ditto. + * signal/rectangle_sw.m: Ditto. + * signal/sinc.m: Ditto. + * signal/sinetone.m: Ditto. + * signal/sinewave.m: Ditto. + * signal/spectral_adf.m: Ditto. + * signal/spectral_xdf.m: Ditto. + * signal/spencer.m: Ditto. + * signal/stft.m: Ditto. + * signal/synthesis.m: Ditto. + * signal/triangle_lw.m: Ditto. + * signal/triangle_sw.m: Ditto. + * signal/yulewalker.m: Ditto. 2000-01-14 John W. Eaton <jwe@bevo.che.wisc.edu>
--- a/scripts/general/is_duplicate_entry.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/general/is_duplicate_entry.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,9 +17,11 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## Usage: is_duplicate_entry (x) -## -## Return non-zero if any entries in x are duplicates of one another. +## -*- texinfo -*- +## @deftypefn {Function File} {} is_duplicate_entry (@var{x}) +## Return non-zero if any entries in @var{x} are duplicates of one +## another. +## @end deftypefn ## Author: A. S. Hodel <scotte@eng.auburn.edu>
--- a/scripts/general/logical.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/general/logical.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,15 +17,21 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: logical (arg) +## -*- texinfo -*- +## @deftypefn {Function File} {} logical (@var{arg}) +## Convert @var{arg} to a logical value. For example, ## -## Convert ARG to a logical value. For example, +## @example +## logical ([-1, 0, 1]) +## @end example ## -## logical ([-1, 0, 1]) -## +## @noindent ## is equivalent to ## -## [-1, 0, 1] != 0 +## @example +## [-1, 0, 1] != 0 +## @end example +## @end deftypefn ## Author: jwe
--- a/scripts/general/randperm.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/general/randperm.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,10 +17,11 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: randperm (N) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} randperm (@var{n}) ## Return a row vector containing a random permutation of the -## integers from 1 to N. +## integers from 1 to @var{n}. +## @end deftypefn ## Author: "James R. Van Zandt" <jrv@vanzandt.mv.com> ## Adapted-By: jwe
--- a/scripts/linear-algebra/dmult.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/linear-algebra/dmult.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: dmult (a, B) -## -## If a is a vector of length rows (B), return diag (a) * B (but -## computed much more efficiently). +## -*- texinfo -*- +## @deftypefn {Function File} {} dmult (@var{a}, @var{b}) +## If @var{a} is a vector of length @code{rows (@var{b})}, return +## @code{diag (@var{a}) * @var{b}} (but computed much more efficiently). +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Rescale the rows of a matrix
--- a/scripts/linear-algebra/dot.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/linear-algebra/dot.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,9 +14,10 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: dot (x, y) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} dot (@var{x}, @var{y}) ## Computes the dot product of two vectors. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/bug_report.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/bug_report.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,11 +17,12 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: bug_report -## +## -*- texinfo -*- +## @deftypefn {Function File} {} bug_report () ## Have Octave create a bug report template file, invoke your favorite ## editor, and submit the report to the bug-octave mailing list when ## you are finished editing. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/comma.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/comma.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,8 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## @deftypefn {Operator} {} , +## -*- texinfo -*- +## @deffn {Operator} , ## Array index, function argument, or command separator. -## @end deftypefn +## @end deffn ## @seealso{semicolon}
--- a/scripts/miscellaneous/dump_prefs.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/dump_prefs.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,11 +17,12 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: dump_prefs (file) -## -## Have Octave dump all the current user preference variables to FILE -## in a format that can be parsed by Octave later. If FILE is omitted, -## the listing is printed to stdout. +## -*- texinfo -*- +## @deftypefn {Function File} {} dump_prefs (@var{file}) +## Have Octave dump all the current user preference variables to +## @var{file} in a format that can be parsed by Octave later. If +## @var{file} is omitted, the listing is printed to stdout. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/flops.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/flops.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,9 +17,11 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: flops -## -## Count floating point operations. +## -*- texinfo -*- +## @deftypefn {Function File} {} flops () +## This function is provided for Matlab compatibility, but it doesn't +## actually do anything. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/list_primes.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/list_primes.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,12 +17,21 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: list_primes (n) +## -*- texinfo -*- +## @deftypefn {Function File} {} list_primes (@var{n}) +## List the first @var{n} primes. If @var{n} is unspecified, the first +## 30 primes are listed. ## -## List the first n primes. If n is unspecified, the first 30 primes -## are listed. -## -## The algorithm used is from page 218 of the TeXbook. +## The algorithm used is from page 218 of the +## @iftex +## @tex +## \TeXbook. +## @end tex +## @end iftex +## @ifinfo +## TeXbook. +## @end ifinfo +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/pack.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/pack.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,10 +17,11 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: pack -## +## -*- texinfo -*- +## @deftypefn {Function File} {} pack () ## This function is provided for compatibility with Matlab, but it ## doesn't actually do anything. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/paren.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/paren.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,4 +17,8 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## -*- texinfo -*- +## @deffn {Operator} ( +## @deffnx {Operator} ) ## Array index or function argument delimeter. +## @end deffn
--- a/scripts/miscellaneous/path.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/path.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,20 +17,22 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: p = path (...) +## -*- texinfo -*- +## @deftypefn {Function File} {@var{p} =} path (@dots{}) +## Modify or display Octave's @code{LOADPATH}. ## -## Modify or display Octave's LOADPATH. +## If @var{nargin} and @var{nargout} are zero, display the elements of +## Octave's @code{LOADPATH} in an easy to read format. ## -## If nargin and nargout are 0, display the elements of Octave's -## LOADPATH in an easy to read format. +## If @var{nargin} is zero and nargout is greater than zero, return the +## current value of @code{LOADPATH}. ## -## If nargin is zero and nargout is greater than zero, return the -## current value of LOADPATH. -## -## If nargin is greater than zero, concatenate the arguments, separating -## them with ":". Set LOADPATH to the result and also return it. +## If @var{nargin} is greater than zero, concatenate the arguments, +## separating them with @code{":"}. Set @code{LOADPATH} to the result +## and also return it. ## ## No checks are made for duplicate elements. +## @end deftypefn ## Author: jwe
--- a/scripts/miscellaneous/semicolon.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/semicolon.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,8 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## @deftypefn {Operator} {} : () +## -*- texinfo -*- +## @deffn {Operator} ; ## Array row or command separator. -## @end deftypefn +## @end deffn ## @seealso{comma}
--- a/scripts/miscellaneous/texas_lotto.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/miscellaneous/texas_lotto.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,8 +17,8 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## -*- texinfo -*- ## @deftypefn {Function File } {@var{winning_numbers} =} texas_lotto () -## ## Pick 6 unique numbers between 1 and 50 that are guaranteed to win ## the Texas Lotto. ## @end deftypefn
--- a/scripts/plot/__plr1__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plr1__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plr1__ (theta, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plr1__ (@var{theta}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plr2__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plr2__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plr2__ (theta, rho, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plr2__ (@var{theta}, @var{rho}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plr__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plr__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plr__ (theta, rho, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plr__ (@var{theta}, @var{rho}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt1__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt1__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt1__ (x1, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt1__ (@var{x1}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2__ (x1, x2, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2__ (@var{x1}, @var{x2}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2mm__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2mm__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2mm__ (x, y, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2mm__ (@var{x}, @var{y}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2mv__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2mv__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2mv__ (x, y, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2mv__ (@var{x}, @var{y}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2ss__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2ss__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2ss__ (x, y, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2ss__ (@var{x}, @var{y}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2vm__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2vm__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2vm__ (x, y, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2vm__ (@var{x}, @var{y}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt2vv__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt2vv__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt2vv__ (x, y, fmt) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt2vv__ (@var{x}, @var{y}, @var{fmt}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__plt__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__plt__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,7 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: function __plt__ (caller, ...) +## -*- texinfo -*- +## @deftypefn {Function File} {} __plt__ (@code{caller}, @dots{}) +## @end deftypefn ## Author: jwe
--- a/scripts/plot/__pltopt1__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__pltopt1__.m Tue Jan 18 04:09:14 2000 +0000 @@ -19,7 +19,6 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{fmt} =} __pltopt1__ (@var{caller}, @var{opt}) -## ## Really decode plot option strings. ## @end deftypefn ## @seealso{__pltopt__}
--- a/scripts/plot/__pltopt__.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/__pltopt__.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,55 +17,71 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: fmt = __pltopt__ (caller, opt) -## +## -*- texinfo -*- +## @deftypefn {Function File} {@var{fmt} =} __pltopt__ (@var{caller}, @var{opt}) ## Decode plot option strings. ## -## If OPT is a valid option string, return a string of the form "w l 2" -## ("with lines 2"). Uses abbreviations for the options to avoid -## overrunning gnuplot's command line buffer unnecessarily. -## -## OPT can currently be some combination of the following: +## If @var{opt} is a valid option string, return a string of the form +## @code{"w l 2"} ("with lines 2"). Uses abbreviations for the options +## to avoid overrunning gnuplot's command line buffer unnecessarily. ## -## "-" for lines plot style (default). -## "." for dots plot style. -## "@" for points plot style. -## "-@" for linespoints plot style. -## "^" for impulses plot style. -## "L" for steps plot style. -## "#" for boxes plot style. -## "~" for errorbars plot style. -## "#~" for boxerrorbars plot style. -## "n" with n in 1-6 (wraps at 8), plot color -## "nm" with m in 1-6 (wraps at 6), point style (only valid for "@" or "-@") -## "c" where c is one of ["r", "g", "b", "m", "c", "w"] colors. -## ";title;" where "title" is the label for the key. +## @var{opt} can currently be some combination of the following: ## -## Special points formats: -## -## "+", "*", "o", "x" will display points in that style for term x11. -## -## The legend may be fixed to include the name of the variable -## plotted in some future version of Octave. -## -## The colors, line styles, and point styles have the following -## meanings for X11 and Postscript terminals under Gnuplot 3.6. +## @table @code +## @item "-" +## For lines plot style (default). +## @item "." +## For dots plot style. +## @item "@" +## For points plot style. +## @item "-@" +##For linespoints plot style. +## @item "^" +## For impulses plot style. +## @item "L" +## For steps plot style. +## @item "#" +## For boxes plot style. +## @item "~" +## For errorbars plot style. +## @item "#~" +## For boxerrorbars plot style. +## @item "n" +## With @code{n} in 1-6 (wraps at 8), plot color +## @item "nm" +## With @code{m} in 1-6 (wraps at 6), point style (only valid for @code{"@"} or +## @code{"-@"}) +## @item @var{c} +## Where @var{c} is one of @code{"r"}, @code{"g"}, @code{"b"}, @code{"m"}, +## @code{"c"}, or @code{"w"} colors. +## @item ";title;" +## Here @code{"title"} is the label for the key. +## @end table ## -## Number ------ Color ------- Line Style ---- Points Style ---- -## x11 postscript postscript x11 postscript -## ===================================================================== -## 1 red green solid "o" "+" -## 2 green blue long dash "+" "x" -## 3 blue red short dash square "*" -## 4 magenta magenta dotted "x" open square -## 5 cyan cyan dot long dash triangle filled square -## 6 brown yellow dot short dash "*" "o" +## Special points formats: @code{"+"}, @code{"*"}, @code{"o"}, or +## @code{"x"} will display points in that style for term x11. +## +## The legend may be fixed to include the name of the variable +## plotted in some future version of Octave. +## +## The colors, line styles, and point styles have the following +## meanings for X11 and Postscript terminals under Gnuplot 3.6. ## +## @example +## Number ------ Color ------- Line Style ---- Points Style ---- +## x11 postscript postscript x11 postscript +## ===================================================================== +## 1 red green solid "o" "+" +## 2 green blue long dash "+" "x" +## 3 blue red short dash square "*" +## 4 magenta magenta dotted "x" open square +## 5 cyan cyan dot long dash triangle filled square +## 6 brown yellow dot short dash "*" "o" +## @end example +## @end deftypefn ## @seealso{__pltopt1__} ## Author: jwe -## Adapted-By: jwe -## Maintainer: jwe function fmt = __pltopt__ (caller, opt)
--- a/scripts/plot/bottom_title.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/plot/bottom_title.m Tue Jan 18 04:09:14 2000 +0000 @@ -17,13 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: bottom_title (text) -## -## NOTE: this will work only with gnuplot installed with -## multiplot patch -## -## makes a title with the given text at the bottom of the plot -## rather than the top. +## See top_title. ## Author: Vinayak Dutt <Dutt.Vinayak@mayo.EDU> ## Adapted-By: jwe
--- a/scripts/signal/arch_fit.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/arch_fit.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,27 +14,34 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: [a, b] = arch_fit (y, X, p [, ITER [, gamma [, a0, b0]]]) +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{a}, @var{b}] =} arch_fit (@var{y}, @var{x}, @var{p}, @var{iter}, @var{gamma}, @var{a0}, @var{b0}) +## Fit an ARCH regression model to the time series @var{y} using the +## scoring algorithm in Engle's original ARCH paper. The model is ## -## Fits an ARCH regression model to the time series y using the scoring -## algorithm in Engle's original ARCH paper. The model is -## y(t) = b(1) * x(t,1) + ... + b(k) * x(t,k) + e(t), -## h(t) = a(1) + a(2) * e(t-1)^2 + ... + a(p+1) * e(t-p)^2, -## where e(t) is N(0, h(t)), given y up to time t-1 and X up to t. +## @example +## y(t) = b(1) * x(t,1) + ... + b(k) * x(t,k) + e(t), +## h(t) = a(1) + a(2) * e(t-1)^2 + ... + a(p+1) * e(t-p)^2 +## @end example ## -## If invoked as arch_fit (y, k, p) with a positive integer k, fit an -## ARCH(k,p) process, i.e., do the above with the t-th row of X given by -## [1, y(t-1), ..., y(t-k)]. +## @noindent +## in which @var{e}(@var{t}) is @var{N}(0, @var{h}(@var{t})), given a +## time-series vector @var{y} up to time @var{t}-1 and a matrix of +## (ordinary) regressors @var{x} up to @var{t}. The order of the +## regression of the residual variance is specified by @var{p}. ## -## Optionally, one can specify the number of iterations ITER, the -## updating factor gamma, and initial values a0 and b0 for the scoring -## algorithm. +## If invoked as @code{arch_fit (@var{y}, @var{k}, @var{p})} with a +## positive integer @var{k}, fit an ARCH(@var{k}, @var{p}) process, +## i.e., do the above with the @var{t}-th row of @var{x} given by ## -## The input parameters are: -## y ... time series (vector) -## X ... matrix of (ordinary) regressors or order of -## autoregression -## p ... order of the regression of the residual variance +## @example +## [1, y(t-1), ..., y(t-k)] +## @end example +## +## Optionally, one can specify the number of iterations @var{iter}, the +## updating factor @var{gamma}, and initial values @var{a0} and @var{b0} +## for the scoring algorithm. +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Fit an ARCH regression model @@ -42,7 +49,7 @@ function [a, b] = arch_fit (y, X, p, ITER, gamma, a0, b0) if ((nargin < 3) || (nargin == 6) || (nargin > 7)) - usage ("arch_fit (y, X, p [, ITER [, gamma [, a0, b0]]])"); + usage ("arch_fit (y, X, p, ITER, gamma, a0, b0)"); endif if !(is_vector (y))
--- a/scripts/signal/arch_rnd.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/arch_rnd.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,14 +14,24 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: y = arch_rnd (a, b, T) +## -*- 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 +## coefficients @var{b} and CH coefficients @var{a}. I.e., the result +## follows the model ## -## Simulates an ARCH sequence y of length T with AR coefficients b and -## CH coefficients a. -## I.e., y follows the model -## y(t) = b(1) + b(2) * y(t-1) + ... + b(lb) * y(t-lb+1) + e(t), -## where e(t), given y up to time t-1, is N(0, h(t)), with -## h(t) = a(1) + a(2) * e(t-1)^2 + ... + a(la) * e(t-la+1)^2. +## @example +## y(t) = b(1) + b(2) * y(t-1) + ... + b(lb) * y(t-lb+1) + e(t), +## @end example +## +## @noindent +## where e(t), given @var{y} up to time @var{t}-1, is @var{N}(0, +## @var{h}(@var{t})), with +## +## @example +## h(t) = a(1) + a(2) * e(t-1)^2 + ... + a(la) * e(t-la+1)^2 +## @end example +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Simulate an ARCH process
--- a/scripts/signal/arch_test.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/arch_test.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,26 +14,51 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: [pval, lm] = arch_test (y, X, p) -## [pval, lm] = arch_test (y, k, p) +## -*- texinfo -*- +## @deftypefn {Function File} {} {[@var{pval}, @var{lm}] =} arch_test (@var{y}, @var{x}, @var{p}) +## For a linear regression model ## -## arch_test (y, X, p) performs a Lagrange Multiplier (LM) test of the -## null hypothesis of no conditional heteroscedascity in the linear -## regression model y = X * b + e against the alternative of CH(p). +## @example +## y = x * b + e +## @end example +## +## @noindent +## perform a Lagrange Multiplier (LM) test of the null hypothesis of no +## conditional heteroscedascity against the alternative of CH(@var{p}). +## ## I.e., the model is -## y(t) = b(1) * x(t,1) + ... + b(k) * x(t,k) + e(t), -## where given y up to t-1 and x up to t, e(t) is N(0, h(t)) with -## h(t) = v + a(1) * e(t-1)^2 + ... + a(p) * e(t-p)^2, -## and the null is a(1) == ... == a(p) == 0. +## +## @example +## y(t) = b(1) * x(t,1) + ... + b(k) * x(t,k) + e(t), +## @end example +## +## @noindent +## given @var{y} up to @var{t}-1 and @var{x} up to @var{t}, +## @var{e}(@var{t}) is @var{N}(0, @var{h}(@var{t})) with +## +## @example +## h(t) = v + a(1) * e(t-1)^2 + ... + a(p) * e(t-p)^2, +## @end example +## +## @noindent +## and the null is @var{a}(1) == ... == @var{a}(@var{p}) == 0. ## -## arch_test (y, k, p) does the same in a linear autoregression model of -## order k, i.e., with [1, y(t-1), ..., y(t-k)] as the t-th row of X. +## If the second argument is a scalar integer, @var{k}, perform the same +## test in a linear autoregression model of order @var{k}, i.e., with +## +## @example +## [1, y(t-1), ..., y(t-@var{k})] +## @end example ## -## Under the null, lm approximately has a chisquare distribution with p -## degrees of freedom. pval is the p-value (1 minus the CDF of this -## distribution at lm) of the test. +## @noindent +## as the @var{t}-th row of @var{x}. ## -## If no output argument is given, the p-value is displayed. +## Under the null, LM approximately has a chisquare distribution with +## @var{p} degrees of freedom and @var{pval} is the @var{p}-value (1 +## minus the CDF of this distribution at LM) of the test. +## +## If no output argument is given, the @var{p}-value is displayed. +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Test for conditional heteroscedascity
--- a/scripts/signal/arma_rnd.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/arma_rnd.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,18 +14,25 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: arma_rnd (a, b, v, t [, n]) +## -*- texinfo -*- +## @deftypefn {Function File} {} arma_rnd (@var{a}, @var{b}, @var{v}, @var{t}, @var{n}) +## Return a simulation of the ARMA model +## +## @example +## x(n) = a(1) * x(n-1) + ... + a(k) * x(n-k) +## + e(n) + b(1) * e(n-1) + ... + b(l) * e(n-l) +## @end example ## -## Returns a simulation of the ARMA model -## x(n) = a(1) * x(n-1) + ... + a(k) * x(n-k) + -## + e(n) + b(1) * e(n-1) + ... + b(l) * e(n-l), -## where k is the length of vector a, l is the length of vector b and e -## is gaussian white noise with variance v. The function returns a -## vector of length t. +## @noindent +## in which @var{k} is the length of vector @var{a}, @var{l} is the +## length of vector @var{b} and @var{e} is gaussian white noise with +## variance @var{v}. The function returns a vector of length @var{t}. ## -## The optional parameter n gives the number of dummy x(i) used for -## initialization, i.e., a sequence of length t+n is generated and -## x(n+1:t+n) is returned. If n is omitted, n=100 is used. +## The optional parameter @var{n} gives the number of dummy +## @var{x}(@var{i}) used for initialization, i.e., a sequence of length +## @var{t}+@var{n} is generated and @var{x}(@var{n}+1:@var{t}+@var{n}) +## is returned. If @var{n} is omitted, @var{n} = 100 is used. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Simulate an ARMA process @@ -43,7 +50,7 @@ error ("arma_rnd: n must be a scalar"); endif else - usage ("arma_rnd (a, b, v, t [, n])"); + usage ("arma_rnd (a, b, v, t, n)"); endif if ( (min (size (a)) > 1) || (min (size (b)) > 1) )
--- a/scripts/signal/autocor.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/autocor.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: autocor (X [, h]) -## -## returns the autocorrelations from lag 0 to h of vector X. -## If h is omitted, all autocorrelations are computed. -## If X is a matrix, the autocorrelations of every single column are +## -*- texinfo -*- +## @deftypefn {Function File} {} autocor (@var{x}, @var{h}) +## Return the autocorrelations from lag 0 to @var{h} of vector @var{x}. +## If @var{h} is omitted, all autocorrelations are computed. +## If @var{X} is a matrix, the autocorrelations of each column are ## computed. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Compute autocorrelations @@ -31,7 +32,7 @@ elseif (nargin == 2) retval = autocov (X, h); else - usage ("autocor (X [, h])"); + usage ("autocor (X, h)"); endif if (min (retval (1,:)) != 0)
--- a/scripts/signal/autocov.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/autocov.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: autocov (X [, h]) -## -## returns the autocovariances from lag 0 to h of vector X. -## If h is omitted, all autocovariances are computed. -## If X is a matrix, the autocovariances of every single column are +## -*- texinfo -*- +## @deftypefn {Function File} {} autocov (@var{x}, @var{h}) +## Return the autocovariances from lag 0 to @var{h} of vector @var{x}. +## If @var{h} is omitted, all autocovariances are computed. +## If @var{x} is a matrix, the autocovariances of each column are ## computed. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Compute autocovariances
--- a/scripts/signal/autoreg_matrix.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/autoreg_matrix.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,15 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: X = autoreg_matrix (y, k) -## -## Given a time series (vector) y, returns a matrix X with ones in the -## first column and the first k lagged values of y in the other columns. -## I.e., for t > k, [1, y(t-1), ..., y(t-k)] is the t-th row of X. X can -## be used as regressor matrix in autoregressions. +## -*- texinfo -*- +## @deftypefn {Function File} {} autoreg_matrix (@var{y}, @var{k}) +## Given a time series (vector) @var{y}, return a matrix with ones in the +## first column and the first @var{k} lagged values of @var{y} in the +## other columns. I.e., for @var{t} > @var{k}, @code{[1, +## @var{y}(@var{t}-1), ..., @var{y}(@var{t}-@var{k})]} is the t-th row +## of the result. The resulting matrix may be used as a regressor matrix +## in autoregressions. +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Design matrix for autoregressions
--- a/scripts/signal/bartlett.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/bartlett.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,13 +14,14 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: bartlett (m) -## -## Returns the filter coefficients of a Bartlett (triangular) window of -## length m. +## -*- texinfo -*- +## @deftypefn {Function File} {} bartlett (@var{m}) +## Return the filter coefficients of a Bartlett (triangular) window of +## length @var{m}. ## ## For a definition of the Bartlett window, see e.g. A. V. Oppenheim & ## R. W. Schafer, "Discrete-Time Signal Processing". +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Coefficients of the Bartlett (triangular) window
--- a/scripts/signal/blackman.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/blackman.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: blackman (m) -## -## Returns the filter coefficients of a Blackman window of length m. +## -*- texinfo -*- +## @deftypefn {Function File} {} blackman (@var{m}) +## Return the filter coefficients of a Blackman window of length @var{m}. ## ## For a definition of the Blackman window, see e.g. A. V. Oppenheim & ## R. W. Schafer, "Discrete-Time Signal Processing". +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Coefficients of the Blackman window
--- a/scripts/signal/detrend.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/detrend.m Tue Jan 18 04:09:14 2000 +0000 @@ -39,7 +39,7 @@ error ("detrend: p must be a nonnegative integer"); endif else - usage ("detrend (x [, p])"); + usage ("detrend (x, p)"); endif [m, n] = size (x);
--- a/scripts/signal/diffpara.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/diffpara.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,22 +14,26 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: [d, D] = diffpara (X [, a [, b]]) -## -## Returns the estimator d for the differencing parameter of an +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{d}, @var{D}]} = diffpara (@var{x}, @var{a}, @var{b}) +## Return the estimator @var{d} for the differencing parameter of an ## integrated time series. ## -## The frequencies from [2*pi*a/T, 2*pi*b/T] are used for the -## estimation. If b is omitted, the interval [2*pi/T, 2*pi*a/T] is used, -## if both b and a are omitted then a = 0.5 * sqrt(T) and b = 1.5 * -## sqrt(T) is used, where T is the sample size. If X is a matrix, the -## differencing parameter of every single column is estimated. +## The frequencies from @code{[2*pi*@var{a}/@var{T}, +## 2*pi*@var{b}/@var{T}]} are used for the estimation. If @var{b} is +## omitted, the interval @code{[2*pi/@var{T}, 2*pi*@var{a}/@var{T}]} is +## used. If both @var{b} and @var{a} are omitted then @code{@var{a} = +## 0.5 * sqrt(@var{T})} and @code{@var{b} = 1.5 * sqrt(@var{T})} is +## used, where @var{T} is the sample size. If @var{x} is a matrix, the +## differencing parameter of each column is estimated. ## -## D contains the estimators for all frequencies in the intervals -## described above, d is simply mean(D). +## The estimators for all frequencies in the intervals +## described above is returned in @var{D}. The value of @var{d} is +## simply the mean of @var{D}. ## ## Reference: Brockwell, Peter J. & Davis, Richard A. Time Series: -## Theory and Methods Springer 1987 +## Theory and Methods Springer 1987. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Estimate the fractional differencing parameter @@ -37,7 +41,7 @@ function [d, D] = diffpara (X, a, b) if ((nargin < 1) || (nargin > 3)) - usage ("[d [, D]] = diffpara (X [, a [, b]])"); + usage ("[d, D] = diffpara (X, a, b)"); else if is_vector (X) n = length (X);
--- a/scripts/signal/durbinlevinson.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/durbinlevinson.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,16 +14,18 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: durbinlevinson (c, [oldphi, oldv]) -## -## Performs one step of the Durbin-Levinson algorithm. +## -*- texinfo -*- +## @deftypefn {Function File} {} durbinlevinson (@var{c}, @var{oldphi}, @var{oldv}) +## Perform one step of the Durbin-Levinson algorithm. ## -## The vector c_t = [gamma_0, ..., gamma_t] contains the autocovariances -## from lag 0 to t, oldphi the coefficients based on c_(t-1) and oldv -## the corresponding error. +## The vector @var{c} specifies the autocovariances @code{[gamma_0, ..., +## gamma_t]} from lag 0 to @var{t}, @var{oldphi} specifies the +## coefficients based on @var{c}(@var{t}-1) and @var{oldv} specifies the +## corresponding error. ## -## If oldphi is omitted, all steps from 1 to t of the algorithm are -## performed. +## If @var{oldphi} and @var{oldv} are omitted, all steps from 1 to +## @var{t} of the algorithm are performed. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Perform one step of the Durbin-Levinson algorithm @@ -31,7 +33,7 @@ function [newphi, newv] = durbinlevinson (c, oldphi, oldv) if( !((nargin == 1) || (nargin == 3)) ) - usage ("durbinlevinson (c, [oldphi, oldv])"); + usage ("durbinlevinson (c, oldphi, oldv)"); endif if( columns (c) > 1 )
--- a/scripts/signal/fftconv.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/fftconv.m Tue Jan 18 04:09:14 2000 +0000 @@ -35,7 +35,7 @@ function c = fftconv (a, b, N) if (nargin < 2 || nargin > 3) - usage ("fftconv (b, x [, N])"); + usage ("fftconv (b, x, N)"); endif if (! (is_vector (a) && is_vector (b)))
--- a/scripts/signal/fftfilt.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/fftfilt.m Tue Jan 18 04:09:14 2000 +0000 @@ -40,7 +40,7 @@ ## one blocks, but if the user knows better ... if (nargin < 2 || nargin > 3) - usage (" fftfilt (b, x [, N])"); + usage (" fftfilt (b, x, N)"); endif [r_x, c_x] = size (x);
--- a/scripts/signal/fftshift.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/fftshift.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,18 +14,22 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: y = fftshift(W) -## -## Performs a shift of the vector V, for use with the "fft" and "ifft" -## functions, in order the move the frequency 0 to the centre of -## the vector or matrix. +## -*- texinfo -*- +## @deftypefn {Function File} {} fftshift (@var{v}) +## Perform a shift of the vector @var{v}, for use with the @code{fft} +## and @code{ifft} functions, in order the move the frequency 0 to the +## centre of the vector or matrix. ## -## If V is a vector of E datas corresponding to E time samples spaced -## of Dt each, then fftshift (fft (V)) correspond to frequencies +## If @var{v} is a vector of @var{E} elements corresponding to @var{E} +## time samples spaced of @var{Dt} each, then @code{fftshift (fft +## (@var{v}))} corresponds to frequencies ## -## f = linspace (-E/(4*DT), (E/2-1)/(2*DT), E) +## @example +## f = linspace (-@var{E}/(4*@var{Dt}), (@var{E}/2-1)/(2*@var{Dt}), @var{E}) +## @end example ## -## If V is a matrix, does the same holds for rows and columns. +## If @var{v} is a matrix, does the same holds for rows and columns. +## @end deftypefn ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp> ## Created: July 1997
--- a/scripts/signal/fractdiff.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/fractdiff.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: fractdiff(x, d) -## -## Computes the fractional differences (1-L)^d x where L denotes the -## lag-operator and d > -1. +## -*- texinfo -*- +## @deftypefn {Function File} {} fractdiff (@var{x}, @var{d}) +## Compute the fractional differences @code{(1-@var{L})^@var{d} * @var{x}} +## where @var{L} denotes the lag-operator and @var{d} is greater than -1. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Compute fractional differences
--- a/scripts/signal/hamming.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/hamming.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: hamming (m) -## -## Returns the filter coefficients of a Hamming window of length m. +## -*- texinfo -*- +## @deftypefn {Function File} {} hamming (@var{m}) +## Return the filter coefficients of a Hamming window of length @var{m}. ## ## For a definition of the Hamming window, see e.g. A. V. Oppenheim & ## R. W. Schafer, "Discrete-Time Signal Processing". +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Coefficients of the Hamming window
--- a/scripts/signal/hanning.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/hanning.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: hanning (m) -## -## Returns the filter coefficients of a Hanning window of length m. +## -*- texinfo -*- +## @deftypefn {Function File} {} hanning (@var{m}) +## Return the filter coefficients of a Hanning window of length @var{m}. ## ## For a definition of this window type, see e.g. A. V. Oppenheim & ## R. W. Schafer, "Discrete-Time Signal Processing". +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Coefficients of the Hanning window
--- a/scripts/signal/hurst.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/hurst.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,11 +14,12 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: H = hurst (x) -## -## Estimates the Hurst parameter of sample x via the rescaled range -## statistic. If x is a matrix, the parameter is estimated for every -## single column. +## -*- texinfo -*- +## @deftypefn {Function File} {} hurst (@var{x}) +## Estimate the Hurst parameter of sample @var{x} via the rescaled range +## statistic. If @var{x} is a matrix, the parameter is estimated for +## every single column. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Estimate the Hurst parameter
--- a/scripts/signal/periodogram.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/periodogram.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,9 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: periodogram (x) -## -## For a data matrix x from a sample of size n, return the periodogram. +## -*- texinfo -*- +## @deftypefn {Function File} {} periodogram (@var{x}) +## For a data matrix @var{x} from a sample of size @var{n}, return the +## periodogram. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Compute the periodogram
--- a/scripts/signal/rectangle_lw.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/rectangle_lw.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = rectangle_lw (n, b) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} rectangle_lw (@var{n}, @var{b}) ## Rectangular lag window. Subfunction used for spectral density ## estimation. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Rectangular lag window
--- a/scripts/signal/rectangle_sw.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/rectangle_sw.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = rectangle_sw (n, b) -## -## Rectangular spectral window. Subfunction used for spectral density +## -*- texinfo -*- +## @deftypefn {Function File} {} rectangle_sw (@var{n}, @var{b}) +## Rectangular spectral window. Subfunction used for spectral density ## estimation. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Rectangular spectral window
--- a/scripts/signal/sinetone.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/sinetone.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,13 +14,14 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: sinetone (freq [, rate [, sec [, ampl]]]) +## -*- texinfo -*- +## @deftypefn {Function File} {} sinetone (@var{freq}, @var{rate}, @var{sec}, @var{ampl}) +## Return a sinetone of frequency @var{freq} with length of @var{sec} +## seconds at sampling rate @var{rate} and with amplitude @var{ampl}. +## The arguments @var{freq} and @var{ampl} may be vectors of common size. ## -## Returns a sinetone of frequency freq with length of sec seconds at -## sampling rate rate and with amplitude ampl. freq and ampl may be -## vectors of common size. -## -## Defaults are rate = 8000, sec = 1 and ampl = 64. +## Defaults are @var{rate} = 8000, @var{sec} = 1 and @var{ampl} = 64. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Compute a sine tone @@ -37,7 +38,7 @@ elseif (nargin == 3) a = 64; elseif ((nargin < 1) || (nargin > 4)) - usage ("sinetone (freq [, rate [, sec [, ampl]]])"); + usage ("sinetone (freq, rate, sec, ampl)"); endif [err, f, a] = common_size (f, a);
--- a/scripts/signal/sinewave.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/sinewave.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: sinewave (m, n [, d]) +## -*- texinfo -*- +## @deftypefn {Function File} {} sinewave (@var{m}, @var{n}, @var{d}) +## Return an @var{m}-element vector with @var{i}-th element given by +## @code{sin (2 * pi * (@var{i}+@var{d}-1) / @var{n})}. ## -## Computes an (m x 1)-vector X with i-th element X(i) given by sin (2 * -## pi * (i+d-1) / n). -## -## The default value for d is 0. +## The default value for @var{d} is 0. +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Compute a sine wave @@ -29,7 +30,7 @@ if (nargin == 2) d = 0; elseif (nargin != 3) - usage ("sinewave (m, n [, d])"); + usage ("sinewave (m, n, d)"); endif x = sin ( ((1 : m) + d - 1) * 2 * pi / n);
--- a/scripts/signal/spectral_adf.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/spectral_adf.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,16 +14,18 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = spectral_adf (c, [win, [b]]) +## -*- texinfo -*- +## @deftypefn {Function File} {} spectral_adf (@var{c}, @var{win}, @var{b}) +## Return the spectral density estimator given a vector of +## autocovariances @var{c}, window name @var{win}, and bandwidth, +## @var{b}. ## -## Returns the spectral density estimator. -## c ....... vector of autocovariances (starting at lag 0) -## win ..... window name, eg. "triangle" or "rectangle" -## spectral_adf searches for a function called win_lw () -## b ....... bandwidth +## The window name, e.g., @code{"triangle"} or @code{"rectangle"} is +## used to search for a function called @code{@var{win}_sw}. ## -## If win is omitted, the triangle window is used as default. -## If b is omitted, 1 / sqrt( length (c)) is used as default. +## If @var{win} is omitted, the triangle window is used. If @var{b} is +## omitted, @code{1 / sqrt (length (@var{x}))} is used. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Spectral density estimation
--- a/scripts/signal/spectral_xdf.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/spectral_xdf.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,16 +14,17 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = spectral_xdf (X, [win, [b]]) +## -*- texinfo -*- +## @deftypefn {Function File} {} spectral_xdf (@var{x}, @var{win}, @var{b}) +## Return the spectral density estimator given a data vector @var{x}, +## window name @var{win}, and bandwidth, @var{b}. ## -## Returns the spectral density estimator. -## X ....... data vector -## win ..... window name, eg. "triangle" or "rectangle" -## spectral_adf searches for a function called win_sw () -## b ....... bandwidth +## The window name, e.g., @code{"triangle"} or @code{"rectangle"} is +## used to search for a function called @code{@var{win}_sw}. ## -## If win is omitted, the triangle window is used as default. -## If b is omitted, 1 / sqrt (length (X)) is used as default. +## If @var{win} is omitted, the triangle window is used. If @var{b} is +## omitted, @code{1 / sqrt (length (@var{x}))} is used. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Spectral density estimation
--- a/scripts/signal/spencer.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/spencer.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,9 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: spencer (X) -## -## returns Spencer's 15 point moving average of every single column of X +## -*- texinfo -*- +## @deftypefn {Function File} {} spencer (@var{x}) +## Return Spencer's 15 point moving average of every single column of +## @var{x}. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Apply Spencer's 15-point MA filter
--- a/scripts/signal/stft.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/stft.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,25 +14,39 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: [Y, c] = stft (X [, win_size [, inc [, num_coef [, w_type]]]]) -## -## Computes the short-term Fourier transform of the vector X with -## "num_coef" coefficients by applying a window of "win_size" data -## points and an increment of "inc" points. +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{y}, @var{c}]} = stft (@var{x}, @var{win_size}, @var{inc}, @var{num_coef}, @var{w_type}) +## Compute the short-term Fourier transform of the vector @var{x} with +## @var{num_coef} coefficients by applying a window of @var{win_size} data +## points and an increment of @var{inc} points. ## ## Before computing the Fourier transform, one of the following windows -## is applied: "hanning" (w_type = 1), "hamming" (w_type = 2), -## "rectangle" (w_type = 3). The window names can be passed as strings -## or by the w_type number. +## is applied: +## +## @table @asis +## @item hanning +## w_type = 1 +## @item hamming +## w_type = 2 +## @item rectangle +## w_type = 3 +## @end table +## +## The window names can be passed as strings or by the @var{w_type} number. ## ## If not all arguments are specified, the following defaults are used: -## win_size = 80, inc = 24, num_coef = 64, w_type = 1. +## @var{win_size} = 80, @var{inc} = 24, @var{num_coef} = 64, and +## @var{w_type} = 1. ## -## Y = stft (X [, ...]) returns the absolute values of the Fourier -## coefficients according to the num_coef positive frequencies. -## [Y, c] = stft (X [, ...]) returns the entire STFT-matrix Y and a -## vector c = [win_size, inc, w_type] which is needed by the synthesis -## function. +## @code{@var{y} = stft (@var{x}, @dots{})} returns the absolute values +## of the Fourier coefficients according to the @var{num_coef} positive +## frequencies. +## +## @code{[@var{y}, @var{c}] = stft (@code{x}, @dots{})} returns the +## entire STFT-matrix @var{y} and a 3-element vector @var{c} containing +## the window size, increment, and window type, which is needed by the +## synthesis function. +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Short-term Fourier transform @@ -64,8 +78,7 @@ endif endif else - usage ("[Y [, c]] = ", ... - "stft(X [, win_size [, inc [, num_coef [, w_type]]]])"); + usage ("[Y, c] = stft(X, win_size, inc, num_coef, w_type)"); endif ## check whether X is a vector
--- a/scripts/signal/synthesis.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/synthesis.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,18 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: X = synthesis (Y, c) +## -*- texinfo -*- +## @deftypefn {Function File} {@var{x} =} 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. ## -## recovers a signal X from its short-time Fourier transform Y. c = -## [win_size, increment, window_type]. +## The values @var{y} and @var{c} can be derived by ## -## Y and c can be derived by [Y, c] = stft (X [, ...]). +## @example +## [@var{y}, @var{c}] = stft (@var{x} , @dots{}) +## @end example +## @end deftypefn ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Description: Recover a signal from its short-term Fourier transform
--- a/scripts/signal/triangle_lw.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/triangle_lw.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = triangle_lw (n, b) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} triangle_lw (@var{n}, @var{b}) ## Triangular lag window. Subfunction used for spectral density ## estimation. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Triangular lag window
--- a/scripts/signal/triangle_sw.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/triangle_sw.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,10 +14,11 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: retval = triangle_sw (n, b) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} triangle_sw (@var{n}, @var{b}) ## Triangular spectral window. Subfunction used for spectral density ## estimation. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Triangular spectral window
--- a/scripts/signal/yulewalker.m Mon Jan 17 20:38:35 2000 +0000 +++ b/scripts/signal/yulewalker.m Tue Jan 18 04:09:14 2000 +0000 @@ -14,12 +14,14 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: [a, v] = yulewalker (c) +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{a}, @var{v}] =} yulewalker (@var{c}) +## Fit an AR (p)-model with Yule-Walker estimates given a vector @var{c} +## of autocovariances @code{[gamma_0, ..., gamma_p]}. ## -## fits an AR (p)-model with Yule-Walker estimates. -## c = [gamma_0, ..., gamma_p] autocovariances -## a .... AR coefficients -## v .... variance of white noise +## Returns the AR coefficients, @var{a}, and the variance of white +## noise, @var{v}. +## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> ## Description: Fit AR model by Yule-Walker method