Mercurial > hg > octave-nkf

annotate scripts/geometry/voronoin.m @ 19022:5eca3080c7cd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge Stefan's changesets onto default after verification.
author Rik <rik@octave.org>
date Sat, 14 Jun 2014 13:24:46 -0700
parents d63878346099
children 446c46af4b42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 16344
diff changeset
1 ## Copyright (C) 2000-2013 Kai Habel
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
2 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
4 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
8 ## your option) any later version.
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
9 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
14 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7007
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
18
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
20 ## @deftypefn {Function File} {[@var{C}, @var{F}] =} voronoin (@var{pts})
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {[@var{C}, @var{F}] =} voronoin (@var{pts}, @var{options})
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
22 ## Compute N-dimensional Voronoi facets. The input matrix @var{pts}
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
23 ## of size [n, dim] contains n points in a space of dimension dim.
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 9051
diff changeset
24 ## @var{C} contains the points of the Voronoi facets. The list @var{F}
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
25 ## contains, for each facet, the indices of the Voronoi points.
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
26 ##
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
27 ## An optional second argument, which must be a string or cell array of strings,
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
28 ## contains options passed to the underlying qhull command.
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
29 ## See the documentation for the Qhull library for details
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
30 ## @url{http://www.qhull.org/html/qh-quick.htm#options}.
16344
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
31 ##
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
32 ## The default options depend on the dimension of the input:
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
33 ##
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
34 ## @itemize
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
35 ## @item 2-D and 3-D: @var{options} = @code{@{"Qbb"@}}
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
36 ##
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
37 ## @item 4-D and higher: @var{options} = @code{@{"Qbb", "Qx"@}}
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
38 ## @end itemize
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
39 ##
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
40 ## If @var{options} is not present or @code{[]} then the default arguments are
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
41 ## used. Otherwise, @var{options} replaces the default argument list.
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
42 ## To append user options to the defaults it is necessary to repeat the
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
43 ## default arguments in @var{options}. Use a null string to pass no arguments.
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
44 ##
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
45 ## @seealso{voronoi, convhulln, delaunayn}
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
46 ## @end deftypefn
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
47
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
48 ## Author: Kai Habel <kai.habel@gmx.de>
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
49 ## First Release: 20/08/2000
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
50
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
51 ## 2003-12-14 Rafael Laboissiere <rafael@laboissiere.net>
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
52 ## Added optional second argument to pass options to the underlying
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
53 ## qhull command
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
54
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
55 function [C, F] = voronoin (pts, options)
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
56
6826
8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe]
jwe
parents: 6823
diff changeset
57 if (nargin != 1 && nargin != 2)
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
58 print_usage ();
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
59 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
60
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
61 [np, dim] = size (pts);
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
62
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
63 if (np <= dim)
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
64 error ("voronoin: number of points must be greater than their dimension");
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
65 endif
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
66
13879
440d7914cf01 fix regression in __voronoi__ and convhulln option processing
John W. Eaton <jwe@octave.org>
parents: 13746
diff changeset
67 caller = "voronoin";
440d7914cf01 fix regression in __voronoi__ and convhulln option processing
John W. Eaton <jwe@octave.org>
parents: 13746
diff changeset
68
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
69 if (nargin == 1)
13879
440d7914cf01 fix regression in __voronoi__ and convhulln option processing
John W. Eaton <jwe@octave.org>
parents: 13746
diff changeset
70 [C, F] = __voronoi__ (caller, pts);
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
71 else
13879
440d7914cf01 fix regression in __voronoi__ and convhulln option processing
John W. Eaton <jwe@octave.org>
parents: 13746
diff changeset
72 [C, F] = __voronoi__ (caller, pts, options);
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
73 endif
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
74
6823
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman]
dbateman
parents:
diff changeset
75 endfunction
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
76
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
77
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
78 %% FIXME: Need functional tests
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
79
16344
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
80 %!error voronoin ()
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
81 %!error voronoin (1,2,3)
5c2f590fe734 voronoin.m: Update documentation about which options are passed to QHull.
Rik <rik@octave.org>
parents: 14138
diff changeset
82 %!error <number of points must be greater than their dimension> voronoin ([1 2])
13746
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346)
Rik <octave@nomad.inbox5.com>
parents: 13203
diff changeset
83