# HG changeset patch # User Rik # Date 1430692583 25200 # Node ID 03b9d17a2d95b008c87be2c8621eccd8bc69b077 # Parent 597991b19e40be63ae596f637a97d5c27ae98719 doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line. diff -r 597991b19e40 -r 03b9d17a2d95 scripts/io/beep.m --- a/scripts/io/beep.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/io/beep.m Sun May 03 15:36:23 2015 -0700 @@ -19,6 +19,10 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} beep () ## Produce a beep from the speaker (or visual bell). +## +## This function sends the alarm character @qcode{"\a"} to the terminal. +## Depending on the user's configuration this may produce an audible beep, +## a visual bell, or nothing at all. ## @seealso{puts, fputs, printf, fprintf} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/io/dlmwrite.m --- a/scripts/io/dlmwrite.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/io/dlmwrite.m Sun May 03 15:36:23 2015 -0700 @@ -26,20 +26,19 @@ ## ## @var{file} should be a file name or writable file ID given by @code{fopen}. ## -## The parameter @var{delim} specifies the delimiter to use to separate -## values on a row. +## The parameter @var{delim} specifies the delimiter to use to separate values +## on a row. ## -## The value of @var{r} specifies the number of delimiter-only lines to -## add to the start of the file. +## The value of @var{r} specifies the number of delimiter-only lines to add to +## the start of the file. ## -## The value of @var{c} specifies the number of delimiters to prepend to -## each line of data. +## The value of @var{c} specifies the number of delimiters to prepend to each +## line of data. ## -## If the argument @qcode{"-append"} is given, append to the end of -## @var{file}. +## If the argument @qcode{"-append"} is given, append to the end of @var{file}. ## -## In addition, the following keyword value pairs may appear at the end -## of the argument list: +## In addition, the following keyword value pairs may appear at the end of +## the argument list: ## ## @table @asis ## @item @qcode{"append"} @@ -49,12 +48,12 @@ ## See @var{delim} above. ## ## @item @qcode{"newline"} -## The character(s) to use to separate each row. Three special cases -## exist for this option. @qcode{"unix"} is changed into +## The character(s) to use to separate each row. Three special cases exist +## for this option. @qcode{"unix"} is changed into ## @qcode{"@xbackslashchar{}n"}, @qcode{"pc"} is changed into -## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}, and @qcode{"mac"} is changed -## into @qcode{"@xbackslashchar{}r"}. Any other value is used directly as the -## newline separator. +## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}, and @qcode{"mac"} is +## changed into @qcode{"@xbackslashchar{}r"}. Any other value is used +## directly as the newline separator. ## ## @item @qcode{"roffset"} ## See @var{r} above. @@ -63,8 +62,8 @@ ## See @var{c} above. ## ## @item @qcode{"precision"} -## The precision to use when writing the file. It can either be a -## format string (as used by fprintf) or a number of significant digits. +## The precision to use when writing the file. It can either be a format +## string (as used by fprintf) or a number of significant digits. ## @end table ## ## @example diff -r 597991b19e40 -r 03b9d17a2d95 scripts/io/importdata.m --- a/scripts/io/importdata.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/io/importdata.m Sun May 03 15:36:23 2015 -0700 @@ -44,8 +44,8 @@ ## @itemize ## @item ASCII table ## -## Import ASCII table using the specified number of header rows and -## the specified delimiter. +## Import ASCII table using the specified number of header rows and the +## specified delimiter. ## ## @item Image file ## diff -r 597991b19e40 -r 03b9d17a2d95 scripts/io/strread.m --- a/scripts/io/strread.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/io/strread.m Sun May 03 15:36:23 2015 -0700 @@ -32,8 +32,7 @@ ## been processed. ## ## The string @var{format} describes how the words in @var{str} should be -## parsed. -## It may contain any combination of the following specifiers: +## parsed. It may contain any combination of the following specifiers: ## ## @table @code ## @item %s @@ -83,20 +82,20 @@ ## [@var{a}, @var{b}, @var{c}] = strread (@var{str}, "%s %s %f"); ## @end example ## -## Optional numeric argument @var{format_repeat} can be used for -## limiting the number of items read: +## Optional numeric argument @var{format_repeat} can be used for limiting the +## number of items read: ## ## @table @asis ## @item -1 ## (default) read all of the string until the end. ## ## @item N -## Read N times @var{nargout} items. 0 (zero) is an acceptable -## value for @var{format_repeat}. +## Read N times @var{nargout} items. 0 (zero) is an acceptable value for +## @var{format_repeat}. ## @end table ## -## The behavior of @code{strread} can be changed via property-value -## pairs. The following properties are recognized: +## The behavior of @code{strread} can be changed via property-value pairs. The +## following properties are recognized: ## ## @table @asis ## @item @qcode{"commentstyle"} @@ -128,8 +127,8 @@ ## ## @item @qcode{"emptyvalue"}: ## Value to return for empty numeric values in non-whitespace delimited data. -## The default is NaN@. When the data type does not support NaN -## (int32 for example), then default is zero. +## The default is NaN@. When the data type does not support NaN (int32 for +## example), then default is zero. ## ## @item @qcode{"multipledelimsasone"} ## Treat a series of consecutive delimiters, without whitespace in between, @@ -145,25 +144,28 @@ ## If false (0), return an error. ## ## @item @qcode{"whitespace"} -## Any character in @var{value} will be interpreted as whitespace and -## trimmed; the string defining whitespace must be enclosed in double -## quotes for proper processing of special characters like -## @qcode{"@xbackslashchar{}t"}. The default value for whitespace is -## @qcode{" @xbackslashchar{}b@xbackslashchar{}r@xbackslashchar{}n@xbackslashchar{}t"} -## (note the space). -## Unless whitespace is set to '' (empty) AND at least one @qcode{"%s"} format -## conversion specifier is supplied, a space is always part of whitespace. +## Any character in @var{value} will be interpreted as whitespace and trimmed; +## the string defining whitespace must be enclosed in double quotes for proper +## processing of special characters like @qcode{"@xbackslashchar{}t"}. The +## default value for whitespace is +## @c Note: the next line specifically has a newline which generates a space +## @c in the output of qcode, but keeps the next line < 80 characters. +## @qcode{" +## @xbackslashchar{}b@xbackslashchar{}r@xbackslashchar{}n@xbackslashchar{}t"} +## (note the space). Unless whitespace is set to @qcode{""} (empty) AND at +## least one @qcode{"%s"} format conversion specifier is supplied, a space is +## always part of whitespace. ## ## @end table ## -## When the number of words in @var{str} doesn't match an exact multiple -## of the number of format conversion specifiers, strread's behavior -## depends on the last character of @var{str}: +## When the number of words in @var{str} doesn't match an exact multiple of +## the number of format conversion specifiers, strread's behavior depends on +## the last character of @var{str}: ## ## @table @asis ## @item last character = @qcode{"@xbackslashchar{}n"} -## Data columns are padded with empty fields or Nan so that all columns -## have equal length +## Data columns are padded with empty fields or Nan so that all columns have +## equal length ## ## @item last character is not @qcode{"@xbackslashchar{}n"} ## Data columns are not padded; strread returns columns of unequal length diff -r 597991b19e40 -r 03b9d17a2d95 scripts/io/textread.m --- a/scripts/io/textread.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/io/textread.m Sun May 03 15:36:23 2015 -0700 @@ -38,14 +38,14 @@ ## @item @qcode{"endofline"}: ## Specify a single character or ## @qcode{"@xbackslashchar{}r@xbackslashchar{}n"}. If no value is given, it -## will be inferred from the file. If set to "" (empty string) EOLs are -## ignored as delimiters. +## will be inferred from the file. If set to @qcode{""} (empty string) EOLs +## are ignored as delimiters. ## @end itemize ## ## The optional input @var{n} specifies the number of data lines to read; in ## this sense it differs slightly from the format repeat count in strread. ## -## If the format string is empty (not: omitted) and the file contains only +## If the format string is empty (not just omitted) and the file contains only ## numeric data (excluding headerlines), textread will return a rectangular ## matrix with the number of columns matching the number of numeric fields on ## the first data line of the file. Empty fields are returned as zero values. diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javaArray.m --- a/scripts/java/javaArray.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javaArray.m Sun May 03 15:36:23 2015 -0700 @@ -20,15 +20,15 @@ ## @deftypefn {Function File} {@var{jary} =} javaArray (@var{classname}, @var{sz}) ## @deftypefnx {Function File} {@var{jary} =} javaArray (@var{classname}, @var{m}, @var{n}, @dots{}) ## -## Create a Java array of size @var{sz} with elements of class -## @var{classname}. @var{classname} may be a Java object representing a class -## or a string containing the fully qualified class name. The size of -## the object may also be specified with individual integer arguments -## @var{m}, @var{n}, etc. +## Create a Java array of size @var{sz} with elements of class @var{classname}. ## -## The generated array is uninitialized. All elements are set to null -## if @var{classname} is a reference type, or to a default value (usually 0) -## if @var{classname} is a primitive type. +## @var{classname} may be a Java object representing a class or a string +## containing the fully qualified class name. The size of the object may +## also be specified with individual integer arguments @var{m}, @var{n}, etc. +## +## The generated array is uninitialized. All elements are set to null if +## @var{classname} is a reference type, or to a default value (usually 0) if +## @var{classname} is a primitive type. ## ## Sample code: ## diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/java_get.m --- a/scripts/java/java_get.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/java_get.m Sun May 03 15:36:23 2015 -0700 @@ -18,12 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{val} =} java_get (@var{obj}, @var{name}) -## Get the value of the field @var{name} of the Java object @var{obj}. For -## static fields, @var{obj} can be a string representing the fully qualified -## name of the corresponding class. +## Get the value of the field @var{name} of the Java object @var{obj}. +## +## For static fields, @var{obj} can be a string representing the fully +## qualified name of the corresponding class. ## ## When @var{obj} is a regular Java object, structure-like indexing can be -## used as a shortcut syntax. For instance, the two following statements are +## used as a shortcut syntax. For instance, the following two statements are ## equivalent ## ## @example diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/java_set.m --- a/scripts/java/java_set.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/java_set.m Sun May 03 15:36:23 2015 -0700 @@ -19,11 +19,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{obj} =} java_set (@var{obj}, @var{name}, @var{val}) ## Set the value of the field @var{name} of the Java object @var{obj} to -## @var{val}. For static fields, @var{obj} can be a string representing the -## fully qualified named of the corresponding Java class. +## @var{val}. +## +## For static fields, @var{obj} can be a string representing the fully +## qualified named of the corresponding Java class. ## ## When @var{obj} is a regular Java object, structure-like indexing can be -## used as a shortcut syntax. For instance, the two following statements are +## used as a shortcut syntax. For instance, the following two statements are ## equivalent ## ## @example diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javaaddpath.m --- a/scripts/java/javaaddpath.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javaaddpath.m Sun May 03 15:36:23 2015 -0700 @@ -20,10 +20,11 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} javaaddpath (@var{clspath}) ## @deftypefnx {Function File} {} javaaddpath (@var{clspath1}, @dots{}) -## Add @var{clspath} to the dynamic class path of the Java virtual -## machine. @var{clspath} may either be a directory where @file{.class} -## files are found, or a @file{.jar} file containing Java classes. -## Multiple paths may be added at once by specifying additional arguments. +## Add @var{clspath} to the dynamic class path of the Java virtual machine. +## +## @var{clspath} may either be a directory where @file{.class} files are +## found, or a @file{.jar} file containing Java classes. Multiple paths may +## be added at once by specifying additional arguments. ## @seealso{javarmpath, javaclasspath} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javachk.m --- a/scripts/java/javachk.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javachk.m Sun May 03 15:36:23 2015 -0700 @@ -39,36 +39,34 @@ ## Swing components for lightweight GUIs. ## @end table ## -## If @var{feature} is supported and: +## If @var{feature} is supported and ## ## @itemize @bullet ## @item -## No output argument is requested: +## no output argument is requested: ## ## Return an empty string ## ## @item -## An output argument is requested: +## an output argument is requested: ## ## Return a struct with fields @qcode{"feature"} and @qcode{"identifier"} ## both empty -## ## @end itemize ## -## If @var{feature} is not supported and: +## If @var{feature} is not supported and ## ## @itemize @bullet ## @item -## No output argument is requested: +## no output argument is requested: ## -## Emit an error message. +## Emit an error message ## ## @item -## An output argument is requested: +## an output argument is requested: ## -## Return a struct with field @qcode{"feature"} set to @var{feature} and -## field @qcode{"identifier"} set to @var{component} -## +## Return a struct with field @qcode{"feature"} set to @var{feature} and field +## @qcode{"identifier"} set to @var{component} ## @end itemize ## ## The optional input @var{component} will be used in place of @var{feature} @@ -81,13 +79,13 @@ ## Other features may be available if Octave was compiled with the Java ## Interface and Java is installed. ## -## @seealso{error, usejava} +## @seealso{usejava, error} ## @end deftypefn ## Author: Philip Nienhuis ## Created: 2014-04-19 -function msg = javachk (feature, component="") +function msg = javachk (feature, component = "") msg = ""; chk = false; diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javaclasspath.m --- a/scripts/java/javaclasspath.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javaclasspath.m Sun May 03 15:36:23 2015 -0700 @@ -31,12 +31,12 @@ ## @item If no output is requested, the dynamic and static classpaths are ## printed to the standard output. ## -## @item If one output value @var{dpath} is requested, the result is -## the dynamic classpath. +## @item If one output value @var{dpath} is requested, the result is the +## dynamic classpath. ## -## @item If two output values@var{dpath} and @var{spath} are -## requested, the first variable will contain the dynamic classpath and -## the second will be contain the static classpath. +## @item If two output values@var{dpath} and @var{spath} are requested, the +## first variable will contain the dynamic classpath and the second will +## contain the static classpath. ## @end itemize ## ## If called with a single input parameter @var{what}: diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javamem.m --- a/scripts/java/javamem.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javamem.m Sun May 03 15:36:23 2015 -0700 @@ -19,44 +19,41 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} javamem () ## @deftypefnx {Function File} {@var{jmem} =} javamem () -## Show the current memory usage of the Java virtual machine (JVM) -## and run the garbage collector. +## Show the current memory usage of the Java virtual machine (JVM) and run the +## garbage collector. ## ## When no return argument is given the info is printed to the screen. -## Otherwise, the output cell array @var{jmem} contains Maximum, Total, -## and Free memory (in bytes). +## Otherwise, the output cell array @var{jmem} contains Maximum, Total, and +## Free memory (in bytes). ## -## All Java-based routines are run in the JVM's shared memory pool, -## a dedicated and separate part of memory claimed by the JVM from -## your computer's total memory (which comprises physical RAM and -## virtual memory / swap space on hard disk). +## All Java-based routines are run in the JVM's shared memory pool, a +## dedicated and separate part of memory claimed by the JVM from your +## computer's total memory (which comprises physical RAM and virtual memory / +## swap space on hard disk). ## ## The maximum allowable memory usage can be configured using the file -## @file{java.opts}. The directory where this file resides is -## determined by the environment variable @w{@env{OCTAVE_JAVA_DIR}}. -## If unset, the directory where @file{javaaddpath.m} resides is used instead -## (typically +## @file{java.opts}. The directory where this file resides is determined by +## the environment variable @w{@env{OCTAVE_JAVA_DIR}}. If unset, the directory +## where @file{javaaddpath.m} resides is used instead (typically ## @file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}). ## -## @file{java.opts} is a plain text file with one option per line. The -## default initial memory size and default maximum memory size (which -## are both system dependent) can be overridden like so: +## @file{java.opts} is a plain text file with one option per line. The default +## initial memory size and default maximum memory size (which are both system +## dependent) can be overridden like so: ## ## @nospell{-Xms64m} ## ## @nospell{-Xmx512m} ## ## (in megabytes in this example). -## You can adapt these values to your own requirements if your system -## has limited available physical memory or if you get Java memory -## errors. +## You can adapt these values to your own requirements if your system has +## limited available physical memory or if you get Java memory errors. ## -## "Total memory" is what the operating system has currently assigned -## to the JVM and depends on actual and active memory usage. -## "Free memory" is self-explanatory. During operation of Java-based -## Octave functions the amount of Total and Free memory will vary, -## due to Java's own cleaning up and your operating system's memory -## management. +## @qcode{"Total memory"} is what the operating system has currently assigned +## to the JVM and depends on actual and active memory usage. +## @qcode{"Free memory"} is self-explanatory. During operation of Java-based +## Octave functions the amount of Total and Free memory will vary, due to +## Java's own cleaning up and your operating system's memory management. ## @end deftypefn ## Author: Philip Nienhuis diff -r 597991b19e40 -r 03b9d17a2d95 scripts/java/javarmpath.m --- a/scripts/java/javarmpath.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javarmpath.m Sun May 03 15:36:23 2015 -0700 @@ -21,9 +21,11 @@ ## @deftypefn {Function File} {} javarmpath (@var{clspath}) ## @deftypefnx {Function File} {} javarmpath (@var{clspath1}, @dots{}) ## Remove @var{clspath} from the dynamic class path of the Java virtual -## machine. @var{clspath} may either be a directory where @file{.class} -## files are found, or a @file{.jar} file containing Java classes. -## Multiple paths may be removed at once by specifying additional arguments. +## machine. +## +## @var{clspath} may either be a directory where @file{.class} files are found, +## or a @file{.jar} file containing Java classes. Multiple paths may be +## removed at once by specifying additional arguments. ## @seealso{javaaddpath, javaclasspath} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/bandwidth.m --- a/scripts/linear-algebra/bandwidth.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/bandwidth.m Sun May 03 15:36:23 2015 -0700 @@ -22,9 +22,8 @@ ## Compute the bandwidth of @var{A}. ## ## The @var{type} argument is the string @qcode{"lower"} for the lower -## bandwidth and @qcode{"upper"} for the upper bandwidth. -## If no @var{type} is specified return both the lower and upper bandwidth -## of @var{A}. +## bandwidth and @qcode{"upper"} for the upper bandwidth. If no @var{type} is +## specified return both the lower and upper bandwidth of @var{A}. ## ## The lower/upper bandwidth of a matrix is the number of ## subdiagonals/superdiagonals with nonzero entries. diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/commutation_matrix.m --- a/scripts/linear-algebra/commutation_matrix.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/commutation_matrix.m Sun May 03 15:36:23 2015 -0700 @@ -23,35 +23,35 @@ ## $K_{m,n}$ ## @end tex ## @ifnottex -## K(m,n) +## K(m,n) ## @end ifnottex -## which is the unique +## which is the unique ## @tex ## $m n \times m n$ ## @end tex ## @ifnottex -## @var{m}*@var{n} by @var{m}*@var{n} +## @var{m}*@var{n} by @var{m}*@var{n} ## @end ifnottex -## matrix such that +## matrix such that ## @tex ## $K_{m,n} \cdot {\rm vec} (A) = {\rm vec} (A^T)$ ## @end tex ## @ifnottex -## @math{K(m,n) * vec(A) = vec(A')} +## @math{K(m,n) * vec(A) = vec(A')} ## @end ifnottex -## for all +## for all ## @tex ## $m\times n$ ## @end tex ## @ifnottex -## @math{m} by @math{n} +## @math{m} by @math{n} ## @end ifnottex -## matrices +## matrices ## @tex ## $A$. ## @end tex ## @ifnottex -## @math{A}. +## @math{A}. ## @end ifnottex ## ## If only one argument @var{m} is given, @@ -59,9 +59,9 @@ ## $K_{m,m}$ ## @end tex ## @ifnottex -## @math{K(m,m)} +## @math{K(m,m)} ## @end ifnottex -## is returned. +## is returned. ## ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential ## Calculus with Applications in Statistics and Econometrics.} diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/cond.m --- a/scripts/linear-algebra/cond.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/cond.m Sun May 03 15:36:23 2015 -0700 @@ -31,8 +31,8 @@ ## ## By default, @code{@var{p} = 2} is used which implies a (relatively slow) ## singular value decomposition. Other possible selections are -## @code{@var{p} = 1, Inf, "fro"} which are generally faster. See -## @code{norm} for a full discussion of possible @var{p} values. +## @code{@var{p} = 1, Inf, "fro"} which are generally faster. See @code{norm} +## for a full discussion of possible @var{p} values. ## ## The condition number of a matrix quantifies the sensitivity of the matrix ## inversion operation when small changes are made to matrix elements. Ideally diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/condest.m --- a/scripts/linear-algebra/condest.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/condest.m Sun May 03 15:36:23 2015 -0700 @@ -23,8 +23,9 @@ ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{A}, @var{solve}, @var{solve_t}, @var{t}) ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{apply}, @var{apply_t}, @var{solve}, @var{solve_t}, @var{n}, @var{t}) ## -## Estimate the 1-norm condition number of a matrix @var{A} -## using @var{t} test vectors using a randomized 1-norm estimator. +## Estimate the 1-norm condition number of a matrix @var{A} using @var{t} test +## vectors using a randomized 1-norm estimator. +## ## If @var{t} exceeds 5, then only 5 test vectors are used. ## ## If the matrix is not explicit, e.g., when estimating the condition @@ -47,11 +48,10 @@ ## ## The implicit version requires an explicit dimension @var{n}. ## -## @code{condest} uses a randomized algorithm to approximate -## the 1-norms. +## @code{condest} uses a randomized algorithm to approximate the 1-norms. ## -## @code{condest} returns the 1-norm condition estimate @var{est} and -## a vector @var{v} satisfying @code{norm (A*v, 1) == norm (A, 1) * norm +## @code{condest} returns the 1-norm condition estimate @var{est} and a vector +## @var{v} satisfying @code{norm (A*v, 1) == norm (A, 1) * norm ## (@var{v}, 1) / @var{est}}. When @var{est} is large, @var{v} is an ## approximate null vector. ## diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/cross.m --- a/scripts/linear-algebra/cross.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/cross.m Sun May 03 15:36:23 2015 -0700 @@ -19,8 +19,16 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} cross (@var{x}, @var{y}) ## @deftypefnx {Function File} {} cross (@var{x}, @var{y}, @var{dim}) -## Compute the vector cross product of two 3-dimensional vectors -## @var{x} and @var{y}. +## Compute the vector cross product of two 3-dimensional vectors @var{x} and +## @var{y}. +## +## If @var{x} and @var{y} are matrices, the cross product is applied along the +## first dimension with three elements. +## +## The optional argument @var{dim} forces the cross product to be calculated +## along the specified dimension. +## +## Example Code: ## ## @example ## @group @@ -29,10 +37,6 @@ ## @end group ## @end example ## -## If @var{x} and @var{y} are matrices, the cross product is applied -## along the first dimension with 3 elements. The optional argument -## @var{dim} forces the cross product to be calculated along -## the specified dimension. ## @seealso{dot, curl, divergence} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/duplication_matrix.m --- a/scripts/linear-algebra/duplication_matrix.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/duplication_matrix.m Sun May 03 15:36:23 2015 -0700 @@ -23,35 +23,35 @@ ## $D_n$ ## @end tex ## @ifnottex -## @nospell{@math{Dn}} +## @nospell{@math{Dn}} ## @end ifnottex -## which is the unique +## which is the unique ## @tex ## $n^2 \times n(n+1)/2$ ## @end tex ## @ifnottex -## @math{n^2} by @math{n*(n+1)/2} +## @math{n^2} by @math{n*(n+1)/2} ## @end ifnottex -## matrix such that +## matrix such that ## @tex ## $D_n * {\rm vech} (A) = {\rm vec} (A)$ ## @end tex ## @ifnottex -## @nospell{@math{Dn vech (A) = vec (A)}} +## @nospell{@math{Dn vech (A) = vec (A)}} ## @end ifnottex -## for all symmetric +## for all symmetric ## @tex ## $n \times n$ ## @end tex ## @ifnottex -## @math{n} by @math{n} +## @math{n} by @math{n} ## @end ifnottex -## matrices +## matrices ## @tex ## $A$. ## @end tex ## @ifnottex -## @math{A}. +## @math{A}. ## @end ifnottex ## ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/expm.m --- a/scripts/linear-algebra/expm.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/expm.m Sun May 03 15:36:23 2015 -0700 @@ -18,8 +18,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} expm (@var{A}) -## Return the exponential of a matrix, defined as the infinite Taylor -## series +## Return the exponential of a matrix. +## +## The matrix exponential is defined as the infinite Taylor series ## @tex ## $$ ## \exp (A) = I + A + {A^2 \over 2!} + {A^3 \over 3!} + \cdots @@ -32,7 +33,7 @@ ## @end example ## ## @end ifnottex -## The Taylor series is @emph{not} the way to compute the matrix +## However, the Taylor series is @emph{not} the way to compute the matrix ## exponential; see @nospell{Moler and Van Loan}, @cite{Nineteen Dubious Ways ## to Compute the Exponential of a Matrix}, SIAM Review, 1978. This routine ## uses Ward's diagonal Pad@'e approximation method with three step diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/housh.m --- a/scripts/linear-algebra/housh.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/housh.m Sun May 03 15:36:23 2015 -0700 @@ -18,8 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{housv}, @var{beta}, @var{zer}] =} housh (@var{x}, @var{j}, @var{z}) -## Compute Householder reflection vector @var{housv} to reflect @var{x} -## to be the j-th column of identity, i.e., +## Compute Householder reflection vector @var{housv} to reflect @var{x} to be +## the j-th column of identity, i.e., ## ## @example ## @group diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/isdefinite.m --- a/scripts/linear-algebra/isdefinite.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/isdefinite.m Sun May 03 15:36:23 2015 -0700 @@ -21,8 +21,9 @@ ## @deftypefnx {Function File} {} isdefinite (@var{A}, @var{tol}) ## Return 1 if @var{A} is symmetric positive definite within the ## tolerance specified by @var{tol} or 0 if @var{A} is symmetric -## positive semidefinite. Otherwise, return -1. If @var{tol} -## is omitted, use a tolerance of +## positive semidefinite. Otherwise, return -1. +## +## If @var{tol} is omitted, use a tolerance of ## @code{100 * eps * norm (@var{A}, "fro")} ## @seealso{issymmetric, ishermitian} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/ishermitian.m --- a/scripts/linear-algebra/ishermitian.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/ishermitian.m Sun May 03 15:36:23 2015 -0700 @@ -24,6 +24,7 @@ ## @var{tol}. ## ## The default tolerance is zero (uses faster code). +## ## Matrix @var{A} is considered symmetric if ## @code{norm (@var{A} - @var{A}', Inf) / norm (@var{A}, Inf) < @var{tol}}. ## @seealso{issymmetric, isdefinite} diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/issymmetric.m --- a/scripts/linear-algebra/issymmetric.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/issymmetric.m Sun May 03 15:36:23 2015 -0700 @@ -24,6 +24,7 @@ ## by @var{tol}. ## ## The default tolerance is zero (uses faster code). +## ## Matrix @var{A} is considered symmetric if ## @code{norm (@var{A} - @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}. ## @seealso{ishermitian, isdefinite} diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/istril.m --- a/scripts/linear-algebra/istril.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/istril.m Sun May 03 15:36:23 2015 -0700 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {} istril (@var{A}) ## Return true if @var{A} is a lower triangular matrix. ## -## A lower triangular matrix has nonzero entries only on the main diagonal -## and below. +## A lower triangular matrix has nonzero entries only on the main diagonal and +## below. ## @seealso{istriu, isbanded, isdiag, tril, bandwidth} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/istriu.m --- a/scripts/linear-algebra/istriu.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/istriu.m Sun May 03 15:36:23 2015 -0700 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {} istriu (@var{A}) ## Return true if @var{A} is an upper triangular matrix. ## -## An upper triangular matrix has nonzero entries only on the main diagonal -## and above. +## An upper triangular matrix has nonzero entries only on the main diagonal and +## above. ## @seealso{isdiag, isbanded, istril, triu, bandwidth} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/krylov.m --- a/scripts/linear-algebra/krylov.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/krylov.m Sun May 03 15:36:23 2015 -0700 @@ -25,29 +25,28 @@ ## @end example ## ## @noindent -## Using Householder reflections to guard against loss of orthogonality. +## using Householder reflections to guard against loss of orthogonality. ## ## If @var{V} is a vector, then @var{h} contains the Hessenberg matrix -## such that @nospell{@tcode{a*u == u*h+rk*ek'}}, in which @code{rk = -## a*u(:,k)-u*h(:,k)}, and @nospell{@tcode{ek'}} is the vector +## such that @nospell{@tcode{a*u == u*h+rk*ek'}}, in which +## @code{rk = a*u(:,k)-u*h(:,k)}, and @nospell{@tcode{ek'}} is the vector ## @code{[0, 0, @dots{}, 1]} of length @code{k}. Otherwise, @var{h} is ## meaningless. ## -## If @var{V} is a vector and @var{k} is greater than -## @code{length (A) - 1}, then @var{h} contains the Hessenberg matrix such -## that @code{a*u == u*h}. +## If @var{V} is a vector and @var{k} is greater than @code{length (A) - 1}, +## then @var{h} contains the Hessenberg matrix such that @code{a*u == u*h}. ## -## The value of @var{nu} is the dimension of the span of the Krylov -## subspace (based on @var{eps1}). +## The value of @var{nu} is the dimension of the span of the Krylov subspace +## (based on @var{eps1}). ## -## If @var{b} is a vector and @var{k} is greater than @var{m-1}, then -## @var{h} contains the Hessenberg decomposition of @var{A}. +## If @var{b} is a vector and @var{k} is greater than @var{m-1}, then @var{h} +## contains the Hessenberg decomposition of @var{A}. ## -## The optional parameter @var{eps1} is the threshold for zero. The -## default value is 1e-12. +## The optional parameter @var{eps1} is the threshold for zero. The default +## value is 1e-12. ## -## If the optional parameter @var{pflg} is nonzero, row pivoting is used -## to improve numerical behavior. The default value is 0. +## If the optional parameter @var{pflg} is nonzero, row pivoting is used to +## improve numerical behavior. The default value is 0. ## ## Reference: @nospell{A. Hodel, P. Misra}, @cite{Partial Pivoting in the ## Computation of Krylov Subspaces of Large Sparse Systems}, Proceedings of diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/logm.m --- a/scripts/linear-algebra/logm.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/logm.m Sun May 03 15:36:23 2015 -0700 @@ -22,16 +22,19 @@ ## @deftypefn {Function File} {@var{s} =} logm (@var{A}) ## @deftypefnx {Function File} {@var{s} =} logm (@var{A}, @var{opt_iters}) ## @deftypefnx {Function File} {[@var{s}, @var{iters}] =} logm (@dots{}) -## Compute the matrix logarithm of the square matrix @var{A}. The -## implementation utilizes a Pad@'e approximant and the identity +## Compute the matrix logarithm of the square matrix @var{A}. +## +## The implementation utilizes a Pad@'e approximant and the identity ## ## @example ## logm (@var{A}) = 2^k * logm (@var{A}^(1 / 2^k)) ## @end example ## -## The optional argument @var{opt_iters} is the maximum number of square roots -## to compute and defaults to 100. The optional output @var{iters} is the -## number of square roots actually computed. +## The optional input @var{opt_iters} is the maximum number of square roots +## to compute and defaults to 100. +## +## The optional output @var{iters} is the number of square roots actually +## computed. ## @seealso{expm, sqrtm} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/normest.m --- a/scripts/linear-algebra/normest.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/normest.m Sun May 03 15:36:23 2015 -0700 @@ -21,13 +21,16 @@ ## @deftypefn {Function File} {@var{n} =} normest (@var{A}) ## @deftypefnx {Function File} {@var{n} =} normest (@var{A}, @var{tol}) ## @deftypefnx {Function File} {[@var{n}, @var{c}] =} normest (@dots{}) -## Estimate the 2-norm of the matrix @var{A} using a power series -## analysis. This is typically used for large matrices, where the cost -## of calculating @code{norm (@var{A})} is prohibitive and an approximation -## to the 2-norm is acceptable. +## Estimate the 2-norm of the matrix @var{A} using a power series analysis. +## +## This is typically used for large matrices, where the cost of calculating +## @code{norm (@var{A})} is prohibitive and an approximation to the 2-norm is +## acceptable. ## ## @var{tol} is the tolerance to which the 2-norm is calculated. By default -## @var{tol} is 1e-6. @var{c} returns the number of iterations needed for +## @var{tol} is 1e-6. +## +## The optional output @var{c} returns the number of iterations needed for ## @code{normest} to converge. ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/null.m --- a/scripts/linear-algebra/null.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/null.m Sun May 03 15:36:23 2015 -0700 @@ -21,9 +21,9 @@ ## @deftypefnx {Function File} {} null (@var{A}, @var{tol}) ## Return an orthonormal basis of the null space of @var{A}. ## -## The dimension of the null space is taken as the number of singular -## values of @var{A} not greater than @var{tol}. If the argument @var{tol} -## is missing, it is computed as +## The dimension of the null space is taken as the number of singular values of +## @var{A} not greater than @var{tol}. If the argument @var{tol} is missing, +## it is computed as ## ## @example ## max (size (@var{A})) * max (svd (@var{A})) * eps diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/onenormest.m --- a/scripts/linear-algebra/onenormest.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/onenormest.m Sun May 03 15:36:23 2015 -0700 @@ -21,8 +21,9 @@ ## @deftypefnx {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{apply}, @var{apply_t}, @var{n}, @var{t}) ## ## Apply @nospell{Higham and Tisseur's} randomized block 1-norm estimator to -## matrix @var{A} using @var{t} test vectors. If @var{t} exceeds 5, then -## only 5 test vectors are used. +## matrix @var{A} using @var{t} test vectors. +## +## If @var{t} exceeds 5, then only 5 test vectors are used. ## ## If the matrix is not explicit, e.g., when estimating the norm of ## @code{inv (@var{A})} given an LU@tie{}factorization, @code{onenormest} @@ -31,11 +32,10 @@ ## @var{n} by @var{t}. The implicit version requires an explicit dimension ## @var{n}. ## -## Returns the norm estimate @var{est}, two vectors @var{v} and -## @var{w} related by norm -## @code{(@var{w}, 1) = @var{est} * norm (@var{v}, 1)}, -## and the number of iterations @var{iter}. The number of -## iterations is limited to 10 and is at least 2. +## Returns the norm estimate @var{est}, two vectors @var{v} and @var{w} related +## by norm @code{(@var{w}, 1) = @var{est} * norm (@var{v}, 1)}, and the number +## of iterations @var{iter}. The number of iterations is limited to 10 and is +## at least 2. ## ## References: ## diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/orth.m --- a/scripts/linear-algebra/orth.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/orth.m Sun May 03 15:36:23 2015 -0700 @@ -21,9 +21,9 @@ ## @deftypefnx {Function File} {} orth (@var{A}, @var{tol}) ## Return an orthonormal basis of the range space of @var{A}. ## -## The dimension of the range space is taken as the number of singular -## values of @var{A} greater than @var{tol}. If the argument @var{tol} is -## missing, it is computed as +## The dimension of the range space is taken as the number of singular values +## of @var{A} greater than @var{tol}. If the argument @var{tol} is missing, it +## is computed as ## ## @example ## max (size (@var{A})) * max (svd (@var{A})) * eps diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/qzhess.m --- a/scripts/linear-algebra/qzhess.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/qzhess.m Sun May 03 15:36:23 2015 -0700 @@ -22,7 +22,9 @@ ## @code{(@var{A}, @var{B})}, returning ## @code{@var{aa} = @var{q} * @var{A} * @var{z}}, ## @code{@var{bb} = @var{q} * @var{B} * @var{z}}, with @var{q} and @var{z} -## orthogonal. For example: +## orthogonal. +## +## For example: ## ## @example ## @group diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/rank.m --- a/scripts/linear-algebra/rank.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/rank.m Sun May 03 15:36:23 2015 -0700 @@ -21,9 +21,9 @@ ## @deftypefnx {Function File} {} rank (@var{A}, @var{tol}) ## Compute the rank of matrix @var{A}, using the singular value decomposition. ## -## The rank is taken to be the number of singular values of @var{A} that -## are greater than the specified tolerance @var{tol}. If the second -## argument is omitted, it is taken to be +## The rank is taken to be the number of singular values of @var{A} that are +## greater than the specified tolerance @var{tol}. If the second argument is +## omitted, it is taken to be ## ## @example ## tol = max (size (@var{A})) * sigma(1) * eps; @@ -33,10 +33,9 @@ ## where @code{eps} is machine precision and @code{sigma(1)} is the largest ## singular value of @var{A}. ## -## The rank of a matrix is the number of linearly independent rows or -## columns and determines how many particular solutions exist to a system -## of equations. Use @code{null} for finding the remaining homogenous -## solutions. +## The rank of a matrix is the number of linearly independent rows or columns +## and determines how many particular solutions exist to a system of equations. +## Use @code{null} for finding the remaining homogenous solutions. ## ## Example: ## @@ -51,8 +50,8 @@ ## @end example ## ## @noindent -## The number of linearly independent rows is only 2 because the final row -## is a linear combination of -1*row1 + 2*row2. +## The number of linearly independent rows is only 2 because the final row is a +## linear combination of -1*row1 + 2*row2. ## ## @seealso{null, sprank, svd} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/rref.m --- a/scripts/linear-algebra/rref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/rref.m Sun May 03 15:36:23 2015 -0700 @@ -20,12 +20,14 @@ ## @deftypefn {Function File} {} rref (@var{A}) ## @deftypefnx {Function File} {} rref (@var{A}, @var{tol}) ## @deftypefnx {Function File} {[@var{r}, @var{k}] =} rref (@dots{}) -## Return the reduced row echelon form of @var{A}. @var{tol} defaults -## to @code{eps * max (size (@var{A})) * norm (@var{A}, inf)}. +## Return the reduced row echelon form of @var{A}. ## -## Called with two return arguments, @var{k} returns the vector of -## "bound variables", which are those columns on which elimination -## has been performed. +## @var{tol} defaults to +## @code{eps * max (size (@var{A})) * norm (@var{A}, inf)}. +## +## The optional return argument @var{k} contains the vector of +## "bound variables", which are those columns on which elimination has been +## performed. ## ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/linear-algebra/vech.m --- a/scripts/linear-algebra/vech.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/linear-algebra/vech.m Sun May 03 15:36:23 2015 -0700 @@ -21,9 +21,10 @@ ## @deftypefn {Function File} {} vech (@var{x}) ## Return the vector obtained by eliminating all superdiagonal elements of ## the square matrix @var{x} and stacking the result one column above the -## other. This has uses in matrix calculus where the underlying matrix -## is symmetric and it would be pointless to keep values above the main -## diagonal. +## other. +## +## This has uses in matrix calculus where the underlying matrix is symmetric +## and it would be pointless to keep values above the main diagonal. ## @seealso{vec} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/path/matlabroot.m --- a/scripts/path/matlabroot.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/path/matlabroot.m Sun May 03 15:36:23 2015 -0700 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {} matlabroot () ## Return the name of the top-level Octave installation directory. ## -## This is an alias for the function @w{@code{OCTAVE_HOME}} provided -## for compatibility. +## This is an alias for the function @w{@code{OCTAVE_HOME}} provided for +## compatibility. ## @seealso{OCTAVE_HOME} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/prefs/addpref.m --- a/scripts/prefs/addpref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/prefs/addpref.m Sun May 03 15:36:23 2015 -0700 @@ -18,15 +18,17 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} addpref (@var{group}, @var{pref}, @var{val}) -## Add a preference @var{pref} and associated value @var{val} to the -## named preference group @var{group}. +## Add a preference @var{pref} and associated value @var{val} to the named +## preference group @var{group}. ## ## The named preference group must be a character string. ## -## The preference @var{pref} may be a character string or a cell array -## of character strings. The corresponding value @var{val} may be any -## value, or, if @var{pref} is a cell array of strings, @var{val} -## must be a cell array of values with the same size as @var{pref}. +## The preference @var{pref} may be a character string or a cell array of +## character strings. +## +## The corresponding value @var{val} may be any value, or, if @var{pref} is a +## cell array of strings, @var{val} must be a cell array of values with the +## same size as @var{pref}. ## @seealso{setpref, getpref, ispref, rmpref} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/prefs/getpref.m --- a/scripts/prefs/getpref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/prefs/getpref.m Sun May 03 15:36:23 2015 -0700 @@ -17,26 +17,29 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} getpref (@var{group}, @var{pref}, @var{default}) -## Return the preference value corresponding to the named preference -## @var{pref} in the preference group @var{group}. +## @deftypefn {Function File} {} getpref (@var{group}, @var{pref}) +## @deftypefnx {Function File} {} getpref (@var{group}, @var{pref}, @var{default}) +## @deftypefnx {Function File} {} getpref (@var{group}) +## Return the preference value corresponding to the named preference @var{pref} +## in the preference group @var{group}. ## ## The named preference group must be a character string. ## ## If @var{pref} does not exist in @var{group} and @var{default} is ## specified, return @var{default}. ## -## The preference @var{pref} may be a character string or a cell array -## of character strings. The corresponding default value @var{default} -## may be any value, or, if @var{pref} is a cell array of strings, -## @var{default} must be a cell array of values with the same size as -## @var{pref}. +## The preference @var{pref} may be a character string or a cell array of +## character strings. ## -## If neither @var{pref} nor @var{default} are specified, return a -## structure of preferences for the preference group @var{group}. +## The corresponding default value @var{default} may be any value, or, if +## @var{pref} is a cell array of strings, @var{default} must be a cell array +## of values with the same size as @var{pref}. ## -## If no arguments are specified, return a structure containing all -## groups of preferences and their values. +## If neither @var{pref} nor @var{default} are specified, return a structure +## of preferences for the preference group @var{group}. +## +## If no arguments are specified, return a structure containing all groups of +## preferences and their values. ## @seealso{addpref, setpref, ispref, rmpref} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/prefs/ispref.m --- a/scripts/prefs/ispref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/prefs/ispref.m Sun May 03 15:36:23 2015 -0700 @@ -17,17 +17,18 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} ispref (@var{group}, @var{pref}) -## Return true if the named preference @var{pref} exists in the -## preference group @var{group}. +## @deftypefn {Function File} {} ispref (@var{group}, @var{pref}) +## @deftypefnx {Function File} {} ispref (@var{group}) +## Return true if the named preference @var{pref} exists in the preference +## group @var{group}. ## ## The named preference group must be a character string. ## -## The preference @var{pref} may be a character string or a cell array -## of character strings. +## The preference @var{pref} may be a character string or a cell array of +## character strings. ## -## If @var{pref} is not specified, return true if the preference -## group @var{group} exists. +## If @var{pref} is not specified, return true if the preference group +## @var{group} exists. ## @seealso{getpref, addpref, setpref, rmpref} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/prefs/rmpref.m --- a/scripts/prefs/rmpref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/prefs/rmpref.m Sun May 03 15:36:23 2015 -0700 @@ -17,18 +17,15 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} rmpref (@var{group}) -## @deftypefnx {Function File} {} rmpref (@var{group}, @var{pref}) -## Remove the named preference @var{pref} from the preference group -## @var{group}. +## @deftypefn {Function File} {} rmpref (@var{group}, @var{pref}) +## @deftypefnx {Function File} {} rmpref (@var{group}) +## Remove the named preference @var{pref} from the preference group @var{group}. ## ## The named preference group must be a character string. ## -## The preference @var{pref} may be a character string or cell array -## of strings. +## The preference @var{pref} may be a character string or cell array of strings. ## -## If @var{pref} is not specified, remove the preference group -## @var{group}. +## If @var{pref} is not specified, remove the preference group @var{group}. ## ## It is an error to remove a nonexistent preference or group. ## @seealso{addpref, ispref, setpref, getpref} diff -r 597991b19e40 -r 03b9d17a2d95 scripts/prefs/setpref.m --- a/scripts/prefs/setpref.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/prefs/setpref.m Sun May 03 15:36:23 2015 -0700 @@ -18,15 +18,17 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} setpref (@var{group}, @var{pref}, @var{val}) -## Set a preference @var{pref} to the given @var{val} in the named -## preference group @var{group}. +## Set a preference @var{pref} to the given @var{val} in the named preference +## group @var{group}. ## ## The named preference group must be a character string. ## -## The preference @var{pref} may be a character string or a cell array -## of character strings. The corresponding value @var{val} may be any -## value, or, if @var{pref} is a cell array of strings, @var{val} -## must be a cell array of values with the same size as @var{pref}. +## The preference @var{pref} may be a character string or a cell array of +## character strings. +## +## The corresponding value @var{val} may be any value, or, if @var{pref} is a +## cell array of strings, @var{val} must be a cell array of values with the +## same size as @var{pref}. ## ## If the named preference or group does not exist, it is added. ## @seealso{addpref, getpref, ispref, rmpref} diff -r 597991b19e40 -r 03b9d17a2d95 scripts/set/powerset.m --- a/scripts/set/powerset.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/set/powerset.m Sun May 03 15:36:23 2015 -0700 @@ -24,9 +24,9 @@ ## The set @var{a} must be a numerical matrix or a cell array of strings. The ## output will always be a cell array of either vectors or strings. ## -## With the optional second argument @qcode{"rows"}, each row of the set @var{a} -## is considered one element of the set. The input must be a 2-D numeric -## matrix to use this argument. +## With the optional argument @qcode{"rows"}, each row of the set @var{a} is +## considered one element of the set. The input must be a 2-D numeric matrix +## to use this argument. ## ## @seealso{unique, union, intersect, setdiff, setxor, ismember} ## @end deftypefn diff -r 597991b19e40 -r 03b9d17a2d95 scripts/set/setdiff.m --- a/scripts/set/setdiff.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/set/setdiff.m Sun May 03 15:36:23 2015 -0700 @@ -24,9 +24,8 @@ ## Return the unique elements in @var{a} that are not in @var{b} sorted in ## ascending order. ## -## If @var{a} is a row vector return a column vector; -## Otherwise, return a column vector. The inputs may also be cell arrays of -## strings. +## If @var{a} is a row vector return a column vector; Otherwise, return a +## column vector. The inputs may also be cell arrays of strings. ## ## If the optional input @qcode{"rows"} is given then return the rows in ## @var{a} that are not in @var{b}. The inputs must be 2-D matrices to use