Mercurial > hg > octave-lyh
annotate scripts/geometry/dsearch.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 16f53d29049f |
rev | line source |
---|---|
8920 | 1 ## Copyright (C) 2007, 2008 David Bateman |
6823 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
6823 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
6823 | 18 |
19 ## -*- texinfo -*- | |
6846 | 20 ## @deftypefn {Function File} {@var{idx} =} dsearch (@var{x}, @var{y}, @var{tri}, @var{xi}, @var{yi}) |
21 ## @deftypefnx {Function File} {@var{idx} =} dsearch (@var{x}, @var{y}, @var{tri}, @var{xi}, @var{yi}, @var{s}) | |
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
7017
diff
changeset
|
22 ## Returns the index @var{idx} or the closest point in @code{@var{x}, @var{y}} |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
23 ## to the elements @code{[@var{xi}(:), @var{yi}(:)]}. The variable @var{s} is |
6823 | 24 ## accepted but ignored for compatibility. |
25 ## @seealso{dsearchn, tsearch} | |
26 ## @end deftypefn | |
27 | |
28 function idx = dsearch (x, y, t, xi, yi, s) | |
29 if (nargin < 5 || nargin > 6) | |
6826 | 30 print_usage (); |
6823 | 31 endif |
6826 | 32 idx = __dsearchn__ ([x(:), y(:)], [xi(:), yi(:)]); |
6823 | 33 endfunction |
34 | |
35 %!shared x, y, tri | |
36 %! x = [-1;-1;1]; | |
37 %! y = [-1;1;-1]; | |
38 %! tri = [1,2,3]; | |
39 %!assert (dsearch(x,y,tri,1,1/3), 3); | |
40 %!assert (dsearch(x,y,tri,1/3,1), 2); |