Mercurial > hg > octave-nkf
annotate scripts/geometry/dsearchn.m @ 12575:d0b799dafede
Grammarcheck files for 3.4.1 release.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 04 Apr 2011 15:33:46 -0700 |
parents | c792872f8942 |
children | 72c96de7a403 |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 2007-2011 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 -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
20 ## @deftypefn {Function File} {@var{idx} =} dsearchn (@var{x}, @var{tri}, @var{xi}) |
6846 | 21 ## @deftypefnx {Function File} {@var{idx} =} dsearchn (@var{x}, @var{tri}, @var{xi}, @var{outval}) |
22 ## @deftypefnx {Function File} {@var{idx} =} dsearchn (@var{x}, @var{xi}) | |
23 ## @deftypefnx {Function File} {[@var{idx}, @var{d}] =} dsearchn (@dots{}) | |
12575
d0b799dafede
Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
24 ## Return the index @var{idx} or the closest point in @var{x} to the elements |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
7017
diff
changeset
|
25 ## @var{xi}. If @var{outval} is supplied, then the values of @var{xi} that are |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
26 ## not contained within one of the simplices @var{tri} are set to |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
27 ## @var{outval}. Generally, @var{tri} is returned from @code{delaunayn |
6823 | 28 ## (@var{x})}. |
29 ## @seealso{dsearch, tsearch} | |
30 ## @end deftypefn | |
31 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
32 function [idx, d] = dsearchn (x, tri, xi, outval) |
6823 | 33 if (nargin < 2 || nargin > 4) |
34 print_usage (); | |
35 endif | |
36 | |
37 if (nargin == 2) | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
38 [idx, d] = __dsearchn__ (x, tri); |
6823 | 39 else |
40 [idx, d] = __dsearchn__ (x, xi); | |
41 if (nargin == 4) | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
42 idx2 = isnan (tsearchn (x, tri, xi)); |
6823 | 43 idx(idx2) = outval; |
44 d(idx2) = outval; | |
45 endif | |
46 endif | |
47 endfunction | |
48 | |
49 %!shared x, tri | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
50 %! x = [-1,-1;-1,1;1,-1]; |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
51 %! tri = [1,2,3]; |
6823 | 52 %!assert (dsearchn(x,tri,[1,1/3]), 3); |
53 %!assert (dsearchn(x,tri,[1,1/3],NaN), NaN); | |
54 %!assert (dsearchn(x,tri,[1,1/3],NA), NA); | |
55 %!assert (dsearchn(x,tri,[1/3,1]), 2); | |
56 %!assert (dsearchn(x,tri,[1/3,1],NaN), NaN); | |
57 %!assert (dsearchn(x,tri,[1/3,1],NA), NA); |