Mercurial > octave
view libinterp/dldfcn/convhulln.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | aab79a1885cc |
children | 973db845cb43 |
line wrap: on
line source
/* Copyright (C) 2000-2015 Kai Habel 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 <http://www.gnu.org/licenses/>. */ /* 29. July 2000 - Kai Habel: first release 2002-04-22 Paul Kienzle * Use warning(...) function rather than writing to cerr 2006-05-01 Tom Holroyd * add support for consistent winding in all dimensions; output is * guaranteed to be simplicial. */ #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "oct-locbuf.h" #include "Cell.h" #include "defun-dld.h" #include "error.h" #include "errwarn.h" #include "ovl.h" #include "parse.h" #include "unwind-prot.h" #if defined (HAVE_QHULL) # include "oct-qhull.h" # if defined (NEED_QHULL_VERSION) char qh_version[] = "convhulln.oct 2007-07-24"; # endif static void close_fcn (FILE *f) { std::fclose (f); } static bool octave_qhull_dims_ok (octave_idx_type dim, octave_idx_type n, const char *who) { if (sizeof (octave_idx_type) > sizeof (int)) { int maxval = std::numeric_limits<int>::max (); if (dim > maxval || n > maxval) error ("%s: dimension too large for Qhull", who); } return true; } #endif DEFUN_DLD (convhulln, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{h} =} convhulln (@var{pts}) @deftypefnx {} {@var{h} =} convhulln (@var{pts}, @var{options}) @deftypefnx {} {[@var{h}, @var{v}] =} convhulln (@dots{}) Compute the convex hull of the set of points @var{pts}. @var{pts} is a matrix of size [n, dim] containing n points in a space of dimension dim. The hull @var{h} is an index vector into the set of points and specifies which points form the enclosing hull. 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 2D, 3D, 4D: @var{options} = @code{@{"Qt"@}} @item 5D and higher: @var{options} = @code{@{"Qt", "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. If the second output @var{v} is requested the volume of the enclosing convex hull is calculated.\n @seealso{convhull, delaunayn, voronoin} @end deftypefn */) { #if defined (HAVE_QHULL) int nargin = args.length (); if (nargin < 1 || nargin > 2) print_usage (); octave_value_list retval; Matrix points (args(0).matrix_value ()); const octave_idx_type dim = points.columns (); const octave_idx_type num_points = points.rows (); if (! octave_qhull_dims_ok (dim, num_points, "convhulln")) return retval; points = points.transpose (); std::string options; if (dim <= 4) options = " Qt"; else options = " Qt Qx"; if (nargin == 2) { if (args(1).is_string ()) options = " " + args(1).string_value (); else if (args(1).is_empty ()) ; // Use default options. else if (args(1).is_cellstr ()) { options = ""; Array<std::string> tmp = args(1).cellstr_value (); for (octave_idx_type i = 0; i < tmp.numel (); i++) options += " " + tmp(i); } else error ("convhulln: OPTIONS must be a string, cell array of strings, or empty"); } boolT ismalloc = false; octave::unwind_protect frame; // Replace the outfile pointer with stdout for debugging information. #if defined (OCTAVE_HAVE_WINDOWS_FILESYSTEM) && ! defined (OCTAVE_HAVE_POSIX_FILESYSTEM) FILE *outfile = std::fopen ("NUL", "w"); #else FILE *outfile = std::fopen ("/dev/null", "w"); #endif FILE *errfile = stderr; if (! outfile) error ("convhulln: unable to create temporary file for output"); frame.add_fcn (close_fcn, outfile); // qh_new_qhull command and points arguments are not const... std::string cmd = "qhull" + options; OCTAVE_LOCAL_BUFFER (char, cmd_str, cmd.length () + 1); strcpy (cmd_str, cmd.c_str ()); int exitcode = qh_new_qhull (dim, num_points, points.fortran_vec (), ismalloc, cmd_str, outfile, errfile); if (exitcode) error ("convhulln: qhull failed"); bool nonsimp_seen = false; octave_idx_type nf = qh num_facets; Matrix idx (nf, dim + 1); facetT *facet; octave_idx_type i = 0; FORALLfacets { octave_idx_type j = 0; if (! (nonsimp_seen || facet->simplicial || qh hull_dim == 2)) { nonsimp_seen = true; if (cmd.find ("QJ") != std::string::npos) // Should never happen with QJ. error ("convhulln: qhull failed: option 'QJ' returned non-simplicial facet"); } if (dim == 3) { setT *vertices = qh_facet3vertex (facet); vertexT *vertex, **vertexp; FOREACHvertex_ (vertices) idx(i, j++) = 1 + qh_pointid(vertex->point); qh_settempfree (&vertices); } else { if (facet->toporient ^ qh_ORIENTclock) { vertexT *vertex, **vertexp; FOREACHvertex_ (facet->vertices) idx(i, j++) = 1 + qh_pointid(vertex->point); } else { vertexT *vertex, **vertexp; FOREACHvertexreverse12_ (facet->vertices) idx(i, j++) = 1 + qh_pointid(vertex->point); } } if (j < dim) warning ("convhulln: facet %d only has %d vertices", i, j); i++; } // Remove extra dimension if all facets were simplicial. if (! nonsimp_seen) idx.resize (nf, dim, 0.0); if (nargout == 2) { // Calculate volume of convex hull, taken from qhull src/geom2.c. realT area; realT dist; FORALLfacets { if (! facet->normal) continue; if (facet->upperdelaunay && qh ATinfinity) continue; facet->f.area = area = qh_facetarea (facet); facet->isarea = True; if (qh DELAUNAY) { if (facet->upperdelaunay == qh UPPERdelaunay) qh totarea += area; } else { qh totarea += area; qh_distplane (qh interior_point, facet, &dist); qh totvol += -dist * area/ qh hull_dim; } } retval(1) = octave_value (qh totvol); } retval(0) = idx; // Free memory from Qhull qh_freeqhull (! qh_ALL); int curlong, totlong; qh_memfreeshort (&curlong, &totlong); if (curlong || totlong) warning ("convhulln: did not free %d bytes of long memory (%d pieces)", totlong, curlong); return retval; #else octave_unused_parameter (args); octave_unused_parameter (nargout); err_disabled_feature ("convhulln", "Qhull"); #endif } /* %!testif HAVE_QHULL %! cube = [0 0 0;1 0 0;1 1 0;0 1 0;0 0 1;1 0 1;1 1 1;0 1 1]; %! [h, v] = convhulln (cube, "Qt"); %! assert (size (h), [12 3]); %! h = sortrows (sort (h, 2), [1:3]); %! assert (h, [1 2 4; 1 2 6; 1 4 8; 1 5 6; 1 5 8; 2 3 4; 2 3 7; 2 6 7; 3 4 7; 4 7 8; 5 6 7; 5 7 8]); %! assert (v, 1, 10*eps); %! [h2, v2] = convhulln (cube); % Test defaut option = "Qt" %! assert (size (h2), size (h)); %! h2 = sortrows (sort (h2, 2), [1:3]); %! assert (h2, h); %! assert (v2, v, 10*eps); %!testif HAVE_QHULL %! cube = [0 0 0;1 0 0;1 1 0;0 1 0;0 0 1;1 0 1;1 1 1;0 1 1]; %! [h, v] = convhulln (cube, "QJ"); %! assert (size (h), [12 3]); %! assert (sortrows (sort (h, 2), [1:3]), [1 2 4; 1 2 5; 1 4 5; 2 3 4; 2 3 6; 2 5 6; 3 4 8; 3 6 7; 3 7 8; 4 5 8; 5 6 8; 6 7 8]); %! assert (v, 1.0, 1e6*eps); %!testif HAVE_QHULL %! tetrahedron = [1 1 1;-1 -1 1;-1 1 -1;1 -1 -1]; %! [h, v] = convhulln (tetrahedron); %! h = sortrows (sort (h, 2), [1 2 3]); %! assert (h, [1 2 3;1 2 4; 1 3 4; 2 3 4]); %! assert (v, 8/3, 10*eps); %!testif HAVE_QHULL %! triangle=[0 0; 1 1; 1 0; 1 2]; %! h = convhulln (triangle); %! assert (size (h), [3 2]); */