comparison scripts/plot/rectangle.m @ 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 fb93b94dfc82
children f511bfe00d14
comparison
equal deleted inserted replaced
12760:e8fe03bfc051 12761:13bcd62824a7
24 ## @deftypefnx {Function File} {} rectangle (@dots{}, "FaceColor", @var{fc}) 24 ## @deftypefnx {Function File} {} rectangle (@dots{}, "FaceColor", @var{fc})
25 ## @deftypefnx {Function File} {@var{h} =} rectangle (@dots{}) 25 ## @deftypefnx {Function File} {@var{h} =} rectangle (@dots{})
26 ## 26 ##
27 ## Draw rectangular patch defined by @var{pos} and @var{curv}. The variable 27 ## Draw rectangular patch defined by @var{pos} and @var{curv}. The variable
28 ## @code{@var{pos}(1 : 2)} defines the lower left-hand corner of the patch 28 ## @code{@var{pos}(1 : 2)} defines the lower left-hand corner of the patch
29 ## and @code{@var{pos}(3 : 4)} its width and height. By default the value of 29 ## and @code{@var{pos}(3 : 4)} defines its width and height. By default, the
30 ## @var{pos} is @var{[0, 0, 1, 1]}. 30 ## value of @var{pos} is @code{[0, 0, 1, 1]}.
31 ## 31 ##
32 ## The variable @var{curv} defines the curvature of the sides of the rectangle 32 ## The variable @var{curv} defines the curvature of the sides of the rectangle
33 ## and it can be a scalar or two-element vector with values between 0 and 1. 33 ## and may be a scalar or two-element vector with values between 0 and 1.
34 ## A value of 0 represents no curvature of the side, where as a value of 1 34 ## A value of 0 represents no curvature of the side, whereas a value of 1
35 ## means that the rectangular side is entirely curved into an arc of a circle. 35 ## means that the side is entirely curved into the arc of a circle.
36 ## If curvature is a two-element vector, then the first element is the 36 ## If @var{curv} is a two-element vector, then the first element is the
37 ## curvature along the x-axis of the patch and the second along y-axis. 37 ## curvature along the x-axis of the patch and the second along y-axis.
38 ## 38 ##
39 ## If @var{curv} is a scalar, it represents the curvature of the shorter of the 39 ## If @var{curv} is a scalar, it represents the curvature of the shorter of the
40 ## two sides of the rectangle and the curvature of the other side is defined 40 ## two sides of the rectangle and the curvature of the other side is defined
41 ## by 41 ## by