Skip to content

feature/kdtree-distance-with-optional-k #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tremblap merged 1 commit into from
Dec 13, 2022
Merged

feature/kdtree-distance-with-optional-k #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/KDTree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,17 @@

:arg buffer: A |buffer| containing a data point to match against. The number of frames in the buffer must match the dimensionality of the :fluid-obj:`DataSet` the tree was fitted to.

:arg k: The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest.
:arg k: (optional) The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest.

:arg action: A function that will run when the query returns, whose argument is an array of distances.

Returns the identifiers of the ``k`` points nearest to the one passed.

:message kNearestDist:

:arg buffer: A |buffer| containing a data point to match against. The number of frames in the buffer must match the dimensionality of the :fluid-obj:`DataSet` the tree was fitted to.

:arg k: (optional) The number of nearest neighbours to return. The identifiers will be sorted, beginning with the nearest.

:arg action: A function that will run when the query returns, whose argument is an array of distances.

Expand Down