Mercurial > octave-nkf
comparison scripts/geometry/voronoi.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 18 Jul 2010 20:35:16 -0700 |
parents | 3140cb7a05a1 |
children | 01ddaedd6ad5 |
comparison
equal
deleted
inserted
replaced
10792:91342260063e | 10793:be55736a0783 |
---|---|
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {} voronoi (@var{x}, @var{y}) | 20 ## @deftypefn {Function File} {} voronoi (@var{x}, @var{y}) |
21 ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle") | 21 ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle") |
22 ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle", @var{options}) | 22 ## @deftypefnx {Function File} {} voronoi (@var{x}, @var{y}, "plotstyle", @var{options}) |
23 ## @deftypefnx {Function File} {[@var{vx}, @var{vy}] =} voronoi (@dots{}) | 23 ## @deftypefnx {Function File} {[@var{vx}, @var{vy}] =} voronoi (@dots{}) |
24 ## plots Voronoi diagram of points @code{(@var{x}, @var{y})}. | 24 ## plots Voronoi diagram of points @code{(@var{x}, @var{y})}. |
25 ## The Voronoi facets with points at infinity are not drawn. | 25 ## The Voronoi facets with points at infinity are not drawn. |
26 ## [@var{vx}, @var{vy}] = voronoi(@dots{}) returns the vertices instead of plotting the | 26 ## [@var{vx}, @var{vy}] = voronoi(@dots{}) returns the vertices instead of |
27 ## plotting the | |
27 ## diagram. plot (@var{vx}, @var{vy}) shows the Voronoi diagram. | 28 ## diagram. plot (@var{vx}, @var{vy}) shows the Voronoi diagram. |
28 ## | 29 ## |
29 ## A fourth optional argument, which must be a string, contains extra options | 30 ## A fourth optional argument, which must be a string, contains extra options |
30 ## passed to the underlying qhull command. See the documentation for the | 31 ## passed to the underlying qhull command. See the documentation for the |
31 ## Qhull library for details. | 32 ## Qhull library for details. |