Mercurial > octave
comparison scripts/geometry/dsearchn.m @ 30193:6cc5315cdf2f stable
dsearchn.m: Added optional distance ouput description to docstring (bug #61156)
* dsearchn.m: Document optional output 'd'.
author | Nicholas R. Jankowski <jankowskin@asme.org> |
---|---|
date | Tue, 14 Sep 2021 13:27:48 -0400 |
parents | 0a5b15007766 |
children | d603f1229301 |
comparison
equal
deleted
inserted
replaced
30103:55eeb7f0850b | 30193:6cc5315cdf2f |
---|---|
32 ## @var{xi}. | 32 ## @var{xi}. |
33 ## | 33 ## |
34 ## If @var{outval} is supplied, then the values of @var{xi} that are not | 34 ## If @var{outval} is supplied, then the values of @var{xi} that are not |
35 ## contained within one of the simplices @var{tri} are set to @var{outval}. | 35 ## contained within one of the simplices @var{tri} are set to @var{outval}. |
36 ## Generally, @var{tri} is returned from @code{delaunayn (@var{x})}. | 36 ## Generally, @var{tri} is returned from @code{delaunayn (@var{x})}. |
37 ## | |
38 ## The optional output @var{d} contains a column vector of distances between | |
39 ## the query points @var{xi} and the nearest simplex points @var{x}. | |
40 ## | |
37 ## @seealso{dsearch, tsearch} | 41 ## @seealso{dsearch, tsearch} |
38 ## @end deftypefn | 42 ## @end deftypefn |
39 | 43 |
40 function [idx, d] = dsearchn (x, tri, xi, outval) | 44 function [idx, d] = dsearchn (x, tri, xi, outval) |
41 | 45 |