Mercurial > hg > octave-terminal
changeset 12761:13bcd62824a7 stable
doc: Add documentation for gmres, rectangle to manual
linear-algebra/module.mk: Add gmres.m to list of functions.
gmres.m: Correct spelling in @seealso reference.
octave.texi: Add reference to new menu for 2D Geometric Shapes.
plot.txi: Add new menu for 2D Geometric Shapes. Add rectangle function.
rectangle.m: Improve DOCSTRING
aspell-octave.en.pws: Add spelling exception for PGMRES
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 20 Jun 2011 10:17:20 -0700 |
parents | e8fe03bfc051 |
children | 684ff193ddd2 |
files | doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/octave.texi doc/interpreter/plot.txi scripts/linear-algebra/gmres.m scripts/linear-algebra/module.mk scripts/plot/rectangle.m |
diffstat | 6 files changed, 17 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws +++ b/doc/interpreter/doccheck/aspell-octave.en.pws @@ -633,6 +633,7 @@ Petzold's PGF pgm +PGMRES PHP pict pinv
--- a/doc/interpreter/octave.texi +++ b/doc/interpreter/octave.texi @@ -523,6 +523,7 @@ * Axis Configuration:: * Two-dimensional Function Plotting:: +* Two-dimensional Geometric Shapes:: Three-Dimensional Plots
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -73,6 +73,7 @@ @menu * Axis Configuration:: * Two-dimensional Function Plotting:: +* Two-dimensional Geometric Shapes:: @end menu The @code{plot} function allows you to create simple x-y plots with @@ -283,6 +284,11 @@ @DOCSTRING(ezpolar) +@node Two-dimensional Geometric Shapes +@subsubsection Two-dimensional Geometric Shapes + +@DOCSTRING(rectangle) + @node Three-Dimensional Plots @subsection Three-Dimensional Plots
--- a/scripts/linear-algebra/gmres.m +++ b/scripts/linear-algebra/gmres.m @@ -15,7 +15,7 @@ ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. - + ## -*- texinfo -*- ## @deftypefn {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## @deftypefnx {Function File} {@var{x} =} gmres (@var{A}, @var{b}, @var{m}, @var{rtol}, @var{maxit}, @var{P}) @@ -69,7 +69,7 @@ ## iteration. ## @end itemize ## -## @seealso{pcg, cgs, bigcstab} +## @seealso{pcg, cgs, bicgstab} ## @end deftypefn function [x, flag, prec_res_norm, itcnt] = gmres (A, b, restart, rtol, maxit, M1, M2, x0)
--- a/scripts/linear-algebra/module.mk +++ b/scripts/linear-algebra/module.mk @@ -7,6 +7,7 @@ linear-algebra/cross.m \ linear-algebra/duplication_matrix.m \ linear-algebra/expm.m \ + linear-algebra/gmres.m \ linear-algebra/housh.m \ linear-algebra/isdefinite.m \ linear-algebra/ishermitian.m \
--- a/scripts/plot/rectangle.m +++ b/scripts/plot/rectangle.m @@ -26,14 +26,14 @@ ## ## Draw rectangular patch defined by @var{pos} and @var{curv}. The variable ## @code{@var{pos}(1 : 2)} defines the lower left-hand corner of the patch -## and @code{@var{pos}(3 : 4)} its width and height. By default the value of -## @var{pos} is @var{[0, 0, 1, 1]}. +## and @code{@var{pos}(3 : 4)} defines its width and height. By default, the +## value of @var{pos} is @code{[0, 0, 1, 1]}. ## ## The variable @var{curv} defines the curvature of the sides of the rectangle -## and it can be a scalar or two-element vector with values between 0 and 1. -## A value of 0 represents no curvature of the side, where as a value of 1 -## means that the rectangular side is entirely curved into an arc of a circle. -## If curvature is a two-element vector, then the first element is the +## and may be a scalar or two-element vector with values between 0 and 1. +## A value of 0 represents no curvature of the side, whereas a value of 1 +## means that the side is entirely curved into the arc of a circle. +## If @var{curv} is a two-element vector, then the first element is the ## curvature along the x-axis of the patch and the second along y-axis. ## ## If @var{curv} is a scalar, it represents the curvature of the shorter of the