changeset 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 55eeb7f0850b
children d603f1229301 37ddca7ad9cb
files scripts/geometry/dsearchn.m
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/geometry/dsearchn.m	Wed Sep 01 16:19:09 2021 -0400
+++ b/scripts/geometry/dsearchn.m	Tue Sep 14 13:27:48 2021 -0400
@@ -34,6 +34,10 @@
 ## If @var{outval} is supplied, then the values of @var{xi} that are not
 ## contained within one of the simplices @var{tri} are set to @var{outval}.
 ## Generally, @var{tri} is returned from @code{delaunayn (@var{x})}.
+##
+## The optional output @var{d} contains a column vector of distances between
+## the query points @var{xi} and the nearest simplex points @var{x}.
+##
 ## @seealso{dsearch, tsearch}
 ## @end deftypefn