Mercurial > hg > octave-nkf
changeset 6549:5a5a09d7deb8
[project @ 2007-04-20 06:55:29 by jwe]
author | jwe |
---|---|
date | Fri, 20 Apr 2007 06:55:29 +0000 |
parents | ecc8d30fa288 |
children | 1b7a6061a05d |
files | doc/interpreter/Makefile.in doc/interpreter/audio.txi doc/interpreter/basics.txi doc/interpreter/bit.txi doc/interpreter/data.txi doc/interpreter/errors.txi doc/interpreter/eval.txi doc/interpreter/expr.txi doc/interpreter/func.txi doc/interpreter/interp.txi doc/interpreter/io.txi doc/interpreter/numbers.txi doc/interpreter/octave.texi doc/interpreter/plot.txi doc/interpreter/poly.txi doc/interpreter/signal.txi doc/interpreter/strings.txi doc/interpreter/system.txi scripts/audio/wavread.m scripts/signal/filter2.m src/DLD-FUNCTIONS/__pchip_deriv__.cc src/DLD-FUNCTIONS/regexp.cc src/DLD-FUNCTIONS/urlwrite.cc |
diffstat | 23 files changed, 253 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/Makefile.in +++ b/doc/interpreter/Makefile.in @@ -36,11 +36,11 @@ IMAGES = $(IMAGES_EPS) $(IMAGES_PDF) $(IMAGES_PNG) $(IMAGES_TXT) -SUB_SOURCE := arith.txi audio.txi basics.txi bugs.txi \ +SUB_SOURCE := arith.txi audio.txi basics.txi bit.txi bugs.txi \ container.txi control.txi cp-idx.txi data.txi \ debug.txi diffeq.txi emacs.txi errors.txi eval.txi \ expr.txi finance.txi fn-idx.txi func.txi gpl.txi \ - grammar.txi image.txi install.txi intro.txi io.txi \ + grammar.txi image.txi install.txi interp.txi intro.txi io.txi \ linalg.txi matrix.txi nonlin.txi numbers.txi \ op-idx.txi optim.txi package.txi plot.txi poly.txi preface.txi \ quad.txi quaternion.txi set.txi signal.txi sparse.txi stats.txi \
--- a/doc/interpreter/audio.txi +++ b/doc/interpreter/audio.txi @@ -50,3 +50,6 @@ @DOCSTRING(setaudio) +@DOCSTRING(wavread) + +@DOCSTRING(wavwrite)
--- a/doc/interpreter/basics.txi +++ b/doc/interpreter/basics.txi @@ -294,6 +294,10 @@ @DOCSTRING(help) +@DOCSTRING(doc) + +@DOCSTRING(lookfor) + The help command can give you information about operators, but not the comma and semicolons that are used as command separators. To get help for those, you must type @kbd{help comma} or @kbd{help semicolon}.
new file mode 100644 --- /dev/null +++ b/doc/interpreter/bit.txi @@ -0,0 +1,24 @@ +@c Copyright (C) 2007 John W. Eaton +@c This is part of the Octave manual. +@c For copying conditions, see the file gpl.texi. + +@node Bit Manipulations +@chapter Bit Manipulations + +Octave provides the following functions for bit twiddling. + +@DOCSTRING(bitset) + +@DOCSTRING(bitget) + +@DOCSTRING(bitcmp) + +@DOCSTRING(bitshift) + +@DOCSTRING(bitand) + +@DOCSTRING(bitor) + +@DOCSTRING(bitxor) + +@DOCSTRING(bitmax)
--- a/doc/interpreter/data.txi +++ b/doc/interpreter/data.txi @@ -136,13 +136,20 @@ data structure type doesn't have rows or columns, so the @code{rows} and @code{columns} functions return @minus{}1 for structure arguments. +@DOCSTRING(ndims) + @DOCSTRING(columns) @DOCSTRING(rows) +@DOCSTRING(numel) + @DOCSTRING(length) @DOCSTRING(size) @DOCSTRING(isempty) +@DOCSTRING(sizeof) + +@DOCSTRING(size_equal)
--- a/doc/interpreter/errors.txi +++ b/doc/interpreter/errors.txi @@ -16,12 +16,24 @@ @DOCSTRING(warning) +@DOCSTRING(print_usage) + @DOCSTRING(usage) +@DOCSTRING(lasterror) + @DOCSTRING(lasterr) @DOCSTRING(lastwarn) +@DOCSTRING(rethrow) + +@DOCSTRING(warning_ids) + +@DOCSTRING(errno) + +@DOCSTRING(errno_list) + The following pair of functions are of limited usefulness, and may be removed from future versions of Octave.
--- a/doc/interpreter/eval.txi +++ b/doc/interpreter/eval.txi @@ -62,3 +62,7 @@ function, etc. See @xref{Predicates for Numeric Objects}, for example, for a list of predicates for numeric objects, and @xref{Status of Variables}, for a description of the @code{exist} function. + +@DOCSTRING(evalin) + +@DOCSTRING(assignin)
--- a/doc/interpreter/expr.txi +++ b/doc/interpreter/expr.txi @@ -153,6 +153,10 @@ particularly for large matrices because Octave does not have to repeatedly resize the result. +@DOCSTRING(sub2ind) + +@DOCSTRING(ind2sub) + @node Calling Functions @section Calling Functions
--- a/doc/interpreter/func.txi +++ b/doc/interpreter/func.txi @@ -25,6 +25,7 @@ * Script Files:: * Dynamically Linked Functions:: * Function Handles and Inline:: +* Commands:: * Organization of Functions:: @end menu @@ -591,6 +592,14 @@ @c FIXME -- note about time stamps on files in NFS environments? +@DOCSTRING(mfilename) + +@DOCSTRING(mlock) + +@DOCSTRING(munlock) + +@DOCSTRING(mislocked) + @DOCSTRING(addpath) @DOCSTRING(genpath) @@ -611,6 +620,12 @@ @DOCSTRING(ignore_function_time_stamp) +@DOCSTRING(autoload) + +@DOCSTRING(builtin) + +@DOCSTRING(dispatch) + @node Script Files @section Script Files @@ -929,6 +944,12 @@ can call in a built-in function. For the time being, you will have to read the source code for Octave. +@DOCSTRING(mkoctfile) + +@DOCSTRING(mex) + +@DOCSTRING(mexext) + @node Function Handles and Inline @section Function Handles and Inline @cindex handle, function handles @@ -962,6 +983,21 @@ @DOCSTRING(vectorize) +@node Commands +@section Commands + +@DOCSTRING(mark_as_command) + +@DOCSTRING(unmark_command) + +@DOCSTRING(iscommand) + +@DOCSTRING(mark_as_rawcommand) + +@DOCSTRING(unmark_rawcommand) + +@DOCSTRING(israwcommand) + @node Organization of Functions @section Organization of Functions Distributed with Octave
new file mode 100644 --- /dev/null +++ b/doc/interpreter/interp.txi @@ -0,0 +1,20 @@ +@c Copyright (C) 2007 John W. Eaton +@c This is part of the Octave manual. +@c For copying conditions, see the file gpl.texi. + +@node Interpolation +@chapter Interpolation + +Octave provides the following functions for interpolation. + +@DOCSTRING(interp1) + +@DOCSTRING(interp2) + +@DOCSTRING(interpft) + +@DOCSTRING(interpn) + +@DOCSTRING(bicubic) + +@DOCSTRING(lookup)
--- a/doc/interpreter/io.txi +++ b/doc/interpreter/io.txi @@ -35,6 +35,8 @@ @DOCSTRING(PAGER) +@DOCSTRING(PAGER_FLAGS) + @DOCSTRING(page_screen_output) @DOCSTRING(page_output_immediately)
--- a/doc/interpreter/numbers.txi +++ b/doc/interpreter/numbers.txi @@ -65,9 +65,16 @@ You may also use @samp{j}, @samp{I}, or @samp{J} in place of the @samp{i} above. All four forms are equivalent. +@DOCSTRING(double) + +@DOCSTRING(single) + +@DOCSTRING(complex) + @menu * Matrices:: * Ranges:: +* Integer Data Types:: * Logical Values:: * Predicates for Numeric Objects:: @end menu @@ -374,9 +381,36 @@ expression to determine whether they are all constants. If they are, it replaces the range expression with a single range constant. +@node Integer Data Types +@section Integer Data Types + +@DOCSTRING(isinteger) + +@DOCSTRING(int8) + +@DOCSTRING(uint8) + +@DOCSTRING(int16) + +@DOCSTRING(uint16) + +@DOCSTRING(int32) + +@DOCSTRING(uint32) + +@DOCSTRING(int64) + +@DOCSTRING(uint64) + +@DOCSTRING(intmax) + +@DOCSTRING(intmin) + @node Logical Values @section Logical Values +@DOCSTRING(logical) + @DOCSTRING(true) @DOCSTRING(false)
--- a/doc/interpreter/octave.texi +++ b/doc/interpreter/octave.texi @@ -140,6 +140,7 @@ * Plotting:: * Matrix Manipulation:: * Arithmetic:: +* Bit Manipulations:: * Linear Algebra:: * Nonlinear Equations:: * Sparse Matrices:: @@ -150,6 +151,7 @@ * Financial Functions:: * Sets:: * Polynomial Manipulations:: +* Interpolation:: * Control Theory:: * Signal Processing:: * Image Processing:: @@ -240,6 +242,7 @@ * Matrices:: * Ranges:: +* Integer Data Types:: * Logical Values:: * Predicates for Numeric Objects:: @@ -461,6 +464,8 @@ * Timing Utilities:: * Filesystem Utilities:: +* File Archiving Utilities:: +* Networking Utilities:: * Controlling Subprocesses:: * Process ID Information:: * Environment Variables:: @@ -548,6 +553,7 @@ @include plot.texi @include matrix.texi @include arith.texi +@include bit.texi @include linalg.texi @include nonlin.texi @include sparse.texi @@ -558,6 +564,7 @@ @include finance.texi @include set.texi @include poly.texi +@include interp.texi @include control.texi @include signal.texi @include image.texi
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -113,6 +113,8 @@ @DOCSTRING(closereq) +@DOCSTRING(isfigure) + @node Plot Annotations @section Plot Annotations
--- a/doc/interpreter/poly.txi +++ b/doc/interpreter/poly.txi @@ -43,6 +43,8 @@ @DOCSTRING(deconv) +@DOCSTRING(conv2) + @DOCSTRING(poly) @DOCSTRING(polyderiv)
--- a/doc/interpreter/signal.txi +++ b/doc/interpreter/signal.txi @@ -9,6 +9,8 @@ @DOCSTRING(fft) +@DOCSTRING(fftw) + @DOCSTRING(ifft) @DOCSTRING(fft2) @@ -25,6 +27,8 @@ @DOCSTRING(filter) +@DOCSTRING(filter2) + @DOCSTRING(freqz) @DOCSTRING(freqz_plot) @@ -59,6 +63,8 @@ @DOCSTRING(fftshift) +@DOCSTRING(ifftshift) + @DOCSTRING(fractdiff) @DOCSTRING(hamming) @@ -67,6 +73,8 @@ @DOCSTRING(hurst) +@DOCSTRING(pchip) + @DOCSTRING(periodogram) @DOCSTRING(rectangle_lw)
--- a/doc/interpreter/strings.txi +++ b/doc/interpreter/strings.txi @@ -184,6 +184,8 @@ @DOCSTRING(regexpi) +@DOCSTRING(regexprep) + @node String Conversions @section String Conversions @@ -243,6 +245,8 @@ @DOCSTRING(isgraph) +@DOCSTRING(isletter) + @DOCSTRING(islower) @DOCSTRING(isprint)
--- a/doc/interpreter/system.txi +++ b/doc/interpreter/system.txi @@ -14,6 +14,8 @@ @menu * Timing Utilities:: * Filesystem Utilities:: +* File Archiving Utilities:: +* Networking Utilities:: * Controlling Subprocesses:: * Process ID Information:: * Environment Variables:: @@ -153,6 +155,12 @@ @DOCSTRING(stat) +@DOCSTRING(lstat) + +@DOCSTRING(fileattrib) + +@DOCSTRING(isdir) + @DOCSTRING(glob) @DOCSTRING(fnmatch) @@ -161,6 +169,50 @@ @DOCSTRING(tilde_expand) +@DOCSTRING(canonicalize_file_name) + +@DOCSTRING(movefile) + +@DOCSTRING(copyfile) + +@DOCSTRING(fileparts) + +@DOCSTRING(filesep) + +@DOCSTRING(fullfile) + +@DOCSTRING(tempdir) + +@DOCSTRING(tempname) + +@DOCSTRING(P_tmpdir) + +@node File Archiving Utilities +@section File Archiving Utilities + +@DOCSTRING(bunzip2) + +@DOCSTRING(gunzip) + +@DOCSTRING(tar) + +@DOCSTRING(untar) + +@DOCSTRING(zip) + +@DOCSTRING(unzip) + +@DOCSTRING(pack) + +@DOCSTRING(unpack) + +@node Networking Utilities +@section Networking Utilities + +@DOCSTRING(urlread) + +@DOCSTRING(urlwrite) + @node Controlling Subprocesses @section Controlling Subprocesses @@ -176,6 +228,10 @@ @DOCSTRING(system) +@DOCSTRING(unix) + +@DOCSTRING(dos) + @DOCSTRING(popen) @DOCSTRING(pclose) @@ -200,6 +256,10 @@ @DOCSTRING(fcntl) +@DOCSTRING(kill) + +@DOCSTRING(SIG) + @node Process ID Information @section Process, Group, and User IDs @@ -231,6 +291,10 @@ @DOCSTRING(ls) +@DOCSTRING(ls_command) + +@DOCSTRING(dir) + @DOCSTRING(pwd) @node Password Database Functions @@ -313,6 +377,12 @@ @DOCSTRING(computer) +@DOCSTRING(uname) + +@DOCSTRING(ispc) + +@DOCSTRING(isunix) + @DOCSTRING(isieee) @DOCSTRING(OCTAVE_VERSION)
--- a/scripts/audio/wavread.m +++ b/scripts/audio/wavread.m @@ -30,7 +30,7 @@ ## @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")
--- a/scripts/signal/filter2.m +++ b/scripts/signal/filter2.m @@ -19,7 +19,7 @@ ## -*- 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/src/DLD-FUNCTIONS/__pchip_deriv__.cc +++ b/src/DLD-FUNCTIONS/__pchip_deriv__.cc @@ -40,7 +40,7 @@ octave_idx_type *ierr); } -DEFUN_DLD(__pchip_deriv__, args, , +DEFUN_DLD (__pchip_deriv__, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} __pchip_deriv__ (@var{x}, @var{y})\n\ Wrapper for SLATEC/PCHIP function DPCHIM to calculate the derivates for\n\
--- a/src/DLD-FUNCTIONS/regexp.cc +++ b/src/DLD-FUNCTIONS/regexp.cc @@ -1025,7 +1025,7 @@ */ -DEFUN_DLD(regexpi, args, nargout, +DEFUN_DLD (regexpi, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexpi (@var{str}, @var{pat})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} regexpi (@var{str}, @var{pat}, @var{opts}, @dots{})\n\ @@ -1388,9 +1388,9 @@ return retval; } -DEFUN_DLD(regexprep, args, , +DEFUN_DLD (regexprep, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} {@var{string} =} regexprep(@var{string}, @var{pat}, @var{repstr}, @var{options})\n\ +@deftypefn {Function File} {@var{string} =} regexprep (@var{string}, @var{pat}, @var{repstr}, @var{options})\n\ Replace matches of @var{pat} in @var{string} with @var{repstr}.\n\ \n\ \n\
--- a/src/DLD-FUNCTIONS/urlwrite.cc +++ b/src/DLD-FUNCTIONS/urlwrite.cc @@ -327,9 +327,9 @@ DEFUN_DLD (urlread, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} urlread(@var{url})\n\ +@deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ @deftypefnx {Loadable Function} {[@var{s}, @var{success}] =} urlread (@var{url})\n\ -@deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread(@var{url})\n\ +@deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread (@var{url})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} urlread (@var{url}, @var{method}, @var{param})\n\ Download a remote file specified by its @var{URL} and return its content\n\ in string @var{s}. For example,\n\