# HG changeset patch # User Rik # Date 1431638737 25200 # Node ID b0f7ee81d974350dfaed4a809f41cd3d98d8b0b7 # Parent 5c2564643de4da79673650e40bce2b06c2c3eec5 doc: Remove extra spaces at start of docstring which show up in Info format. * intro.txi: Use blank line between end of example and seealso. * utils.cc: Remove stray comment from previous cset. * annotation.m: Overhaul docstring. * subspace.m: Re-indent academic reference. * condest.m: Remove blank column of spaces in front of license. * onenormest.m: Remove blank column of spaces in front of license. * sinc.m: Remove extra single space at start of line. * invhilb.m: Remove extra single space at start of line. * gls.m: Remove extra single space at start of line. * ols.m: Remove extra single space at start of line. diff -r 5c2564643de4 -r b0f7ee81d974 doc/interpreter/intro.txi --- a/doc/interpreter/intro.txi Thu May 14 14:47:05 2015 -0400 +++ b/doc/interpreter/intro.txi Thu May 14 14:25:37 2015 -0700 @@ -608,6 +608,7 @@ @var{x} - @var{w} + @var{y} + @dots{} @end group @end example + @b{See also:} bar @end deftypefn diff -r 5c2564643de4 -r b0f7ee81d974 libinterp/corefcn/utils.cc --- a/libinterp/corefcn/utils.cc Thu May 14 14:47:05 2015 -0400 +++ b/libinterp/corefcn/utils.cc Thu May 14 14:25:37 2015 -0700 @@ -695,12 +695,7 @@ return retval; } -/* -Escape sequences begin with a leading backslash (@qcode{"@xbackslashchar{}"})\n\ -followed by 1--3 characters (.e.g., @qcode{"@xbackslashchar{}n"} => newline).\n\ - - */ DEFUN (do_string_escapes, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} do_string_escapes (@var{string})\n\ diff -r 5c2564643de4 -r b0f7ee81d974 scripts/linear-algebra/condest.m --- a/scripts/linear-algebra/condest.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/linear-algebra/condest.m Thu May 14 14:25:37 2015 -0700 @@ -73,40 +73,40 @@ ## @seealso{cond, norm, onenormest} ## @end deftypefn -## Code originally licensed under +## Code originally licensed under: ## -## Copyright (c) 2007, Regents of the University of California -## All rights reserved. +## Copyright (c) 2007, Regents of the University of California +## All rights reserved. ## -## Redistribution and use in source and binary forms, with or without -## modification, are permitted provided that the following conditions -## are met: +## Redistribution and use in source and binary forms, with or without +## modification, are permitted provided that the following conditions +## are met: ## -## * Redistributions of source code must retain the above copyright -## notice, this list of conditions and the following disclaimer. +## * Redistributions of source code must retain the above copyright +## notice, this list of conditions and the following disclaimer. ## -## * Redistributions in binary form must reproduce the above -## copyright notice, this list of conditions and the following -## disclaimer in the documentation and/or other materials provided -## with the distribution. +## * Redistributions in binary form must reproduce the above +## copyright notice, this list of conditions and the following +## disclaimer in the documentation and/or other materials provided +## with the distribution. ## -## * Neither the name of the University of California, Berkeley nor -## the names of its contributors may be used to endorse or promote -## products derived from this software without specific prior -## written permission. +## * Neither the name of the University of California, Berkeley nor +## the names of its contributors may be used to endorse or promote +## products derived from this software without specific prior +## written permission. ## -## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' -## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED -## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -## PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND -## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT -## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -## SUCH DAMAGE. +## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' +## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +## PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +## SUCH DAMAGE. ## Author: Jason Riedy ## Keywords: linear-algebra norm estimation diff -r 5c2564643de4 -r b0f7ee81d974 scripts/linear-algebra/onenormest.m --- a/scripts/linear-algebra/onenormest.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/linear-algebra/onenormest.m Thu May 14 14:25:37 2015 -0700 @@ -55,40 +55,40 @@ ## @seealso{condest, norm, cond} ## @end deftypefn -## Code originally licensed under +## Code originally licensed under: ## -## Copyright (c) 2007, Regents of the University of California -## All rights reserved. +## Copyright (c) 2007, Regents of the University of California +## All rights reserved. ## -## Redistribution and use in source and binary forms, with or without -## modification, are permitted provided that the following conditions -## are met: +## Redistribution and use in source and binary forms, with or without +## modification, are permitted provided that the following conditions +## are met: ## -## * Redistributions of source code must retain the above copyright -## notice, this list of conditions and the following disclaimer. +## * Redistributions of source code must retain the above copyright +## notice, this list of conditions and the following disclaimer. ## -## * Redistributions in binary form must reproduce the above -## copyright notice, this list of conditions and the following -## disclaimer in the documentation and/or other materials provided -## with the distribution. +## * Redistributions in binary form must reproduce the above +## copyright notice, this list of conditions and the following +## disclaimer in the documentation and/or other materials provided +## with the distribution. ## -## * Neither the name of the University of California, Berkeley nor -## the names of its contributors may be used to endorse or promote -## products derived from this software without specific prior -## written permission. +## * Neither the name of the University of California, Berkeley nor +## the names of its contributors may be used to endorse or promote +## products derived from this software without specific prior +## written permission. ## -## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' -## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED -## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -## PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND -## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF -## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT -## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -## SUCH DAMAGE. +## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' +## AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +## TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +## PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +## SUCH DAMAGE. ## Author: Jason Riedy ## Keywords: linear-algebra norm estimation diff -r 5c2564643de4 -r b0f7ee81d974 scripts/linear-algebra/subspace.m --- a/scripts/linear-algebra/subspace.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/linear-algebra/subspace.m Thu May 14 14:25:37 2015 -0700 @@ -26,9 +26,9 @@ ## reference: ## [1] Andrew V. Knyazev, Merico E. Argentati: -## Principal Angles between Subspaces in an A-Based Scalar Product: -## Algorithms and Perturbation Estimates. -## SIAM Journal on Scientific Computing, Vol. 23 no. 6, pp. 2008-2040 +## Principal Angles between Subspaces in an A-Based Scalar Product: +## Algorithms and Perturbation Estimates. +## SIAM Journal on Scientific Computing, Vol. 23 no. 6, pp. 2008-2040 ## ## other texts are also around... diff -r 5c2564643de4 -r b0f7ee81d974 scripts/plot/appearance/annotation.m --- a/scripts/plot/appearance/annotation.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/plot/appearance/annotation.m Thu May 14 14:25:37 2015 -0700 @@ -23,46 +23,44 @@ ## @deftypefnx {Function File} {} annotation ("textbox", @var{pos}) ## @deftypefnx {Function File} {} annotation ("rectangle", @var{pos}) ## @deftypefnx {Function File} {} annotation ("ellipse", @var{pos}) +## @deftypefnx {Function File} {} annotation (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} annotation (@var{hf}, @dots{}) -## @deftypefnx {Function File} {} annotation (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {@var{h} =} annotation (@dots{}) ## Draw annotations to emphasize parts of a figure. ## -## You may build a default annotation specifying only the type -## @var{type} of the annotation. Otherwise you can set the position of -## the annotation using either @var{x} and @var{y} coordinates for -## line-based annotations or a position vector @var{pos} for others. -## In any case, coordinates are interpreted using the @qcode{"units"} -## property of the annotation objects: the default is -## @qcode{"normalized"}, which means the lower left hand corner of the -## figure has coordinates @samp{[0 0]} and the upper right hand corner +## You may build a default annotation by specifying only the @var{type} +## of the annotation. +## +## Otherwise you can select the type of annotation and then set its position +## using either @var{x} and @var{y} coordinates for line-based annotations or a +## position vector @var{pos} for others. In either case, coordinates are +## interpreted using the @qcode{"units"} property of the annotation object. +## The default is @qcode{"normalized"}, which means the lower left hand corner +## of the figure has coordinates @samp{[0 0]} and the upper right hand corner ## @samp{[1 1]}. ## -## The figure on which the annotations should be drawn may be -## specified by providing its graphics handle @var{hf} before any -## other argument. Otherwise annotations are drawn on the current -## figure. +## If the first argument @var{hf} is a figure handle, then plot into this +## figure, rather than the current figure returned by @code{gcf}. ## -## Further arguments can be provided in the form of -## @var{prop}/@var{val} pairs to customize the annotation appearance -## and the units in which coordinates are interpreted. The annotation -## can also be customized afterward using its graphics handle -## @var{h} and @code{set} function. +## Further arguments can be provided in the form of @var{prop}/@var{val} pairs +## to customize the annotation appearance. +## +## The optional return value @var{h} is a graphics handle to the created +## annotation object. This can be used with the @code{set} function to +## customize an existing annotation object. ## ## All annotation objects share two properties: ## ## @itemize -## @item -## @qcode{"units"}: the units in which coordinates are interpreted. -## Its value may be one of @qcode{"centimeters"} | -## @qcode{"characters"} | @qcode{"inches"} | @qcode{"@{normalized@}"} -## | @qcode{"pixels"} | @qcode{"points"}. +## @item @qcode{"units"}: the units in which coordinates are interpreted.@* +## Its value may be one of @qcode{"centimeters"} | @qcode{"characters"} | +## @qcode{"inches"} | @qcode{"@{normalized@}"} | @qcode{"pixels"} | +## @qcode{"points"}. ## -## @item -## @qcode{"position"}: a four elements vector [x0 y0 width height] -## specifying the coordinates (x0,y0) of the origin of the annotation -## object, its width and its height. The width and height may be -## negative, depending on the orientation of the object. +## @item @qcode{"position"}: a four-element vector [x0 y0 width height].@* +## The vector specifies the coordinates (x0,y0) of the origin of the annotation +## object, its width, and its height. The width and height may be negative, +## depending on the orientation of the object. ## ## @end itemize ## @@ -71,81 +69,76 @@ ## ## @table @asis ## @item @qcode{"line"} -## Constructs a line. @var{x} and @var{y} must be two -## elements vectors specifying the x and y coordinates of the two -## ends of the line. +## Constructs a line. @var{x} and @var{y} must be two-element vectors +## specifying the x and y coordinates of the two ends of the line. ## -## The line can be customized using @qcode{"linewidth"}, -## @qcode{"linestyle"} and @qcode{"color"} properties the same way -## as with @code{line} objects. +## The line can be customized using @qcode{"linewidth"}, @qcode{"linestyle"}, +## and @qcode{"color"} properties the same way as for @code{line} objects. ## -## @item @qcode{"arrow"} -## Construct an arrow. The second point in vectors @var{x} and -## @var{y} specifies the arrowhead coordinates. +## @item @qcode{"arrow"} +## Construct an arrow. The second point in vectors @var{x} and @var{y} +## specifies the arrowhead coordinates. ## -## Besides line properties, the arrowhead can be customized using -## @qcode{"headlength"}, @qcode{"headwidth"} and @qcode{"headstyle"} -## properties. Supported values for @qcode{"headstyle"} property are: -## [@qcode{"diamond"} | @qcode{"ellipse"} | @qcode{"plain"} | -## @qcode{"rectangle"} | @qcode{"vback1"} | @qcode{"@{vback2@}"} | -## @qcode{"vback3"}] -## -## @item @qcode{"doublearrow"} -## Construct a double arrow. Vectors @var{x} and @var{y} specify the -## arrowheads coordinates. +## Besides line properties, the arrowhead can be customized using +## @qcode{"headlength"}, @qcode{"headwidth"}, and @qcode{"headstyle"} +## properties. Supported values for @qcode{"headstyle"} property are: +## [@qcode{"diamond"} | @qcode{"ellipse"} | @qcode{"plain"} | +## @qcode{"rectangle"} | @qcode{"vback1"} | @qcode{"@{vback2@}"} | +## @qcode{"vback3"}] ## -## The line and the arrowhead can be customized as for arrow -## annotations but some property names are duplicated: -## @qcode{"head1length"}/@qcode{"head2length"}, -## @qcode{"head1width"}/@qcode{"head2width"}, etc. The index 1 marks -## the properties of the arrowhead at the first point in @var{x} and -## @var{y} coordinates. +## @item @qcode{"doublearrow"} +## Construct a double arrow. Vectors @var{x} and @var{y} specify the +## arrowhead coordinates. ## -## @item @qcode{"textarrow"} -## Construct an arrow with a text label at the opposite of the -## arrowhead. +## The line and the arrowhead can be customized as for arrow annotations, but +## some property names are duplicated: +## @qcode{"head1length"}/@qcode{"head2length"}, +## @qcode{"head1width"}/@qcode{"head2width"}, etc. The index 1 marks the +## properties of the arrowhead at the first point in @var{x} and @var{y} +## coordinates. +## +## @item @qcode{"textarrow"} +## Construct an arrow with a text label at the opposite end from the arrowhead. ## -## The line and the arrowhead can be customized as for arrow -## annotations, and the text can be customized using the same -## properties as @code{text} graphics objects. Note however -## that some text property names are prefixed with "text" to -## distinguish arrow and text properties: -## @qcode{"textbackgroundcolor"}, @qcode{"textcolor"}, -## @qcode{"textedgecolor"}, @qcode{"textlinewidth"}, -## @qcode{"textmargin"}, @qcode{"textrotation"}. +## The line and the arrowhead can be customized as for arrow annotations, and +## the text can be customized using the same properties as @code{text} graphics +## objects. Note, however, that some text property names are prefixed with +## "text" to distinguish them from arrow properties: +## @qcode{"textbackgroundcolor"}, @qcode{"textcolor"}, +## @qcode{"textedgecolor"}, @qcode{"textlinewidth"}, +## @qcode{"textmargin"}, @qcode{"textrotation"}. ## -## @item @qcode{"textbox"} -## Construct a box with a text inside. @var{pos} specifies the -## @qcode{"position"} property of the annotation. +## @item @qcode{"textbox"} +## Construct a box with text inside. @var{pos} specifies the +## @qcode{"position"} property of the annotation. ## -## You may use @qcode{"backgroundcolor"}, @qcode{"edgecolor"}, -## @qcode{"linestyle"} , @qcode{"linewidth"} properties to customize -## the box background color and edges appearance. A limited set of -## @code{text} objects properties is also available: besides -## @qcode{"font@dots{}"} properties, you may also use -## @qcode{"horizontalalignment"} and @qcode{"verticalalignment"} to -## move the text inside the box. +## You may use @qcode{"backgroundcolor"}, @qcode{"edgecolor"}, +## @qcode{"linestyle"}, and @qcode{"linewidth"} properties to customize +## the box background color and edge appearance. A limited set of @code{text} +## objects properties are also available; Besides @qcode{"font@dots{}"} +## properties, you may also use @qcode{"horizontalalignment"} and +## @qcode{"verticalalignment"} to position the text inside the box. ## -## Finally the @qcode{"fitboxtotext"} property controls the actual -## extent of the box. If @qcode{"on"} (the default) the -## box limits are fitted to the text extent. +## Finally, the @qcode{"fitboxtotext"} property controls the actual extent of +## the box. If @qcode{"on"} (the default) the box limits are fitted to the +## text extent. ## -## @item @qcode{"rectangle"} -## Construct a rectangle. @var{pos} specifies the -## @qcode{"position"} property of the annotation. +## @item @qcode{"rectangle"} +## Construct a rectangle. @var{pos} specifies the @qcode{"position"} property +## of the annotation. ## -## You may use @qcode{"facecolor"}, @qcode{"color"}, -## @qcode{"linestyle"} and @qcode{"linewidth"} properties to customize -## the rectangle background color and edges appearance. +## You may use @qcode{"facecolor"}, @qcode{"color"}, @qcode{"linestyle"}, and +## @qcode{"linewidth"} properties to customize the rectangle background color +## and edge appearance. ## -## @item @qcode{"ellipse"} -## Construct an ellipse. @var{pos} specifies the -## @qcode{"position"} property of the annotation. +## @item @qcode{"ellipse"} +## Construct an ellipse. @var{pos} specifies the @qcode{"position"} property +## of the annotation. ## -## See @qcode{"rectangle"} annotations for customization. +## See @qcode{"rectangle"} annotations for customization. ## @end table ## -## @seealso{xlabel, title, legend, colorbar} +## @seealso{xlabel, ylabel, zlabel, title, text, gtext, legend, colorbar} ## @end deftypefn function varargout = annotation (varargin) diff -r 5c2564643de4 -r b0f7ee81d974 scripts/signal/sinc.m --- a/scripts/signal/sinc.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/signal/sinc.m Thu May 14 14:25:37 2015 -0700 @@ -25,7 +25,7 @@ ## $ \sin (\pi x)/(\pi x)$. ## @end tex ## @ifnottex -## sin (pi*x) / (pi*x). +## sin (pi*x) / (pi*x). ## @end ifnottex ## @end deftypefn diff -r 5c2564643de4 -r b0f7ee81d974 scripts/special-matrix/invhilb.m --- a/scripts/special-matrix/invhilb.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/special-matrix/invhilb.m Thu May 14 14:25:37 2015 -0700 @@ -40,11 +40,11 @@ ## @example ## @group ## -## (i+j) /n+i-1\ /n+j-1\ /i+j-2\ 2 -## A(i,j) = -1 (i+j-1)( )( ) ( ) -## \ n-j / \ n-i / \ i-2 / +## (i+j) /n+i-1\ /n+j-1\ /i+j-2\ 2 +## A(i,j) = -1 (i+j-1)( )( ) ( ) +## \ n-j / \ n-i / \ i-2 / ## -## = p(i) p(j) / (i+j-1) +## = p(i) p(j) / (i+j-1) ## ## @end group ## @end example @@ -54,9 +54,9 @@ ## ## @example ## @group -## k /k+n-1\ /n\ -## p(k) = -1 ( ) ( ) -## \ k-1 / \k/ +## k /k+n-1\ /n\ +## p(k) = -1 ( ) ( ) +## \ k-1 / \k/ ## @end group ## @end example ## diff -r 5c2564643de4 -r b0f7ee81d974 scripts/statistics/base/gls.m --- a/scripts/statistics/base/gls.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/statistics/base/gls.m Thu May 14 14:25:37 2015 -0700 @@ -29,7 +29,7 @@ ## @w{@math{y = x*b + e}} with @math{mean (e) = 0} and ## @math{cov (vec (e)) = (s^2) o}, ## @end ifnottex -## where +## where ## @tex ## $y$ is a $t \times p$ matrix, $x$ is a $t \times k$ matrix, $b$ is a $k ## \times p$ matrix, $e$ is a $t \times p$ matrix, and $o$ is a $tp \times diff -r 5c2564643de4 -r b0f7ee81d974 scripts/statistics/base/ols.m --- a/scripts/statistics/base/ols.m Thu May 14 14:47:05 2015 -0400 +++ b/scripts/statistics/base/ols.m Thu May 14 14:25:37 2015 -0700 @@ -30,7 +30,7 @@ ## @w{@math{y = x*b + e}} with ## @math{mean (e) = 0} and @math{cov (vec (e)) = kron (s, I)}. ## @end ifnottex -## where +## where ## @tex ## $y$ is a $t \times p$ matrix, $x$ is a $t \times k$ matrix, ## $b$ is a $k \times p$ matrix, and $e$ is a $t \times p$ matrix.