Mercurial > forge
changeset 3314:897d3062fe73 octave-forge
added and/or changed in octave.org-cvs
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/__bar__ Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,5 @@ +-*- texinfo -*- +@deftypefn {Function File} {} __bar__ (@dots{}) +Support function for @ode{bar} and {hbar}. +@seealso{bar, hbar} +@end deftypefn
--- a/language/base/help/octave/__errplot__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__errplot__ Sun Apr 22 21:37:46 2007 +0000 @@ -7,5 +7,5 @@ @end example @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, -bar, stairs, errorbar, replot, xlabel, ylabel, title} +bar, stairs, errorbar, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/__gnuplot_version__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__gnuplot_version__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,16 +1,6 @@ -Copyright (C) 2006 Daniel Sebald - -Octave is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -Octave is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with Octave; see the file COPYING. If not, write to the Free -Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02110-1301, USA. +-*- texinfo -*- +@deftypefn {Function File} {@var{version} =} __gnuplot_version__ (@var{gplt_exe}) +Return the version of gnuplot we are using. Note that we do not +attempt to handle the case of the user switching to different +versions of gnuplot during the same session. +@end deftypefn
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/__go_close_all__ Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,5 @@ +-*- texinfo -*- +@deftypefn {Function File} {} __go_close_all__ () +Internal function to close all figures. +@seealso{drawnow} +@end deftypefn
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/__go_draw_axes__ Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,4 @@ +-*- texinfo -*- +@deftypefn {Function File} {} __go_draw_axes__ (@var{axis_obj}, @var{plot_stream}) +Display the axes @var{axis_obj} on @var{plot_stream}. +@end deftypefn
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/__go_draw_figure__ Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,4 @@ +-*- texinfo -*- +@deftypefn {Function File} {} __go_draw_figure__ (f) +Display the figure @var{f}. +@end deftypefn
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/__line__ Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,6 @@ +-*- texinfo -*- +@deftypefn {Function File} {} __line__ (@var{p}, @var{x}, @var{y}) +@deftypefnx {Function File} {} line (@var{p}, @var{x}, @var{y}, @var{z}) +Create line object from @var{x} and @var{y} with parent @var{p}. +Return handle to line object. +@end deftypefn
--- a/language/base/help/octave/__plt1__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt1__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt1__ (@var{h}, @var{x1}, @var{fmt}, @var{key}) +@deftypefn {Function File} {} __plt1__ (@var{h}, @var{x1}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2__ (@var{h}, @var{x1}, @var{x2}, @var{options}) +@deftypefn {Function File} {} __plt2__ (@var{h}, @var{x1}, @var{x2}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2mm__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2mm__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2mm__ (@var{h}, @var{x}, @var{y}, @var{options}) +@deftypefn {Function File} {} __plt2mm__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2mv__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2mv__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2mv__ (@var{h}, @var{x}, @var{y}, @var{options}) +@deftypefn {Function File} {} __plt2mv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2ss__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2ss__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2ss__ (@var{h}, @var{x}, @var{y}, @var{options}) +@deftypefn {Function File} {} __plt2ss__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2vm__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2vm__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2vm__ (@var{h}, @var{x}, @var{y}, @var{options}) +@deftypefn {Function File} {} __plt2vm__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) @end deftypefn
--- a/language/base/help/octave/__plt2vv__ Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/__plt2vv__ Sun Apr 22 21:37:46 2007 +0000 @@ -1,3 +1,3 @@ -*- texinfo -*- -@deftypefn {Function File} {} __plt2vv__ (@var{h}, @var{x}, @var{y}, @var{options}) +@deftypefn {Function File} {} __plt2vv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties}) @end deftypefn
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/arrayfun Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,13 @@ +-*- texinfo -*- +@deftypefn {Command} {@var{a} =} arrayfun (@var{name}, @var{c}) +@deftypefnx {Command} {@var{a} =} arrayfun (@var{func}, @var{c}) +@deftypefnx {Command} {@var{a} =} arrayfun (@var{func}, @var{c}, @var{d}) +@deftypefnx {Command} {@var{a} =} arrayfun (@var{func}, @var{c}, @var{options}) +@deftypefnx {Command} {[@var{a}, @var{b}, @dots{}] =} arrayfun (@var{func}, @var{c}, @dots{}) +Execute a function on each element of an array. This is useful for +functions that do not accept array arguments. If the function does +accept array arguments it is better to call the function directly. + +See @code{cellfun} for complete usage instructions. +@seealso{cellfun} +@end deftypefn
--- a/language/base/help/octave/autoreg_matrix Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/autoreg_matrix Sun Apr 22 21:37:46 2007 +0000 @@ -3,7 +3,7 @@ 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 +@var{y}(@var{t}-1), @dots{}, @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
--- a/language/base/help/octave/bar Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/bar Sun Apr 22 21:37:46 2007 +0000 @@ -1,10 +1,16 @@ -*- texinfo -*- -@deftypefn {Function File} {} bar (@var{x}, @var{y}) +@deftypefn {Function File} {@var{h} =} bar (@var{x}, @var{y}, @var{style}) +@deftypefnx {Function File} {[@var{xb}, @var{yb}] =} bar (@dots{}) Given two vectors of x-y data, @code{bar} produces a bar graph. If only one argument is given, it is taken as a vector of y-values and the x coordinates are taken to be the indices of the elements. +If @var{y} is a matrix, then each column of @var{y} is taken to be a +separate bar graph plotted on the same graph. By default the columns +are plotted side-by-side. This behavior can be changed by the @var{style} +argument, which can take the values 'group' (the default), or 'stack'. + If two output arguments are specified, the data are generated but not plotted. For example, @@ -22,6 +28,6 @@ @noindent are equivalent. -@seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -stairs, replot, xlabel, ylabel, title} +@seealso{hbar, plot, semilogx, semilogy, loglog, polar, mesh, contour, +stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/bitcmp Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/bitcmp Sun Apr 22 21:37:46 2007 +0000 @@ -1,15 +1,15 @@ -*- texinfo -*- -@deftypefn {Function File} {@var{X} =} bitcmp (@var{a},@var{k}) +@deftypefn {Function File} {} bitcmp (@var{a}, @var{k}) Return the @var{k}-bit complement of integers in @var{a}. If -@var{k} is omitted @code{k = log2(bitmax) + 1} is assumed. +@var{k} is omitted @code{k = log2 (bitmax) + 1} is assumed. @example bitcmp(7,4) @result{} 8 dec2bin(11) @result{} 1011 -dec2bin(bitcmp(11)) -@result{} 11111111111111111111111111110100 +dec2bin(bitcmp(11, 6)) +@result{} 110100 @end example @seealso{bitand, bitor, bitxor, bitset, bitget, bitcmp, bitshift, bitmax} @end deftypefn
--- a/language/base/help/octave/circshift Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/circshift Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {@var{y}} = circshift (@var{x}, @var{n}) +@deftypefn {Function File} {@var{y} =} circshift (@var{x}, @var{n}) Circularly shifts the values of the array @var{x}. @var{n} must be a vector of integers no longer than the number of dimensions in @var{x}. The values of @var{n} can be either positive or negative,
--- a/language/base/help/octave/common_size Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/common_size Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{err}, @var{y1}, ...] =} common_size (@var{x1}, ...) +@deftypefn {Function File} {[@var{err}, @var{y1}, @dots{}] =} common_size (@var{x1}, @dots{}) Determine if all input arguments are either scalar or of common size. If so, @var{err} is zero, and @var{yi} is a matrix of the common size with all entries equal to @var{xi} if this is a scalar or
--- a/language/base/help/octave/contour Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/contour Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} {@var{c}} = contour (@var{x},@var{y},@var{z},@var{vv}) +@deftypefn {Function File} {} {@var{c} =} contour (@var{x}, @var{y}, @var{z}, @var{vv}) Compute isolines (countour lines) of the matrix @var{z}. parameters @var{x}, @var{y} and @var{vn} are optional. @@ -7,8 +7,8 @@ contour lines in the following format @example -@var{c} = [lev1 , x1 , x2 , ... , levn , x1 , x2 , ... - len1 , y1 , y2 , ... , lenn , y1 , y2 , ... ] +@var{c} = [lev1, x1, x2, ..., levn, x1, x2, ... + len1, y1, y2, ..., lenn, y1, y2, ...] @end example @noindent @@ -22,7 +22,8 @@ @var{vn} is omitted it defaults to 10. @example -@var{c}=contourc (@var{x}, @var{y}, @var{z}, linspace(0,2*pi,10)) +levels = linspace (0, 2*pi, 10); +@var{c} = contourc (@var{x}, @var{y}, @var{z}, levels); @end example -@seealso{contourc,line,plot} +@seealso{contourc, line, plot} @end deftypefn
--- a/language/base/help/octave/contourc Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/contourc Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} [@var{c}, @var{lev}] = contourc (@var{x}, @var{y}, @var{z}, @var{vv}) +@deftypefn {Function File} {[@var{c}, @var{lev}] =} contourc (@var{x}, @var{y}, @var{z}, @var{vv}) Compute isolines (countour lines) of the matrix @var{z}. Parameters @var{x}, @var{y} and @var{vn} are optional. @@ -8,8 +8,8 @@ contour lines in the following format @example -@var{c} = [lev1 , x1 , x2 , ... , levn , x1 , x2 , ... - len1 , y1 , y2 , ... , lenn , y1 , y2 , ... ] +@var{c} = [lev1, x1, x2, ..., levn, x1, x2, ... + len1, y1, y2, ..., lenn, y1, y2, ...] @end example @noindent @@ -23,7 +23,7 @@ If @var{vn} is omitted it defaults to 10. @example -@var{c}=contourc (@var{x}, @var{y}, @var{z}, linspace(0,2*pi,10)) +c = contourc (x, y, z, linspace (0, 2*pi, 10)); @end example @seealso{contour} @end deftypefn
--- a/language/base/help/octave/datestr Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/datestr Sun Apr 22 21:37:46 2007 +0000 @@ -2,8 +2,8 @@ @deftypefn {Function File} {@var{str} =} datestr (@var{date}, [@var{f}, [@var{p}]]) Format the given date/time according to the format @code{f} and return the result in @var{str}. @var{date} is a serial date number (see -@code{datenum}) or a date vector (see @code{datevec}). For compatibility -with Matlab, @var{date} may also be a string or cell array of strings. +@code{datenum}) or a date vector (see @code{datevec}). The value of +@var{date} may also be a string or cell array of strings. @var{f} can be an integer which corresponds to one of the codes in the table below, or a date format string.
--- a/language/base/help/octave/diffpara Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/diffpara Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{d}, @var{dd}]} = diffpara (@var{x}, @var{a}, @var{b}) +@deftypefn {Function File} {[@var{d}, @var{dd}] =} diffpara (@var{x}, @var{a}, @var{b}) Return the estimator @var{d} for the differencing parameter of an integrated time series.
--- a/language/base/help/octave/dmr2d Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/dmr2d Sun Apr 22 21:37:46 2007 +0000 @@ -36,9 +36,9 @@ The sampling time of sys is updated to @var{ts2}. if @var{cuflg}=0 then a set of additional inputs is added to -the system with suffixes _d1, ..., _dn to indicate their +the system with suffixes _d1, @dots{}, _dn to indicate their delay from the starting time k @var{ts2}, i.e. -u = [u_1; u_1_d1; ..., u_1_dn] where u_1_dk is the input +u = [u_1; u_1_d1; @dots{}, u_1_dn] where u_1_dk is the input k*ts1 units of time after u_1 is sampled. (@var{ts1} is the original sampling time of the discrete time system and @var{ts2} = (n+1)*ts1)
--- a/language/base/help/octave/durbinlevinson Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/durbinlevinson Sun Apr 22 21:37:46 2007 +0000 @@ -2,7 +2,7 @@ @deftypefn {Function File} {} durbinlevinson (@var{c}, @var{oldphi}, @var{oldv}) Perform one step of the Durbin-Levinson algorithm. -The vector @var{c} specifies the autocovariances @code{[gamma_0, ..., +The vector @var{c} specifies the autocovariances @code{[gamma_0, @dots{}, 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.
--- a/language/base/help/octave/errorbar Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/errorbar Sun Apr 22 21:37:46 2007 +0000 @@ -16,7 +16,7 @@ If more than two arguments are given, they are interpreted as @example -errorbar (@var{x}, @var{y}, ..., @var{fmt} ...) +errorbar (@var{x}, @var{y}, ..., @var{fmt}, ...) @end example @noindent @@ -83,5 +83,5 @@ are drawn from @var{x}-@var{lx} to @var{x}+@var{ux} and @var{y} errorbars from @var{y}-@var{ly} to @var{y}+@var{uy}. @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__, -bar, stairs, replot, xlabel, ylabel, title} +bar, stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/filter2 Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/filter2 Sun Apr 22 21:37:46 2007 +0000 @@ -1,6 +1,6 @@ -*- texinfo -*- @deftypefn {Function File} {@var{y} =} filter2 (@var{b, @var{x}}) -@deftypefnx {Function File} {@var{y} =} filter2 (@var{b, @var{x}}, @var{shape}) +@deftypefnx {Function File} {@var{y} =} filter2 (@var{b}, @var{x}, @var{shape}) Apply the 2-D FIR filter @var{b} to @var{x}. If the argument @var{shape} is specified, return an array of the desired shape. Possible values are:
--- a/language/base/help/octave/fir2sys Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/fir2sys Sun Apr 22 21:37:46 2007 +0000 @@ -7,7 +7,7 @@ @item num vector of coefficients @ifinfo -[c0, c1, ..., cn] +[c0, c1, @dots{}, cn] @end ifinfo @iftex @tex @@ -16,7 +16,7 @@ @end iftex of the @acronym{SISO} @acronym{FIR} transfer function @ifinfo -C(z) = c0 + c1*z^(-1) + c2*z^(-2) + ... + cn*z^(-n) +C(z) = c0 + c1*z^(-1) + c2*z^(-2) + @dots{} + cn*z^(-n) @end ifinfo @iftex @tex
--- a/language/base/help/octave/flops Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/flops Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- @deftypefn {Function File} {} flops () -This function is provided for Matlab compatibility, but it doesn't +This function is provided for @sc{Matlab} compatibility, but it doesn't actually do anything. @end deftypefn
--- a/language/base/help/octave/getfield Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/getfield Sun Apr 22 21:37:46 2007 +0000 @@ -1,21 +1,21 @@ -*- texinfo -*- -@deftypefn {Built-in Function} {} [@var{v1},...] = -@code{getfield (@var{s}, 'k1',...)} extract fields from a structure. +@deftypefn {Built-in Function} {[@var{v1}, @dots{}] =} getfield (@var{s}, @var{key}, @dots{}) extract fields from a structure. For example @example @group ss(1,2).fd(3).b=5; -getfield(ss,@{1,2@},'fd',@{3@},'b') +getfield (ss, @{1,2@}, "fd", @{3@}, "b") @result{} ans = 5 @end group @end example -Note that this function could be written as +Note that the function call in the previous example is equivalent to +the expression @example - i1= @{1,2@}; i2= 'fd'; i3= @{3@}; i4= 'b'; - ss( i1@{:@} ).( i2 )( i3@{:@} ).( i4 ) + i1= @{1,2@}; i2= "fd"; i3= @{3@}; i4= "b"; + ss(i1@{:@}).(i2)(i3@{:@}).(i4) @end example @seealso{setfield, rmfield, isfield, isstruct, fieldnames, struct} @end deftypefn
--- a/language/base/help/octave/glpkmex Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/glpkmex Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{xopt}, @var{fmin}, @var{status}, @var{extra}] =} glpk (@var{sense}, @var{c}, @var{a}, @var{b}, @var{ctype}, @var{lb}, @var{ub}, @var{vartype}, @var{param}, @var{lpsolver}, @var{save_pb}) +@deftypefn {Function File} {[@var{xopt}, @var{fmin}, @var{status}, @var{extra}] =} glpkmex (@var{sense}, @var{c}, @var{a}, @var{b}, @var{ctype}, @var{lb}, @var{ub}, @var{vartype}, @var{param}, @var{lpsolver}, @var{save_pb}) This function is provided for compatibility with the old @sc{Matlab} interface to the GNU GLPK library. For Octave code, you should use the @code{glpk} function instead.
--- a/language/base/help/octave/grid Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/grid Sun Apr 22 21:37:46 2007 +0000 @@ -10,5 +10,5 @@ be either @code{"on"} or @code{"off"} to explicitly set the state of the minor grid. @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -bar, stairs, replot, xlabel, ylabel, title} +bar, stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/hadamard Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/hadamard Sun Apr 22 21:37:46 2007 +0000 @@ -1,10 +1,9 @@ -*- texinfo -*- @deftypefn {Function File} {} hadamard (@var{n}) - Construct a Hadamard matrix @var{Hn} of size @var{n}-by-@var{n}. The -size @var{n} must be of the form @code{2 ^ @var{k} * @var{p}} where +size @var{n} must be of the form @code{2 ^ @var{k} * @var{p}} in which @var{p} is one of 1, 12, 20 or 28. The returned matrix is normalized, -meaning @var{Hn (:, 1) == 1} and @var{H (1, :) == 1}. +meaning @code{Hn(:,1) == 1} and @code{H(1,:) == 1}. Some of the properties of Hadamard matrices are:
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/language/base/help/octave/hbar Sun Apr 22 21:37:46 2007 +0000 @@ -0,0 +1,33 @@ +-*- texinfo -*- +@deftypefn {Function File} {@var{h} =} hbar (@var{x}, @var{y}, @var{style}) +@deftypefnx {Function File} {[@var{xb}, @var{yb}] =} hbar (@dots{}) +Given two vectors of x-y data, @code{bar} produces a horizontal bar graph. + +If only one argument is given, it is taken as a vector of y-values +and the x coordinates are taken to be the indices of the elements. + +If @var{y} is a matrix, then each column of @var{y} is taken to be a +separate bar graph plotted on the same graph. By default the columns +are plotted side-by-side. This behavior can be changed by the @var{style} +argument, which can take the values 'group' (the default), or 'stack'. + +If two output arguments are specified, the data are generated but +not plotted. For example, + +@example +hbar (x, y); +@end example + +@noindent +and + +@example +[xb, yb] = hbar (x, y); +plot (xb, yb); +@end example + +@noindent +are equivalent. +@seealso{bar, plot, semilogx, semilogy, loglog, polar, mesh, contour, +stairs, xlabel, ylabel, title} +@end deftypefn
--- a/language/base/help/octave/hsv2rgb Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/hsv2rgb Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} @var{rgb_map} = hsv2rgb (@var{hsv_map}) +@deftypefn {Function File} {@var{rgb_map} =} hsv2rgb (@var{hsv_map}) Transform a colormap from the hsv space to the rgb space. @seealso{rgb2hsv} @end deftypefn
--- a/language/base/help/octave/ifftshift Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/ifftshift Sun Apr 22 21:37:46 2007 +0000 @@ -1,16 +1,7 @@ -Copyright (C) 1997 by Vincent Cautaerts - -Octave is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -Octave is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with Octave; see the file COPYING. If not, write to the Free -Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -02110-1301, USA. +-*- texinfo -*- +@deftypefn {Function File} {} ifftshift (@var{v}) +@deftypefnx {Function File} {} ifftshift (@var{v}, @var{dim}) +Undo the action of the @code{fftshift} function. For even length +@var{v}, @code{fftshift} is its own inverse, but odd lengths differ +slightly. +@end deftypefn
--- a/language/base/help/octave/image Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/image Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,17 @@ -*- texinfo -*- -@deftypefn {Mapping Function} {} imag (@var{z}) -Return the imaginary part of @var{z} as a real number. -@seealso{real, conj} +@deftypefn {Function File} {} image (@var{img}) +@deftypefnx {Function File} {} image (@var{x}, @var{y}, @var{img}) +Display a matrix as a color image. The elements of @var{x} are indices +into the current colormap and should have values between 1 and the +length of the colormap. + +It first tries to use @code{gnuplot}, then @code{display} from +@code{ImageMagick}, then @code{xv}, and then @code{xloadimage}. +The actual program used can be changed using the @code{image_viewer} +function. + +The axis values corresponding to the matrix elements are specified in +@var{x} and @var{y}. If you're not using gnuplot 4.2 or later, these +variables are ignored. +@seealso{imshow, imagesc, colormap, image_viewer} @end deftypefn
--- a/language/base/help/octave/int2str Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/int2str Sun Apr 22 21:37:46 2007 +0000 @@ -2,8 +2,8 @@ @deftypefn {Function File} {} int2str (@var{n}) @deftypefnx {Function File} {} num2str (@var{x}, @var{precision}) @deftypefnx {Function File} {} num2str (@var{x}, @var{format}) -Convert a number to a string. These functions are not very flexible, -but are provided for compatibility with @sc{Matlab}. For better control -over the results, use @code{sprintf} (@pxref{Formatted Output}). +Convert a number to a string. This function is not very flexible. +For better control over the results, use @code{sprintf} +(@pxref{Formatted Output}). @seealso{sprintf, num2str} @end deftypefn
--- a/language/base/help/octave/lcm Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/lcm Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Mapping Function} {} lcm (@var{x}, @code{...}) +@deftypefn {Mapping Function} {} lcm (@var{x}, @dots{}) Compute the least common multiple of the elements elements of @var{x}, or the list of all the arguments. For example,
--- a/language/base/help/octave/legend Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/legend Sun Apr 22 21:37:46 2007 +0000 @@ -1,12 +1,50 @@ -Copyright (C) 2001 Laurent Mazet -Copyright (C) 2006 John W. Eaton +-*- texinfo -*- +@deftypefn {Function File} {} legend (@var{st1}, @var{st2}, @dots{}) +@deftypefnx {Function File} {} legend (@var{st1}, @var{st2}, @dots{}, @var{pos}) +@deftypefnx {Function File} {} legend (@var{matstr}) +@deftypefnx {Function File} {} legend (@var{matstr}, @var{pos}) +@deftypefnx {Function File} {} legend (@var{cell}) +@deftypefnx {Function File} {} legend (@var{cell}, @var{pos}) +@deftypefnx {Function File} {} legend ('@var{func}') + +Legend puts a legend on the current plot using the specified strings +as labels. Use independant strings (@var{st1}, @var{st2}, @dots{}), a +matrix of strings (@var{matstr}), or a cell array of strings (@var{cell}) to +specify legends. Legend works on line graphs, bar graphs, etc. +Be sure to call plot before calling legend. + +@var{pos} optionally places the legend in the specified location: -This program is free software; it is distributed in the hope that it -will be useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See -the GNU General Public License for more details. +@multitable @columnfractions 0.1 0.1 0.8 +@item @tab -1 @tab + To the top right of the plot +@item @tab 0 @tab + Don't move the legend box (default) +@item @tab 1 @tab + Upper right-hand corner +@item @tab 2 @tab + Upper left-hand corner +@item @tab 3 @tab + Lower left-hand corner +@item @tab 4 @tab + Lower right-hand corner +@end multitable + +Some specific functions are directely avaliable using @var{func}: -You should have received a copy of the GNU General Public License -along with this file; see the file COPYING. If not, write to the -Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02110-1301, USA. +@table @code +@item show + Show legends from the plot +@item hide +@itemx off + Hide legends from the plot +@item boxon + Draw a box around legends +@item boxoff + Withdraw the box around legends +@item left + Text is to the left of the keys +@item right + Text is to the right of the keys +@end table +@end deftypefn
--- a/language/base/help/octave/license Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/license Sun Apr 22 21:37:46 2007 +0000 @@ -5,10 +5,10 @@ @deftypefnx {Function File} {} license ("inuse") Display a list of packages currently being used. -@deftypefnx {Function File} {@var{retval}} = license ("inuse") +@deftypefnx {Function File} {@var{retval} =} license ("inuse") Return a structure containing the fields @code{feature} and @code{user}. -@deftypefnx {Function File} {@var{retval}} = license ("test", @var{feature}) +@deftypefnx {Function File} {@var{retval} =} license ("test", @var{feature}) Return 1 if a license exists for the product identified by the string @var{feature} and 0 otherwise. The argument @var{feature} is case insensitive and only the first 27 characters are checked. @@ -25,7 +25,7 @@ Future tests for the specified license of @var{feature} return 0. @end table -@deftypefnx {Function File} {@var{retval}} = license ("checkout", @var{feature}) +@deftypefnx {Function File} {@var{retval} =} license ("checkout", @var{feature}) Check out a license for @var{feature}, returning 1 on success and 0 on failure.
--- a/language/base/help/octave/line Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/line Sun Apr 22 21:37:46 2007 +0000 @@ -1,6 +1,8 @@ -*- texinfo -*- -@deftypefn {Function File} {} line (@var{x}, @var{y}) +@deftypefn {Function File} {} line () +@deftypefnx {Function File} {} line (@var{x}, @var{y}) @deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z}) +@deftypefnx {Function File} {} line (@var{x}, @var{y}, @var{z}, @var{opts}) Create line object from @var{x} and @var{y} and insert in current axes object. Return handle to line object. @end deftypefn
--- a/language/base/help/octave/loglog Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/loglog Sun Apr 22 21:37:46 2007 +0000 @@ -4,5 +4,5 @@ description of @code{plot} for a description of the arguments that @code{loglog} will accept. @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -replot, xlabel, ylabel, title} +xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/loglogerr Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/loglogerr Sun Apr 22 21:37:46 2007 +0000 @@ -14,5 +14,5 @@ format defined by @var{fmt}. See errorbar for available formats and additional information. @seealso{errorbar, semilogxerr, semilogyerr, polar, mesh, contour, -__pltopt__, bar, stairs, replot, xlabel, ylabel, title} +__pltopt__, bar, stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/meshdom Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/meshdom Sun Apr 22 21:37:46 2007 +0000 @@ -1,8 +1,4 @@ -*- texinfo -*- @deftypefn {Function File} {} meshdom (@var{x}, @var{y}) -Given vectors of @var{x} and @var{y} coordinates, return two matrices -corresponding to the @var{x} and @var{y} coordinates of the mesh. - -Note: this function is provided for compatibility with older versions -of @sc{Matlab}. You should use @code{meshgrid} instead. +This function has been deprecated. Use @code{meshgrid} instead. @end deftypefn
--- a/language/base/help/octave/mex Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/mex Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} mex [options] file ... +@deftypefn {Function File} {} mex [options] file @dots{} Compile source code written in C, C++, or Fortran, to a MEX file. This is equivalent to @code{mkoctfile --mex [options] file}. @seealso{mkoctfile}
--- a/language/base/help/octave/mkoctfile Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/mkoctfile Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} mkoctfile [-options] file ... +@deftypefn {Function File} {} mkoctfile [-options] file @dots{} The @code{mkoctfile} function compiles source code written in C, C++, or Fortran. Depending on the options used with @code{mkoctfile}, the
--- a/language/base/help/octave/ndgrid Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/ndgrid Sun Apr 22 21:37:46 2007 +0000 @@ -1,12 +1,12 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{y1}, @var{y2}, ..., @var{y}n]} = ndgrid (@var{x1}, @var{x2}, ..., @var{x}n) -@deftypefnx {Function File} {[@var{y1}, @var{y2}, ..., @var{y}n]} = ndgrid (@var{x}) -Given n vectors @var{x1}, ... @var{x}n, ndgrid returns n arrays of dimension n. +@deftypefn {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x1}, @var{x2}, @dots{}, @var{x}n) +@deftypefnx {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x}) +Given n vectors @var{x1}, @dots{} @var{x}n, ndgrid returns n arrays of dimension n. The elements of the ith output argument contains the elements of the vector @var{x}i repeated over all dimensions different from the ith dimension. Calling ndgrid with only one input argument @var{x} is equivalent of calling ndgrid with all n input arguments equal to @var{x}: -[@var{y1}, @var{y2}, ..., @var{y}n] = ndgrid (@var{x}, ..., @var{x}) +[@var{y1}, @var{y2}, @dots{}, @var{y}n] = ndgrid (@var{x}, @dots{}, @var{x}) @seealso{meshgrid} @end deftypefn
--- a/language/base/help/octave/nichols Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/nichols Sun Apr 22 21:37:46 2007 +0000 @@ -49,7 +49,7 @@ @end table If no output arguments are given, @command{nichols} plots the results to the screen. Descriptive labels are automatically placed. See @command{xlabel}, -@command{ylabel}, @command{title}, and @command{replot}. +@command{ylabel}, and @command{title}. Note: if the requested plot is for an @acronym{MIMO} system, @var{mag} is set to @iftex
--- a/language/base/help/octave/num2str Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/num2str Sun Apr 22 21:37:46 2007 +0000 @@ -2,8 +2,8 @@ @deftypefn {Function File} {} num2str (@var{n}) @deftypefnx {Function File} {} num2str (@var{x}, @var{precision}) @deftypefnx {Function File} {} num2str (@var{x}, @var{format}) -Convert a number to a string. These functions are not very flexible, -but are provided for compatibility with @sc{Matlab}. For better control -over the results, use @code{sprintf} (@pxref{Formatted Output}). +Convert a number to a string. This function is not very flexible. +For better control over the results, use @code{sprintf} +(@pxref{Formatted Output}). @seealso{sprintf, int2str} @end deftypefn
--- a/language/base/help/octave/pack Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/pack Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- @deftypefn {Function File} {} pack () -This function is provided for compatibility with Matlab, but it +This function is provided for compatibility with @sc{Matlab}, but it doesn't actually do anything. @end deftypefn
--- a/language/base/help/octave/pcg Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/pcg Sun Apr 22 21:37:46 2007 +0000 @@ -75,7 +75,8 @@ @code{@var{resvec} (i,1)} is the Euclidean norm of the residual, and @code{@var{resvec} (i,2)} is the preconditioned residual norm, after the (@var{i}-1)-th iteration, @code{@var{i} = -1,2,...@var{iter}+1}. The preconditioned residual norm is defined as +1, 2, @dots{}, @var{iter}+1}. The preconditioned residual norm +is defined as @code{norm (@var{r}) ^ 2 = @var{r}' * (@var{m} \ @var{r})} where @code{@var{r} = @var{b} - @var{a} * @var{x}}, see also the description of @var{m}. If @var{eigest} is not required, only @@ -102,8 +103,8 @@ @example @group N = 10; - A = diag([1:N]); A = sparse(A); - b = rand(N,1); + A = spdiag ([1:N]); + b = rand (N, 1); @end group @end example @@ -118,11 +119,11 @@ @example @group - function y = applyA(x) + function y = applyA (x) y = [1:N]'.*x; endfunction - x = pcg('applyA',b) + x = pcg ("applyA", b) @end group @end example @@ -132,14 +133,14 @@ @example @group - function y = applyM(x) - K = floor(length(x)-2); - y = x; - y(1:K) = x(1:K)./[1:K]'; + function y = applyM(x) + K = floor (length (x) - 2); + y = x; + y(1:K) = x(1:K)./[1:K]'; endfunction - [x, flag, relres, iter, resvec, eigest] = pcg(A,b,[],[],'applyM') - semilogy([1:iter+1], resvec); + [x, flag, relres, iter, resvec, eigest] = pcg (A, b, [], [], "applyM"); + semilogy (1:iter+1, resvec); @end group @end example @@ -148,13 +149,14 @@ @example @group - function y = applyM(x, varargin) + function y = applyM (x, varargin) K = varargin@{1@}; - y = x; y(1:K) = x(1:K)./[1:K]'; + y = x; + y(1:K) = x(1:K)./[1:K]'; endfuntion [x, flag, relres, iter, resvec, eigest] = ... - pcg(A,b,[],[],'applyM',[],3) + pcg (A, b, [], [], "applyM", [], 3) @end group @end example
--- a/language/base/help/octave/plot Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/plot Sun Apr 22 21:37:46 2007 +0000 @@ -18,13 +18,20 @@ If more than one argument is given, they are interpreted as @example -plot (@var{x}, @var{y}, @var{fmt} ...) +plot (@var{x}, @var{y}, @var{fmt}, @dots{}) @end example @noindent -where @var{y} and @var{fmt} are optional, and any number of argument -sets may appear. The @var{x} and @var{y} values are -interpreted as follows: +or as + +@example +plot (@var{x}, @var{y}, @var{property}, @var{value}, @dots{}) +@end example + +@noindent +where @var{y}, @var{fmt}, @var{property} and @var{value} are optional, +and any number of argument sets may appear. The @var{x} and @var{y} +values are interpreted as follows: @itemize @bullet @item @@ -66,12 +73,6 @@ @item . Set dots plot style. -@item @@ -Set points plot style. - -@item -@@ -Set linespoints plot style. - @item ^ Set impulses plot style. @@ -122,6 +123,9 @@ Note that the last semi-colon is required and will generate an error if it is left out. +If a @var{property} is given it must be followed by @var{value}. The +property value pairs are applied to the lines drawn by @code{plot}. + Here are some plot examples: @example @@ -133,11 +137,11 @@ color 4 (magenta) and @code{y4} with points displayed as @samp{+}. @example -plot (b, "*") +plot (b, "*", "markersize", 3) @end example This command will plot the data in the variable @code{b} will be plotted -with points displayed as @samp{*}. +with points displayed as @samp{*} with a marker size of 3. @example t = 0:0.1:6.3; @@ -147,5 +151,5 @@ This will plot the cosine and sine functions and label them accordingly in the key. @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -bar, stairs, errorbar, replot, xlabel, ylabel, title, print} +bar, stairs, errorbar, xlabel, ylabel, title, print} @end deftypefn
--- a/language/base/help/octave/plot3 Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/plot3 Sun Apr 22 21:37:46 2007 +0000 @@ -68,5 +68,5 @@ @end example @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -bar, stairs, errorbar, replot, xlabel, ylabel, title, print} +bar, stairs, errorbar, xlabel, ylabel, title, print} @end deftypefn
--- a/language/base/help/octave/polar Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/polar Sun Apr 22 21:37:46 2007 +0000 @@ -5,5 +5,5 @@ The optional third argument specifies the line type. @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, -stairs, replot, xlabel, ylabel, title} +stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/print Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/print Sun Apr 22 21:37:46 2007 +0000 @@ -1,19 +1,75 @@ -Copyright (C) 1999 Daniel Heiserer -Copyright (C) 2001 Laurent Mazet - -This file is part of Octave. +-*- texinfo -*- +@deftypefn {Function File} {} print (@var{filename}, @var{options}) -Octave is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. +Print a graph, or save it to a file + +@var{filename} defines the file name of the output file. If no +filename is specified, output is sent to the printer. -Octave is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. +@var{options}: +@table @code +@item -P@var{printer} + Set the @var{printer} name to which the graph is sent if no +@var{filename} is specified. +@item -color +@itemx -mono + Monochrome or colour lines. +@item -solid +@itemx -dashed + Solid or dashed lines. +@item -portrait +@itemx -landscape + Plot orientation, as returned by "orient". +@item -d@var{device} + Output device, where @var{device} is one of: +@table @code +@item ps +@itemx ps2 +@itemx psc +@itemx psc2 + Postscript (level 1 and 2, mono and color) +@item eps +@itemx eps2 +@itemx epsc +@itemx epsc2 + Encapsulated postscript (level 1 and 2, mono and color) +@item ill +@itemx aifm + Adobe Illustrator +@item cdr +@itemx corel + CorelDraw +@item hpgl + HP plotter language +@item fig + XFig +@item dxf + AutoCAD +@item mf + Metafont +@item png + Portable network graphics +@item pbm + PBMplus +@item emf + Microsoft Enhanced Metafile +@end table -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, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -02110-1301, USA. + Other devices are supported by "convert" from ImageMagick. Type + system("convert") to see what formats are available. + + If the device is omitted, it is inferred from the file extension, + or if there is no filename it is sent to the printer as postscript. + +@item -F@var{fontname} +@itemx -F@var{fontname}:@var{size} +@itemx -F:@var{size} +@var{fontname} set the postscript font (for use with postscript, + aifm, corel and fig). By default, 'Helvetica' is set for PS/Aifm, + and 'SwitzerlandLight' for Corel. It can also be 'Times-Roman'. +@var{size} is given in points. @var{fontname} is ignored for the + fig device. +@end table + +The filename and options can be given in any order. +@end deftypefn
--- a/language/base/help/octave/rgb2hsv Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/rgb2hsv Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {} @var{hsv_map} = rgb2hsv (@var{rgb_map}) +@deftypefn {Function File} {@var{hsv_map} =} rgb2hsv (@var{rgb_map}) Transform a colormap from the rgb space to the hsv space. A color n the RGB space consists of the red, green and blue intensities.
--- a/language/base/help/octave/run_count Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/run_count Sun Apr 22 21:37:46 2007 +0000 @@ -1,7 +1,7 @@ -*- texinfo -*- @deftypefn {Function File} {} run_count (@var{x}, @var{n}) Count the upward runs along the first non-singleton dimension of -@var{x} of length 1, 2, ..., @var{n}-1 and greater than or equal +@var{x} of length 1, 2, @dots{}, @var{n}-1 and greater than or equal to @var{n}. If the optional argument @var{dim} is given operate along this dimension @end deftypefn
--- a/language/base/help/octave/semilogx Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/semilogx Sun Apr 22 21:37:46 2007 +0000 @@ -4,5 +4,5 @@ the description of @code{plot} for a description of the arguments that @code{semilogx} will accept. @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -replot, xlabel, ylabel, title} +xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/semilogxerr Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/semilogxerr Sun Apr 22 21:37:46 2007 +0000 @@ -14,5 +14,5 @@ format defined by @var{fmt}. See errorbar for available formats and additional information. @seealso{errorbar, loglogerr semilogyerr, polar, mesh, contour, __pltopt__, -bar, stairs, replot, xlabel, ylabel, title} +bar, stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/semilogy Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/semilogy Sun Apr 22 21:37:46 2007 +0000 @@ -4,5 +4,5 @@ the description of @code{plot} for a description of the arguments that @code{semilogy} will accept. @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, -replot, xlabel, ylabel, title} +xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/semilogyerr Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/semilogyerr Sun Apr 22 21:37:46 2007 +0000 @@ -14,5 +14,5 @@ format defined by @var{fmt}. See errorbar for available formats and additional information. @seealso{errorbar, loglogerr semilogxerr, polar, mesh, contour, __pltopt__, -bar, stairs, replot, xlabel, ylabel, title} +bar, stairs, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/setfield Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/setfield Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{k1},..., @var{v1}] =} setfield (@var{s}, @var{k1}, @var{v1}, @dots{}) +@deftypefn {Function File} {[@var{k1}, @dots{}, @var{v1}] =} setfield (@var{s}, @var{k1}, @var{v1}, @dots{}) Set field members in a structure. @example
--- a/language/base/help/octave/shg Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/shg Sun Apr 22 21:37:46 2007 +0000 @@ -2,7 +2,7 @@ @deftypefn {Function File} {} shg Show the graph window. Currently, this is the same as executing -replot. +@code{drawnow}. @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -bar, stairs, replot, xlabel, ylabel} +bar, stairs, xlabel, ylabel} @end deftypefn
--- a/language/base/help/octave/shiftdim Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/shiftdim Sun Apr 22 21:37:46 2007 +0000 @@ -1,6 +1,6 @@ -*- texinfo -*- -@deftypefn {Function File} {@var{y}} = shiftdim (@var{x}, @var{n}) -@deftypefnx {Function File} {[@var{y}, @var{ns}]} = shiftdim (@var{x}) +@deftypefn {Function File} {@var{y} =} shiftdim (@var{x}, @var{n}) +@deftypefnx {Function File} {[@var{y}, @var{ns}] =} shiftdim (@var{x}) Shifts the dimension of @var{x} by @var{n}, where @var{n} must be an integer scalar. When @var{n} is positive, the dimensions of @var{x} are shifted to the left, with the leading dimensions
--- a/language/base/help/octave/spdiags Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/spdiags Sun Apr 22 21:37:46 2007 +0000 @@ -1,8 +1,8 @@ -*- texinfo -*- -@deftypefn {function File} {[@var{b}, @var{c}]} = spdiags (@var{a}) -@deftypefnx {function File} {@var{b}} = spdiags (@var{a}, @var{c}) -@deftypefnx {function File} {@var{b}} = spdiags (@var{v}, @var{c}, @var{a}) -@deftypefnx {function File} {@var{b}} = spdiags (@var{v}, @var{c}, @var{m}, @var{n}) +@deftypefn {function File} {[@var{b}, @var{c}] =} spdiags (@var{a}) +@deftypefnx {function File} {@var{b} =} spdiags (@var{a}, @var{c}) +@deftypefnx {function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{a}) +@deftypefnx {function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{m}, @var{n}) A generalization of the function @code{spdiag}. Called with a single input argument, the non-zero diagonals @var{c} of @var{A} are extracted. With two arguments the diagonals to extract are given by the vector
--- a/language/base/help/octave/speed Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/speed Sun Apr 22 21:37:46 2007 +0000 @@ -34,8 +34,9 @@ results of expression @var{f} and expression @var{f2}. Otherwise, expression @var{f} should produce a value @var{v} and expression @var{f2} should produce a value @var{v2}, and these shall be compared using -@code{assert(@var{v},@var{v2},@var{tol})}. The default is -@code{eps}. +@code{assert(@var{v},@var{v2},@var{tol})}. If @var{tol} is positive, +the tolerance is assumed to be absolutr. If @var{tol} is negative, +the tolerance is assumed to be relative. The default is @code{eps}. @item @var{order} The time complexity of the expression @code{O(a n^p)}. This @@ -105,9 +106,9 @@ @example speed("v=xcorr(x,n)", "x=rand(128,1);", 100, ... - "v2=xcorr_orig(x,n)", 100*eps,'rel') + "v2=xcorr_orig(x,n)", -100*eps) speed("v=xcorr(x,15)", "x=rand(20+n,1);", 100, ... - "v2=xcorr_orig(x,n)", 100*eps,'rel') + "v2=xcorr_orig(x,n)", -100*eps) @end example Assuming one of the two versions is in @var{xcorr_orig}, this would
--- a/language/base/help/octave/spline Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/spline Sun Apr 22 21:37:46 2007 +0000 @@ -1,19 +1,56 @@ -Copyright (C) 2000,2001 Kai Habel -Copyright (C) 2006 David Bateman - -This file is part of Octave. +-*- texinfo -*- +@deftypefn {Function File} {@var{pp} = } spline (@var{x}, @var{y}) +@deftypefnx {Function File} {@var{yi} = } spline (@var{x}, @var{y}, @var{xi}) -Octave is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. +Returns the cubic spline interpolation of @var{y} at the point +@var{x}. Called with two arguments the piece-wise polynomial @var{pp} +that may later be used with @code{ppval} to evaluate the polynomial +at specific points. + +The variable @var{x} must be a vector of length @var{n}, and @var{y} +can be either a vector or array. In the case where @var{y} is a +vector, it can have a length of either @var{n} or @code{@var{n} + 2}. +If the length of @var{y} is @var{n}, then the 'not-a-knot' end +condition is used. If the length of @var{y} is @code{@var{n} + 2}, +then the first and last values of the vector @var{y} are the first +derivative of the cubic spline at the end-points. -Octave is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. +If @var{y} is an array, then the size of @var{y} must have the form +@iftex +@tex +$$[s_1, s_2, \cdots, s_k, n]$$ +@end tex +@end iftex +@ifinfo +@code{[@var{s1}, @var{s2}, @dots{}, @var{sk}, @var{n}]} +@end ifinfo +or +@iftex +@tex +$$[s_1, s_2, \cdots, s_k, n + 2]$$. +@end tex +@end iftex +@ifinfo +@code{[@var{s1}, @var{s2}, @dots{}, @var{sk}, @var{n} + 2]}. +@end ifinfo +The array is then reshaped internally to a matrix where to leading +dimension is given by +@iftex +@tex +$$s_1 s_2 \cdots s_k$$ +@end tex +@end iftex +@ifinfo +@code{@var{s1} * @var{s2} * @dots{} * @var{sk}} +@end ifinfo +and each row this matrix is then treated seperately. Note that this +is exactly the opposite treatment than @code{interp1} and is done +for compatiability. -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, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -02110-1301, USA. +Called with a third input argument, @code{spline} evaluates the +piece-wise spline at the points @var{xi}. There is an equivalence +between @code{ppval (spline (@var{x}, @var{y}), @var{xi})} and +@code{spline (@var{x}, @var{y}, @var{xi})}. + +@seealso{ppval, mkpp, unmkpp} +@end deftypefn
--- a/language/base/help/octave/spstats Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/spstats Sun Apr 22 21:37:46 2007 +0000 @@ -1,6 +1,6 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}]} = spstats (@var{s}) -@deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}]} = spstats (@var{s}, @var{j}) +@deftypefn {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}) +@deftypefnx {Function File} {[@var{count}, @var{mean}, @var{var}] =} spstats (@var{s}, @var{j}) Return the stats for the non-zero elements of the sparse matrix @var{s}. @var{count} is the number of non-zeros in each column, @var{mean} is the mean of the non-zeros in each column, and @var{var} is the
--- a/language/base/help/octave/stairs Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/stairs Sun Apr 22 21:37:46 2007 +0000 @@ -23,5 +23,5 @@ @noindent are equivalent. @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -bar, replot, xlabel, ylabel, title} +bar, xlabel, ylabel, title} @end deftypefn
--- a/language/base/help/octave/stem Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/stem Sun Apr 22 21:37:46 2007 +0000 @@ -1,6 +1,6 @@ -*- texinfo -*- @deftypefn {Function File} {@var{h} =} stem (@var{x}, @var{y}, @var{linespec}) -Plot a stem graph and return the handles of hte line and marker +Plot a stem graph and return the handles of the line and marker objects used to draw the stems. The default color is @code{"r"} (red). The default line style is @code{"-"} and the default marker is @code{"o"}. @@ -11,7 +11,7 @@ stem (x); @end example @noindent -plots 10 stems with hights from 1 to 10; +plots 10 stems with heights from 1 to 10; @example x = 1:10; @@ -19,7 +19,7 @@ stem (x, y); @end example @noindent -plots 10 stems with hights from 2 to 20; +plots 10 stems with heights from 2 to 20; @example x = 1:10; @@ -27,7 +27,7 @@ h = stem (x, y, "b"); @end example @noindent -plots 10 bars with hights from 2 to 20 +plots 10 bars with heights from 2 to 20 (the color is blue, and @var{h} is a 2-by-10 array of handles in which the first row holds the line handles and the the second row holds the marker handles); @@ -38,7 +38,7 @@ h = stem (x, y, "-.k"); @end example @noindent -plots 10 stems with hights from 2 to 20 +plots 10 stems with heights from 2 to 20 (the color is black, line style is @code{"-."}, and @var{h} is a 2-by-10 array of handles in which the first row holds the line handles and the second rows holds the marker handles); @@ -49,7 +49,7 @@ h = stem (x, y, "-.k."); @end example @noindent -plots 10 stems with hights from 2 to 20 +plots 10 stems with heights from 2 to 20 (the color is black, line style is @code{"-."} and the marker style is @code{"."}, and @var{h} is a 2-by-10 array of handles in which the first row holds the line handles and the second row holds the marker @@ -61,7 +61,7 @@ h = stem (x, y, "fill"); @end example @noindent -plots 10 stems with hights from 2 to 20 +plots 10 stems with heights from 2 to 20 (the color is rgb-triple defined, the line style is @code{"-"}, the marker style is @code{"o"}, and @var{h} is a 2-by-10 array of handles in which the first row holds the line handles and the second
--- a/language/base/help/octave/stft Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/stft Sun Apr 22 21:37:46 2007 +0000 @@ -1,5 +1,5 @@ -*- texinfo -*- -@deftypefn {Function File} {[@var{y}, @var{c}]} = stft (@var{x}, @var{win_size}, @var{inc}, @var{num_coef}, @var{w_type}) +@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.
--- a/language/base/help/octave/strmatch Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/strmatch Sun Apr 22 21:37:46 2007 +0000 @@ -1,19 +1,8 @@ -Copyright (C) 2000 Paul Kienzle -Copyright (C) 2003 Alois Schloegl - -This file is part of Octave. - -Octave is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -Octave is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with Octave; see the file COPYING. If not, write to the Free -Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -02110-1301, USA. +-*- texinfo -*- +@deftypefn {Function File} {} strmatch (@var{s}, @var{a}, "exact") +Return true for entries of @var{a} that match the string @var{s}. +The second argument @var{a} may be a string matrix or a cell array of +strings. If the third argument @code{"exact"} is not given, then +@var{s} only needs to match @var{a} up to the length of @var{s}. Nul +characters match blanks. Results are returned as a column vector. +@end deftypefn
--- a/language/base/help/octave/subplot Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/subplot Sun Apr 22 21:37:46 2007 +0000 @@ -1,21 +1,8 @@ -*- texinfo -*- @deftypefn {Function File} {} subplot (@var{rows}, @var{cols}, @var{index}) @deftypefnx {Function File} {} subplot (@var{rcn}) -Sets @code{gnuplot} in multiplot mode and plots in location -given by index (there are @var{cols} by @var{rows} subwindows). - -Input: - -@table @var -@item rows -Number of rows in subplot grid. - -@item columns -Number of columns in subplot grid. - -@item index -Index of subplot where to make the next plot. -@end table +Set up a plot grid with @var{cols} by @var{rows} subwindows and plot +in location given by @var{index}. If only one argument is supplied, then it must be a three digit value specifying the location in digits 1 (rows) and 2 (columns) and the plot
--- a/language/base/help/octave/warning_ids Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/warning_ids Sun Apr 22 21:37:46 2007 +0000 @@ -77,7 +77,7 @@ If the @code{Octave:associativity-change} warning is enabled, Octave will warn about possible changes in the meaning of some code due to changes in associativity for some operators. -Associativity changes have typically been made for Matlab +Associativity changes have typically been made for @sc{Matlab} compatibility. By default, the @code{Octave:associativity-change} warning is enabled. @@ -124,7 +124,7 @@ @item Octave:matlab-incompatible Print warnings for Octave language features that may cause -compatibility problems with Matlab. +compatibility problems with @sc{Matlab}. @item Octave:missing-semicolon If the @code{Octave:missing-semicolon} warning is enabled, Octave @@ -162,7 +162,7 @@ If the @code{Octave:precedence-change} warning is enabled, Octave will warn about possible changes in the meaning of some code due to changes in precedence for some operators. Precedence changes have -typically been made for Matlab compatibility. By default, the +typically been made for @sc{Matlab} compatibility. By default, the @code{Octave:precedence-change} warning is enabled. @item Octave:reload-forces-clear
--- a/language/base/help/octave/wavread Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/wavread Sun Apr 22 21:37:46 2007 +0000 @@ -1,20 +1,20 @@ -*- texinfo -*- -@deftypefn {Function File} {@var{y}} = wavread (@var{filename}) +@deftypefn {Function File} {@var{y} =} wavread (@var{filename}) Load the RIFF/WAVE sound file @var{filename}, and return the samples in vector @var{y}. If the file contains multichannel data, then @var{y} is a matrix with the channels represented as columns. -@deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bits}]} = wavread (@var{filename}) +@deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bits}] =} wavread (@var{filename}) Additionally return the sample rate (@var{fs}) in Hz and the number of bits per sample (@var{bits}). -@deftypefnx {Function File} {[@dots{}]} = wavread (@var{filename}, @var{n}) +@deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n}) Read only the first @var{n} samples from each channel. -@deftypefnx {Function File} {[@dots{}]} = wavread(@var{filename},[@var{n1} @var{n2}]) +@deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename},[@var{n1} @var{n2}]) Read only samples @var{n1} through @var{n2} from each channel. -@deftypefnx {Function File} {[@var{samples}, @var{channels}]} = wavread (@var{filename}, "size") +@deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size") Return the number of samples (@var{n}) and channels (@var{ch}) instead of the audio data. @seealso{wavwrite}
--- a/language/base/help/octave/xlabel Thu Apr 19 08:57:51 2007 +0000 +++ b/language/base/help/octave/xlabel Sun Apr 22 21:37:46 2007 +0000 @@ -2,9 +2,7 @@ @deftypefn {Function File} {} xlabel (@var{string}) @deftypefnx {Function File} {} ylabel (@var{string}) @deftypefnx {Function File} {} zlabel (@var{string}) -Specify x, y, and z axis labels for the plot. If you already have a plot -displayed, use the command @code{replot} to redisplay it with the new -labels. +Specify x, y, and z axis labels for the plot. @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -bar, stairs, replot, ylabel, title} +bar, stairs, ylabel, title} @end deftypefn