Mercurial > octave-nkf
changeset 3428:5b77cf82393c
[project @ 2000-01-14 02:54:53 by jwe]
line wrap: on
line diff
--- a/doc/interpreter/arith.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/arith.txi Fri Jan 14 02:55:00 2000 +0000 @@ -120,7 +120,7 @@ @DOCSTRING(cosh) @DOCSTRING(tanh) @DOCSTRING(sech) -@DOCSTRING(scsh) +@DOCSTRING(csch) @DOCSTRING(coth) @DOCSTRING(asinh)
--- a/doc/interpreter/basics.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/basics.txi Fri Jan 14 02:55:00 2000 +0000 @@ -106,6 +106,10 @@ remote shell command or inside an Emacs shell buffer. For another way to run Octave within Emacs, see @ref{Emacs}. +@item --no-history +@itemx -H +Disable command-line history. + @item --no-init-file @cindex @code{--no-init-file} Don't read the @file{~/.octaverc} or @file{.octaverc} files. @@ -324,12 +328,14 @@ terminals with real Meta keys. In the following sections, Meta characters such as @kbd{Meta-u} are written as @kbd{M-u}. + @menu * Cursor Motion:: * Killing and Yanking:: * Commands For Text:: * Commands For Completion:: * Commands For History:: +* Customizing @code{readline}:: * Customizing the Prompt:: * Diary and Echo Commands:: @end menu @@ -499,7 +505,7 @@ @DOCSTRING(completion_matches) -@node Commands For History, Customizing the Prompt, Commands For Completion, Command Line Editing +@node Commands For History, Customizing @code{readline}, Commands For Completion, Command Line Editing @subsection Commands For Manipulating The History @cindex command history @cindex input history @@ -564,7 +570,14 @@ @DOCSTRING(saving_history) -@node Customizing the Prompt, Diary and Echo Commands, Commands For History, Command Line Editing +@node Customizing @code{readline}, Customizing the Prompt, Commands For History, Command Line Editing +@subsection Customizing @code{readline} + +@c XXX FIXME XXX -- need a brief description of the ~/.inputrc file here. + +@DOCSTRING{read_readline_init_file} + +@node Customizing the Prompt, Diary and Echo Commands, Customizing @code{readline}, Command Line Editing @subsection Customizing the Prompt @cindex prompt customization @cindex customizing the prompt
--- a/doc/interpreter/control.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/control.txi Fri Jan 14 02:55:00 2000 +0000 @@ -237,6 +237,10 @@ @DOCSTRING(sysupdate) +@DOCSTRING(minfo) + +@DOCSTRING(sysgettsam) + @node structintern, , structaccess, sysinterface @subsection Data structure internal functions @@ -253,8 +257,6 @@ @DOCSTRING(sysout) -@DOCSTRING(polyout) - @DOCSTRING(tfout) @DOCSTRING(zpout) @@ -309,6 +311,10 @@ @DOCSTRING(wgt1o) +@DOCSTRING(parallel) + +@DOCSTRING(sysmin) + @node numerical, sysprop, blockdiag, Control Theory @section Numerical Functions @@ -316,6 +322,8 @@ @DOCSTRING(dare) +@DOCSTRING(dre) + @DOCSTRING(dgram) @DOCSTRING(dlyap) @@ -456,6 +464,8 @@ @DOCSTRING(hinfsyn_chk) +@DOCSTRING(hinfsyn_ric) + @DOCSTRING(lqe) @DOCSTRING(lqg)
--- a/doc/interpreter/data.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/data.txi Fri Jan 14 02:55:00 2000 +0000 @@ -18,6 +18,8 @@ capabilities. @ref{User-defined Data Types} describes what you must do to define a new data type for Octave. +@DOCSTRING(typeinfo) + @menu * Built-in Data Types:: * User-defined Data Types::
--- a/doc/interpreter/expr.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/expr.txi Fri Jan 14 02:55:00 2000 +0000 @@ -958,6 +958,8 @@ programs hard to read. Except in a one-shot program, you should rewrite it to get rid of such nesting of assignments. This is never very hard. +@DOCSTRING(print_rhs_assign_val) + @cindex increment operator @cindex decrement operator @cindex operators, increment
--- a/doc/interpreter/func.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/func.txi Fri Jan 14 02:55:00 2000 +0000 @@ -560,10 +560,16 @@ @DOCSTRING(LOADPATH) +@DOCSTRING(rehash) + +@DOCSTRING(file_in_loadpath) + @DOCSTRING(ignore_function_time_stamp) @DOCSTRING(warn_function_name_clash) +@DOCSTRING(warn_future_time_stamp) + @node Script Files, Dynamically Linked Functions, Function Files, Functions and Scripts @section Script Files @@ -836,22 +842,20 @@ functions, particularly those that rely on functions like @code{lsode} that require user-supplied functions. -Just as for M-files, Octave will automatically reload dynamically linked -functions when the files that define them are more recent than the last -time that the function was loaded. Two variables are available to -control how Octave behaves when dynamically linked functions are cleared -or reloaded. - -@c XXX FIXME XXX -- this variable no longer exists! - -@defvr {Built-in Variable} auto_unload_dot_oct_files -If the value of @code{auto_unload_dot_oct_files} is nonzero, Octave will -automatically unload any @file{.oct} files when there are no longer any -functions in the symbol table that reference them. -@end defvr +Just as for M-files, Octave will automatically reload a dynamically linked +function when the file that defines it is more recent than the last +time that the function was loaded. If more than one function is defined +in a single @file{.oct} file, reloading the file may force other +functions to be cleared and reloaded. If all the functions loaded from +a given @file{.oct} file are cleared, Octave will automatically unload +the @file{.oct} file. @DOCSTRING(warn_reload_forces_clear) +@c XXX FIXME XXX -- is there a better place for this? + +@DOCSTRING(variables_can_hide_functions) + Additional examples for writing dynamically linked functions are available in the files in the @file{src} directory of the Octave distribution. Currently, this includes the files
--- a/doc/interpreter/io.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/io.txi Fri Jan 14 02:55:00 2000 +0000 @@ -598,7 +598,7 @@ functions. One can be used to extract vectors of data from a file, and the other is more `C-like'. -DOSTRING(fscanf) +@DOCSTRING(fscanf) @DOCSTRING(sscanf)
--- a/doc/interpreter/linalg.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/linalg.txi Fri Jan 14 02:55:00 2000 +0000 @@ -25,6 +25,10 @@ @DOCSTRING(det) +@DOCSTRING(dmult) + +@DOCSTRING(dot) + @DOCSTRING(eig) @DOCSTRING(givens) @@ -62,6 +66,12 @@ @DOCSTRING(svd) +@c XXX FIXME XXX -- should there be a new section here? + +@DOCSTRING(housh) + +@DOCSTRING(krylov) + @node Functions of a Matrix, , Matrix Factorizations, Linear Algebra @section Functions of a Matrix
--- a/doc/interpreter/matrix.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/matrix.txi Fri Jan 14 02:55:00 2000 +0000 @@ -50,7 +50,9 @@ @code{while} statements) Octave treats the test as if you had typed @code{all (all (condition))}. -@DOCSTRING(common_size) +@DOCSTRING(xor) + +@DOCSTRING(is_duplicate_entry) @DOCSTRING(diff) @@ -62,6 +64,8 @@ @DOCSTRING(find) +@DOCSTRING(common_size) + @node Rearranging Matrices, Special Utility Matrices, Finding Elements and Checking Conditions, Matrix Manipulation @section Rearranging Matrices @@ -104,6 +108,8 @@ @DOCSTRING(vech) +@DOCSTRING(prepad) + @node Special Utility Matrices, Famous Matrices, Rearranging Matrices, Matrix Manipulation @section Special Utility Matrices @@ -163,6 +169,8 @@ Biomathematics at The University of Texas, M.D. Anderson Cancer Center, Houston, TX 77030. +@DOCSTRING(randperm) + @DOCSTRING(diag) @c XXX FIXME XXX -- is this really worth documenting? @@ -182,6 +190,8 @@ @DOCSTRING(treat_neg_dim_as_zero) +@DOCSTRING(ok_to_lose_imaginary_part) + @node Famous Matrices, , Special Utility Matrices, Matrix Manipulation @section Famous Matrices
--- a/doc/interpreter/numbers.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/numbers.txi Fri Jan 14 02:55:00 2000 +0000 @@ -68,6 +68,7 @@ @menu * Matrices:: * Ranges:: +* Logical Values:: * Predicates for Numeric Objects:: @end menu @@ -224,6 +225,8 @@ @DOCSTRING(whitespace_in_literal_matrix) +@DOCSTRING(warn_separator_insert) + When you type a matrix or the name of a variable whose value is a matrix, Octave responds by printing the matrix in with neatly aligned rows and columns. If the rows of the matrix are too large to fit on the @@ -324,7 +327,7 @@ @DOCSTRING(propagate_empty_matrices) -@node Ranges, Predicates for Numeric Objects, Matrices, Numeric Data Types +@node Ranges, Logical Values, Matrices, Numeric Data Types @section Ranges @cindex range expressions @cindex expression, range @@ -371,9 +374,22 @@ expression to determine whether they are all constants. If they are, it replaces the range expression with a single range constant. -@node Predicates for Numeric Objects, , Ranges, Numeric Data Types +@node Logical Values, Predicates for Numeric Objects, Ranges, Numeric Data Types +@section Logical Values + +@DOCSTRING(true) + +@DOCSTRING(false) + +@node Predicates for Numeric Objects, , Logical Values, Numeric Data Types @section Predicates for Numeric Objects +@DOCSTRING(isnumeric) + +@DOCSTRING(isreal) + +@DOCSTRING(is_complex) + @DOCSTRING(is_matrix) @DOCSTRING(is_vector) @@ -383,3 +399,5 @@ @DOCSTRING(is_square) @DOCSTRING(is_symmetric) + +@DOCSTRING(is_bool)
--- a/doc/interpreter/plot.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/plot.txi Fri Jan 14 02:55:00 2000 +0000 @@ -2,7 +2,7 @@ @c This is part of the Octave manual. @c For copying conditions, see the file gpl.texi. -@node Plotting, Matrix Manipulation, Input and Output, Top +@node Plotting @chapter Plotting All of Octave's plotting functions use @code{gnuplot} to handle the @@ -20,6 +20,8 @@ * Three-Dimensional Plotting:: * Plot Annotations:: * Multiple Plots on One Page:: +* Multiple Plot Windows:: +* Interaction with @code{gnuplot}:: @end menu @node Two-Dimensional Plotting, Specialized Two-Dimensional Plots, Plotting, Plotting @@ -186,6 +188,8 @@ @DOCSTRING(clearplot) +@DOCSTRING(shg) + @DOCSTRING(closeplot) @DOCSTRING(purge_tmp_files) @@ -290,15 +294,9 @@ @DOCSTRING(mesh) -@DOCSTRING(meshdom) - -@DOCSTRING(gnuplot_binary) +@DOCSTRING(meshgrid) -@DOCSTRING(gnuplot_has_frames) - -@DOCSTRING(figure) - -@DOCSTRING(gnuplot_has_multiplot) +@DOCSTRING(meshdom) @node Plot Annotations, Multiple Plots on One Page, Three-Dimensional Plotting, Plotting @section Plot Annotations @@ -307,9 +305,11 @@ @DOCSTRING(title) +@DOCSTRING(bottom_title) + @DOCSTRING(xlabel) -@node Multiple Plots on One Page, , Plot Annotations, Plotting +@node Multiple Plots on One Page, Multiple Plot Windows, Plot Annotations, Plotting @section Multiple Plots on One Page The following functions all require a version of @code{gnuplot} that @@ -328,3 +328,35 @@ @DOCSTRING(subwindow) @DOCSTRING(top_title) + +@node Multiple Plot Windows, Interaction with @code{gnuplot}, Multiple Plots on One Page, Plotting +@section Multiple Plot Windows + +@DOCSTRING(figure) + +@node Interaction with @code{gnuplot}, , Multiple Plot Windows, Plotting +@section Interaction with @code{gnuplot} + +@DOCSTRING(gnuplot_binary) + +@DOCSTRING(gnuplot_has_frames) + +@DOCSTRING(gnuplot_has_multiplot) + +@DOCSTRING(graw) + +@DOCSTRING(gnuplot_command_plot) + +@DOCSTRING(gnuplot_command_replot) + +@DOCSTRING(gnuplot_command_splot) + +@DOCSTRING(gnuplot_command_using) + +@DOCSTRING(gnuplot_command_with) + +@DOCSTRING(gnuplot_command_axes) + +@DOCSTRING(gnuplot_command_title) + +@DOCSTRING(gnuplot_command_end)
--- a/doc/interpreter/poly.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/poly.txi Fri Jan 14 02:55:00 2000 +0000 @@ -60,3 +60,5 @@ @DOCSTRING(residue) @DOCSTRING(roots) + +@DOCSTRING(polyout)
--- a/doc/interpreter/strings.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/strings.txi Fri Jan 14 02:55:00 2000 +0000 @@ -126,6 +126,8 @@ @DOCSTRING(int2str) +@DOCSTRING(com2str) + @DOCSTRING(setstr) @DOCSTRING(strcat) @@ -174,12 +176,16 @@ @DOCSTRING(toupper) +@DOCSTRING(do_string_escapes) + @DOCSTRING(undo_string_escapes) @DOCSTRING(implicit_num_to_str_ok) @DOCSTRING(implicit_str_to_num_ok) +@DOCSTRING(warn_single_quote_string) + @node Character Class Functions, , String Conversions, Strings @section Character Class Functions
--- a/doc/interpreter/system.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/system.txi Fri Jan 14 02:55:00 2000 +0000 @@ -133,6 +133,8 @@ @DOCSTRING(glob) +@DOCSTRING(fnmatch) + @DOCSTRING(file_in_path) @DOCSTRING(tilde_expand)
--- a/doc/interpreter/var.txi Thu Jan 13 09:25:59 2000 +0000 +++ b/doc/interpreter/var.txi Fri Jan 14 02:55:00 2000 +0000 @@ -138,6 +138,8 @@ but the value of @code{x} at the top level remains unchanged, because the function works with a @emph{copy} of its argument. +@DOCSTRING(initialize_global_variables) + @DOCSTRING(default_global_variable_value) @DOCSTRING(is_global) @@ -224,11 +226,6 @@ Default value: @code{"+ "}. -@item auto_unload_dot_oct_files -@xref{Dynamically Linked Functions}. - -Default value: 0. - @item automatic_replot @xref{Two-Dimensional Plotting}.
--- a/scripts/elfun/acot.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/acot.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} acot (@var{X}) -## acot (X): compute the inverse cotangent of X for each element of X +## @deftypefn {Mapping Function} {} acot (@var{x}) +## Compute the inverse cotangent of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/acoth.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/acoth.m Fri Jan 14 02:55:00 2000 +0000 @@ -17,7 +17,10 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## acoth (z): compute the inverse hyperbolic cotangent for each element of z. +## -*- texinfo -*- +## @deftypefn {Mapping Function} acoth (@var{x}) +## Compute the inverse hyperbolic cotangent of each element of @var{x}. +## @end deftypefn ## Author: jwe
--- a/scripts/elfun/acsc.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/acsc.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} acsc (@var{X}) -## acsc (X): compute the inverse cosecant of X for each element of X +## @deftypefn {Mapping Function} {} acsc (@var{x}) +## Compute the inverse cosecant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/acsch.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/acsch.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} acsch (@var{X}) -## acsch (X): compute the inverse hyperbolic for each element of X +## @deftypefn {Mapping Function} {} acsch (@var{x}) +## Compute the inverse hyperbolic cosecant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/asec.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/asec.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} asec (@var{X}) -## asec (X): compute the inverse secant of X for each element of X +## @deftypefn {Mapping Function} {} asec (@var{x}) +## Compute the inverse secant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/asech.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/asech.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} asech (@var{X}) -## asech (X): compute the inverse hyperbolic secant of X for each element of X +## @deftypefn {Mapping Function} {} asech (@var{x}) +## Compute the inverse hyperbolic secant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/cot.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/cot.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} cot (@var{X}) -## cot (X): compute the cotangent of X for each element of X +## @deftypefn {Mapping Function} {} cot (@var{x}) +## Compute the cotangent of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/coth.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/coth.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} coth (@var{X}) -## coth (X): compute the hyperbolic cotangent of X for each element of X +## @deftypefn {Mapping Function} {} coth (@var{x}) +## Compute the hyperbolic cotangent of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/csc.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/csc.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} csc (@var{X}) -## csc (X): compute the cosecant of X for each element of X +## @deftypefn {Mapping Function} {} csc (@var{x}) +## Compute the cosecant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/csch.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/csch.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} csch (@var{X}) -## csch (X): compute the hyperbolic cosecant of X for each element of X +## @deftypefn {Mapping Function} {} csch (@var{x}) +## Compute the hyperbolic cosecant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/sec.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/sec.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} sec (@var{X}) -## sec (X): compute the secant of X for each element of X +## @deftypefn {Mapping Function} {} sec (@var{x}) +## Compute the secant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/elfun/sech.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/elfun/sech.m Fri Jan 14 02:55:00 2000 +0000 @@ -18,8 +18,8 @@ ## 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Mapping Function} {} sech (@var{X}) -## sech (X): compute the hyperbolic secant of X for each element of X +## @deftypefn {Mapping Function} {} sech (@var{x}) +## Compute the hyperbolic secant of each element of @var{x}. ## @end deftypefn ## Author: jwe
--- a/scripts/general/postpad.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/general/postpad.m Fri Jan 14 02:55:00 2000 +0000 @@ -17,21 +17,13 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## postpad (x, l) -## -## Appends zeros to the vector x until it is of length l. -## postpad (x, l, c) appends the constant c instead of zero. -## -## If length (x) > l, elements from the end of x are removed -## until a vector of length l is obtained. +## See prepad. + +## Author: Tony Richardson <arichard@stark.cc.oh.us> +## Created: June 1994 function y = postpad (x, l, c) - ## Author: - ## Tony Richardson - ## arichard@stark.cc.oh.us - ## June 1994 - if (nargin == 2) c = 0; elseif (nargin < 2 || nargin > 3)
--- a/scripts/general/prepad.m Thu Jan 13 09:25:59 2000 +0000 +++ b/scripts/general/prepad.m Fri Jan 14 02:55:00 2000 +0000 @@ -17,21 +17,23 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## prepad (x, l) +## -*- texinfo -*- +## @deftypefn {Function File} {@var{x} =} prepad (@var{x}, @var{l}, @var{c}) +## @deftypefnx {Function File} {@var{x} =} postpad (@var{x}, @var{l}, @var{c}) ## -## Prepends zeros to the vector x until it is of length l. -## prepad(x,l,c) prepends the constant c instead of zero. +## Prepends (appends) the scalar value @var{c} to the vector @var{x} +## until it is of length @var{l}. If the third argument is not +## supplied, a value of 0 is used. ## -## If length (x) > l, elements from the beginning of x are removed -## until a vector of length l is obtained. +## If @code{length (x) > l}, elements from the beginning (end) of +## @var{x} are removed until a vector of length l is obtained. +## @end deftypefn + +## Author: Tony Richardson <arichard@stark.cc.oh.us> +## Created: June 1994 function y = prepad (x, l, c) - ## Author: - ## Tony Richardson - ## arichard@stark.cc.oh.us - ## June 1994 - if (nargin == 2) c = 0; elseif (nargin < 2 || nargin > 3)
--- a/src/ChangeLog Thu Jan 13 09:25:59 2000 +0000 +++ b/src/ChangeLog Fri Jan 14 02:55:00 2000 +0000 @@ -4,6 +4,9 @@ after consecutive comment characters. * lex.l (grab_help_text): Ditto. + * lex.l (Vwhitespace_in_literal_matrix, Vwarn_separator_insert, + Vwarn_single_quote_string): Texinfoize doc string. + 2000-01-11 John W. Eaton <jwe@bevo.che.wisc.edu> * ov.h, ov.cc (octave_value::column_vector_value,
--- a/src/data.cc Thu Jan 13 09:25:59 2000 +0000 +++ b/src/data.cc Fri Jan 14 02:55:00 2000 +0000 @@ -161,7 +161,11 @@ } DEFUN (atan2, args, , - "atan2 (Y, X): atan (Y / X) in range -pi to pi") + "-*- texinfo -*-\n\ +@deftypefn {Mapping Function} {} atan2 (@var{y}, @var{x})\n\ +Compute atan (@var{y} / @var{x}) for corresponding elements of @var{y}\n\ +and @var{x}. The result is in range -pi to pi.\n\ +@deftypefn") { octave_value_list retval; @@ -247,7 +251,10 @@ } DEFUN (cumprod, args, , - "cumprod (X): cumulative products") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} cumprod (@var{x})\n\ +Cumulative products.\n\ +@end deftypefn") { octave_value_list retval; @@ -284,7 +291,10 @@ } DEFUN (cumsum, args, , - "cumsum (X): cumulative sums") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} cumsum (@var{x})\n\ +Cumulative sums.\n\ +@end deftypefn") { octave_value_list retval; @@ -555,7 +565,10 @@ } DEFUN (prod, args, , - "prod (X): products") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} prod (@var{x})\n\ +Products.\n\ +@end deftypefn") { octave_value_list retval; @@ -692,7 +705,10 @@ } DEFUN (sum, args, , - "sum (X): sum of elements") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} sum (@var{x})\n\ +Sum of elements.\n\ +@end deftypefn") { octave_value_list retval; @@ -729,13 +745,16 @@ } DEFUN (sumsq, args, , - "sumsq (X): sum of squares of elements.\n\ + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} sumsq (@var{x})\n\ +Sum of squares of elements.\n\ \n\ This function is equivalent to computing\n\ \n\ sum (X .* conj (X))\n\ \n\ -but it uses less memory and avoids calling conj if X is real.") +but it uses less memory and avoids calling conj if X is real.\n\ +@end deftypefn") { octave_value_list retval; @@ -772,7 +791,10 @@ } DEFUN (is_bool, args, , - "is_bool (x): return nonzero if x is a boolean object") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Functio} {} is_bool (@var{x})\n\ +Return true if @var{x} is a boolean object.\n\ +@deftypefn") { octave_value retval; @@ -787,7 +809,10 @@ DEFALIAS (islogical, is_bool); DEFUN (is_complex, args, , - "is_complex (x): return nonzero if x is a complex-valued numeric object") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} is_complex (@var{x})\n\ +Return true if @var{x} is a complex-valued numeric object.\n\ +@end deftypefn") { octave_value retval; @@ -800,7 +825,10 @@ } DEFUN (isreal, args, , - "isreal (x): return nonzero if x is a real-valued numeric object") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} isreal (@var{x})\n\ +Return true if @var{x} is a real-valued numeric object.\n\ +@end deftypefn") { octave_value retval; @@ -837,7 +865,10 @@ } DEFUN (isnumeric, args, , - "isnumeric (x): return nonzero if x is a numeric object") + "-*- texinfo -*-\n\ +@deftypefn {Built-in Function} {} isnumeric (@var{x})\n\ +Return nonzero if @var{x} is a numeric object.\n\ +@end deftypefn") { octave_value retval; @@ -850,7 +881,10 @@ } DEFUN (is_list, args, , - "is_list (x): return nonzero if x is a list") + "-*- texinfo -*-\n +@deftypefn {Built-in Function} {} is_list (@var{x})\n\ +Return nonzero if @var{x} is a list.\n\ +@end deftypefn") { octave_value retval;
--- a/src/lex.l Thu Jan 13 09:25:59 2000 +0000 +++ b/src/lex.l Fri Jan 14 02:55:00 2000 +0000 @@ -2289,15 +2289,25 @@ symbols_of_lex (void) { DEFVAR (warn_separator_insert, 0.0, warn_separator_insert, - "print warning if commas or semicolons that might be inserted\n\ -automatically in literal matrices"); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} warn_separator_insert\n\ +Print warning if commas or semicolons that might be inserted\n\ +automatically in literal matrices.\n\ +@end defvr"); DEFVAR (warn_single_quote_string, 0.0, warn_single_quote_string, - "print warning if a signle quote character is used to introduce a\n\ - string constant"); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} warn_single_quote_string\n\ +Print warning if a signle quote character is used to introduce a\n\ +string constant.\n\ +@end defvr"); DEFVAR (whitespace_in_literal_matrix, "", whitespace_in_literal_matrix, - "control auto-insertion of commas and semicolons in literal matrices"); + "-*- texinfo -*-\n\ +@defvr {Built-in Variable} whitespace_in_literal_matrix\n\ +Control auto-insertion of commas and semicolons in literal matrices.\n\ +@end defvr"); + } /*
--- a/src/mappers.cc Thu Jan 13 09:25:59 2000 +0000 +++ b/src/mappers.cc Fri Jan 14 02:55:00 2000 +0000 @@ -156,14 +156,14 @@ DEFUN_MAPPER (acos, 0, 0, 0, acos, 0, acos, -1.0, 1.0, 1, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} acos (@var{X})\n\ -acos (X): compute the inverse cosine of X for each element of X\n\ +@deftypefn {Mapping Function} {} acos (@var{x})\n\ +Compute the inverse cosine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (acosh, 0, 0, 0, acosh, 0, acosh, 1.0, DBL_MAX, 1, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} acosh (@var{X})\n\ -acosh (X): compute the inverse hyperbolic cosine of X for each element of X.\n\ +@deftypefn {Mapping Function} {} acosh (@var{x})\n\ +Compute the inverse hyperbolic cosine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (angle, 0, 0, 0, arg, arg, 0, 0.0, 0.0, 0, @@ -197,26 +197,26 @@ DEFUN_MAPPER (asin, 0, 0, 0, asin, 0, asin, -1.0, 1.0, 1, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} asin (@var{X})\n\ -asin (X): compute inverse sin (X) for each element of X\n\ +@deftypefn {Mapping Function} {} asin (@var{x})\n\ +Compute the inverse sine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (asinh, 0, 0, 0, asinh, 0, asinh, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} asinh (@var{X})\n\ -asinh (X): compute the inverse hyperbolic sin (X) for each element of X\n\ +@deftypefn {Mapping Function} {} asinh (@var{x})\n\ +Ompute the inverse hyperbolic sine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (atan, 0, 0, 0, atan, 0, atan, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} atan (@var{X})\n\ -atan (X): compute the inverse tangent of (X) for each element of X\n\ +@deftypefn {Mapping Function} {} atan (@var{x})\n\ +Compute the inverse tangent of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (atanh, 0, 0, 0, atanh, 0, atanh, -1.0, 1.0, 1, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} atanh (@var{X})\n\ -atanh (X): compute the inverse hyperbolic tanget of X for each element of X\n\ +@deftypefn {Mapping Function} {} atanh (@var{x})\n\ +Compute the inverse hyperbolic tanget of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (ceil, 0, 0, 0, ceil, 0, ceil, 0.0, 0.0, 0, @@ -243,14 +243,14 @@ DEFUN_MAPPER (cos, 0, 0, 0, cos, 0, cos, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} cos (@var{X})\n\ -cos (X): compute the cosine of X for each element of X\n\ +@deftypefn {Mapping Function} {} cos (@var{x})\n\ +Compute the cosine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (cosh, 0, 0, 0, cosh, 0, cosh, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} acosh (@var{X})\n\ -acosh (X): compute the inverse hyperbolic cosine of X for each element of X\n\ +@deftypefn {Mapping Function} {} cosh (@var{x})\n\ +Compute the hyperbolic cosine of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (erf, 0, 0, 0, xerf, 0, 0, 0.0, 0.0, 0, @@ -527,14 +527,14 @@ DEFUN_MAPPER (sin, 0, 0, 0, sin, 0, sin, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} sin (@var{X})\n\ -sin (X): compute the sin of X for each element of X\n\ +@deftypefn {Mapping Function} {} sin (@var{x})\n\ +Compute the sin of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (sinh, 0, 0, 0, sinh, 0, sinh, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} sinh (@var{X})\n\ -sinh (X): compute the inverse hyperbolic sin of X for each element of X\n\ +@deftypefn {Mapping Function} {} sinh (@var{x})\n\ +Compute the inverse hyperbolic sin of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (sqrt, 0, 0, 0, sqrt, 0, sqrt, 0.0, DBL_MAX, 1, @@ -548,13 +548,13 @@ DEFUN_MAPPER (tan, 0, 0, 0, tan, 0, tan, 0.0, 0.0, 0, "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} tan (@var{z})\n\ -tan (X): compute tanget of X for each element of X\n\ +Compute tanget of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (tanh, 0, 0, 0, tanh, 0, tanh, 0.0, 0.0, 0, "-*- texinfo -*-\n\ -@deftypefn {Mapping Function} {} tanh (@var{X})\n\ -tanh (X): compute hyperbolic tangent of X for each element of X\n\ +@deftypefn {Mapping Function} {} tanh (@var{x})\n\ +Compute hyperbolic tangent of each element of @var{x}.\n\ @end deftypefn"); DEFUN_MAPPER (toascii, xtoascii, 0, 0, 0, 0, 0, 0.0, 0.0, 1,