octave: scripts/geometry/delaunayn.m annotate

annotate scripts/geometry/delaunayn.m @ 20852:516bb87ea72e

2015 Code Sprint: remove class of function from docstring for all m-files.

author	Rik <rik@octave.org>
date	Sat, 12 Dec 2015 07:31:00 -0800
parents	7503499a252b
children	f7f97d7e9294

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19596 diff changeset	1 ## Copyright (C) 2007-2015 David Bateman
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: 6846 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: 6846 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: 6846 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: 6846 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 --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	20 ## @deftypefn {} {@var{T} =} delaunayn (@var{pts})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	21 ## @deftypefnx {} {@var{T} =} delaunayn (@var{pts}, @var{options})
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	22 ## Compute the Delaunay triangulation for an N-dimensional set of points.
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## The Delaunay triangulation is a tessellation of the convex hull of a set of
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	25 ## points such that no N-sphere defined by the N-triangles contains any other
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## points from the set.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	27 ##
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	28 ## The input matrix @var{pts} of size [n, dim] contains n points in a space of
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## dimension dim. The return matrix @var{T} has size [m, dim+1]. Each row of
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## @var{T} contains a set of indices back into the original set of points
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	31 ## @var{pts} which describes a simplex of dimension dim. For example, a 2-D
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	32 ## simplex is a triangle and 3-D simplex is a tetrahedron.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	33 ##
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	34 ## 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: 11587 diff changeset	35 ## 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: 11587 diff changeset	36 ## 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: 11587 diff changeset	37 ## @url{http://www.qhull.org/html/qh-quick.htm#options}.
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	38 ## The default options depend on the dimension of the input:
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	39 ##
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	40 ## @itemize
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	41 ## @item 2-D and 3-D: @var{options} = @code{@{"Qt", "Qbb", "Qc", "Qz"@}}
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	42 ##
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	43 ## @item 4-D and higher: @var{options} = @code{@{"Qt", "Qbb", "Qc", "Qx"@}}
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	44 ## @end itemize
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	45 ##
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	46 ## If @var{options} is not present or @code{[]} then the default arguments are
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	47 ## used. Otherwise, @var{options} replaces the default argument list.
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	48 ## To append user options to the defaults it is necessary to repeat the
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	49 ## default arguments in @var{options}. Use a null string to pass no arguments.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	50 ##
19164 ba167badef9f Deprecate delaunay3 and extend delaunay to 3-D inputs. Rik <rik@octave.org> parents: 17744 diff changeset	51 ## @seealso{delaunay, convhulln, voronoin, trimesh, tetramesh}
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	52 ## @end deftypefn
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	53
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	54 function T = delaunayn (pts, varargin)
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	56 if (nargin < 1)
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	57 print_usage ();
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	58 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	59
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	60 T = __delaunayn__ (pts, varargin{:});
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	61
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 if (isa (pts, "single"))
19172 4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	63 tol = 1e3 * eps ("single");
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7208 diff changeset	64 else
19172 4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	65 tol = 1e3 * eps;
7795 df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7208 diff changeset	66 endif
df9519e9990c Handle single precision eps values David Bateman <dbateman@free.fr> parents: 7208 diff changeset	67
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	68 ## Try to remove the zero volume simplices. The volume of the i-th simplex is
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	69 ## given by abs(det(pts(T(i,1:end-1),:)-pts(T(i,2:end),:)))/prod(1:n)
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	70 ## (reference http://en.wikipedia.org/wiki/Simplex). Any simplex with a
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71 ## relative volume less than some arbitrary criteria is rejected. The
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	72 ## criteria we use is the volume of the simplex corresponding to an
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	73 ## orthogonal simplex is equal edge length all equal to the edge length of
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 ## the original simplex. If the relative volume is 1e3*eps then the simplex
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 ## is rejected. Note division of the two volumes means that the factor
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	76 ## prod(1:n) is dropped.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	77 idx = [];
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78 [nt, n] = size (T);
19164 ba167badef9f Deprecate delaunay3 and extend delaunay to 3-D inputs. Rik <rik@octave.org> parents: 17744 diff changeset	79 ## FIXME: Vectorize this for loop or convert delaunayn to .oct function
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	80 for i = 1:nt
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	81 X = pts(T(i,1:end-1),:) - pts(T(i,2:end),:);
19172 4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	82 if (abs (det (X)) / sqrt (sumsq (X, 2)) < tol)
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	83 idx(end+1) = i;
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	84 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	85 endfor
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	86 T(idx,:) = [];
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	87
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	88 endfunction
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	89
7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	90
19172 4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	91 %!testif HAVE_QHULL
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	92 %! x = [-1, 0; 0, 1; 1, 0; 0, -1; 0, 0];
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	93 %! assert (sortrows (sort (delaunayn (x), 2)), [1,2,5;1,4,5;2,3,5;3,4,5]);
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	94
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	95 ## Test 3-D input
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	96 %!testif HAVE_QHULL
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	97 %! x = [-1, -1, 1, 0, -1]; y = [-1, 1, 1, 0, -1]; z = [0, 0, 0, 1, 1];
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	98 %! assert (sortrows (sort (delaunayn ([x(:) y(:) z(:)]), 2)), [1,2,3,4;1,2,4,5])
4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	99
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	100 ## FIXME: Need tests for delaunayn
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	101
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	102 ## Input validation tests
19172 4318cb91deac delaunayn.m: Slight performance increase and addition of BIST tests. Rik <rik@octave.org> parents: 19164 diff changeset	103 %!error delaunayn ()
13746 7ff0bdc3dc4c Revamp geometry functions dependent on Qhull (Bug #34604, Bug #33346) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	104

Mercurial > octave

annotate scripts/geometry/delaunayn.m @ 20852:516bb87ea72e