Mercurial > octave
view scripts/geometry/voronoin.m @ 30244:4fe897f5db8e
print_usage.m: Fix error on invalid texinfo (bug #61363).
* scripts/help/print_usage.m (get_usage_texinfo): Do not call __makeinfo__ if
help string doesn't contain a @def* macro.
author | Markus Mützel <markus.muetzel@gmx.de> |
---|---|
date | Thu, 21 Oct 2021 16:42:38 +0200 |
parents | 7854d5752dd2 |
children | 796f54d4ddbf |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2021 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {[@var{C}, @var{F}] =} voronoin (@var{pts}) ## @deftypefnx {} {[@var{C}, @var{F}] =} voronoin (@var{pts}, @var{options}) ## Compute N-dimensional Voronoi facets. ## ## The input matrix @var{pts} of size [n, dim] contains n points in a space of ## dimension dim. ## ## @var{C} contains the points of the Voronoi facets. The list @var{F} ## contains, for each facet, the indices of the Voronoi points. ## ## An optional second argument, which must be a string or cell array of ## strings, contains options passed to the underlying qhull command. See the ## documentation for the Qhull library for details ## @url{http://www.qhull.org/html/qh-quick.htm#options}. ## ## The default options depend on the dimension of the input: ## ## @itemize ## @item 2-D and 3-D: @var{options} = @code{@{"Qbb"@}} ## ## @item 4-D and higher: @var{options} = @code{@{"Qbb", "Qx"@}} ## @end itemize ## ## If @var{options} is not present or @code{[]} then the default arguments are ## used. Otherwise, @var{options} replaces the default argument list. ## To append user options to the defaults it is necessary to repeat the ## default arguments in @var{options}. Use a null string to pass no arguments. ## ## @seealso{voronoi, convhulln, delaunayn} ## @end deftypefn function [C, F] = voronoin (pts, options) if (nargin < 1) print_usage (); endif [np, dim] = size (pts); if (np <= dim) error ("voronoin: number of points must be greater than their dimension"); endif caller = "voronoin"; if (nargin == 1) [C, F] = __voronoi__ (caller, pts); else [C, F] = __voronoi__ (caller, pts, options); endif endfunction ## FIXME: Need functional tests %!error <Invalid call> voronoin () %!error <number of points must be greater than their dimension> voronoin ([1 2])