Mercurial > octave
view libinterp/corefcn/__lin_interpn__.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 | b571fc85953f |
children | 278fc29b69ca |
line wrap: on
line source
/* Copyright (C) 2007-2015 Alexander Barth 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/>. */ #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "lo-ieee.h" #include "dNDArray.h" #include "oct-locbuf.h" #include "defun.h" #include "error.h" #include "ovl.h" // equivalent to isvector.m template <typename T> bool isvector (const T& array) { const dim_vector dv = array.dims (); return dv.ndims () == 2 && (dv(0) == 1 || dv(1) == 1); } // lookup a value in a sorted table (lookup.m) template <typename T> octave_idx_type lookup (const T *x, octave_idx_type n, T y) { octave_idx_type j; if (x[0] < x[n-1]) { // increasing x if (y > x[n-1] || y < x[0]) return -1; #if defined (EXHAUSTIF) for (j = 0; j < n - 1; j++) { if (x[j] <= y && y <= x[j+1]) return j; } #else octave_idx_type j0 = 0; octave_idx_type j1 = n - 1; while (true) { j = (j0+j1)/2; if (y <= x[j+1]) { if (x[j] <= y) return j; j1 = j; } if (x[j] <= y) j0 = j; } #endif } else { // decreasing x // previous code with x -> -x and y -> -y if (y > x[0] || y < x[n-1]) return -1; #if defined (EXHAUSTIF) for (j = 0; j < n - 1; j++) { if (x[j+1] <= y && y <= x[j]) return j; } #else octave_idx_type j0 = 0; octave_idx_type j1 = n - 1; while (true) { j = (j0+j1)/2; if (y >= x[j+1]) { if (x[j] >= y) return j; j1 = j; } if (x[j] >= y) j0 = j; } #endif } } // n-dimensional linear interpolation template <typename T> void lin_interpn (int n, const octave_idx_type *size, const octave_idx_type *scale, octave_idx_type Ni, T extrapval, const T **x, const T *v, const T **y, T *vi) { bool out = false; int bit; OCTAVE_LOCAL_BUFFER (T, coef, 2*n); OCTAVE_LOCAL_BUFFER (octave_idx_type, index, n); // loop over all points for (octave_idx_type m = 0; m < Ni; m++) { // loop over all dimensions for (int i = 0; i < n; i++) { index[i] = lookup (x[i], size[i], y[i][m]); out = index[i] == -1; if (out) break; else { octave_idx_type j = index[i]; coef[2*i+1] = (y[i][m] - x[i][j])/(x[i][j+1] - x[i][j]); coef[2*i] = 1 - coef[2*i+1]; } } if (out) vi[m] = extrapval; else { vi[m] = 0; // loop over all corners of hypercube (1<<n = 2^n) for (int i = 0; i < (1 << n); i++) { T c = 1; octave_idx_type l = 0; // loop over all dimensions for (int j = 0; j < n; j++) { // test if the jth bit in i is set bit = i >> j & 1; l += scale[j] * (index[j] + bit); c *= coef[2*j+bit]; } vi[m] += c * v[l]; } } } } template <typename T, typename M> octave_value lin_interpn (int n, M *X, const M V, M *Y) { octave_value retval; M Vi = M (Y[0].dims ()); OCTAVE_LOCAL_BUFFER (const T *, y, n); OCTAVE_LOCAL_BUFFER (octave_idx_type, size, n); for (int i = 0; i < n; i++) { y[i] = Y[i].data (); size[i] = V.dims ()(i); } OCTAVE_LOCAL_BUFFER (const T *, x, n); OCTAVE_LOCAL_BUFFER (octave_idx_type, scale, n); const T *v = V.data (); T *vi = Vi.fortran_vec (); octave_idx_type Ni = Vi.numel (); T extrapval = octave_NA; // offset in memory of each dimension scale[0] = 1; for (int i = 1; i < n; i++) scale[i] = scale[i-1] * size[i-1]; // tests if X[0] is a vector, if yes, assume that all elements of X are // in the ndgrid format. if (! isvector (X[0])) { for (int i = 0; i < n; i++) { if (X[i].dims () != V.dims ()) error ("interpn: incompatible size of argument number %d", i+1); M tmp = M (dim_vector (size[i], 1)); for (octave_idx_type j = 0; j < size[i]; j++) tmp(j) = X[i](scale[i]*j); X[i] = tmp; } } for (int i = 0; i < n; i++) { if (! isvector (X[i]) && X[i].numel () != size[i]) error ("interpn: incompatible size of argument number %d", i+1); x[i] = X[i].data (); } lin_interpn (n, size, scale, Ni, extrapval, x, v, y, vi); retval = Vi; return retval; } // Perform @var{n}-dimensional interpolation. Each element of then // @var{n}-dimensional array @var{v} represents a value at a location // given by the parameters @var{x1}, @var{x2},...,@var{xn}. The parameters // @var{x1}, @var{x2}, @dots{}, @var{xn} are either @var{n}-dimensional // arrays of the same size as the array @var{v} in the \"ndgrid\" format // or vectors. The parameters @var{y1}, @var{y2}, @dots{}, @var{yn} are // all @var{n}-dimensional arrays of the same size and represent the // points at which the array @var{vi} is interpolated. // //This function only performs linear interpolation. DEFUN (__lin_interpn__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{vi} =} __lin_interpn__ (@var{x1}, @var{x2}, @dots{}, @var{xn}, @var{v}, @var{y1}, @var{y2}, @dots{}, @var{yn}) Undocumented internal function. @end deftypefn */) { int nargin = args.length (); if (nargin < 2 || nargin % 2 == 0) print_usage (); octave_value retval; // dimension of the problem int n = (nargin-1)/2; if (args(n).is_single_type ()) { OCTAVE_LOCAL_BUFFER (FloatNDArray, X, n); OCTAVE_LOCAL_BUFFER (FloatNDArray, Y, n); const FloatNDArray V = args(n).float_array_value (); for (int i = 0; i < n; i++) { X[i] = args(i).float_array_value (); Y[i] = args(n+i+1).float_array_value (); if (Y[0].dims () != Y[i].dims ()) error ("interpn: incompatible size of argument number %d", n+i+2); } retval = lin_interpn<float, FloatNDArray> (n, X, V, Y); } else { OCTAVE_LOCAL_BUFFER (NDArray, X, n); OCTAVE_LOCAL_BUFFER (NDArray, Y, n); const NDArray V = args(n).array_value (); for (int i = 0; i < n; i++) { X[i] = args(i).array_value (); Y[i] = args(n+i+1).array_value (); if (Y[0].dims () != Y[i].dims ()) error ("interpn: incompatible size of argument number %d", n+i+2); } retval = lin_interpn<double, NDArray> (n, X, V, Y); } return retval; } /* ## No test needed for internal helper function. %!assert (1) */