Inconsistency between API docs and API implementations

[betterenvi]

In search_knn and search_nn, the APIs have an arg named dist, and the API docs say

dist is a distance function, expecting two points and returning distance value. Distance values can be any comparable type.

But in the implementations of the two APIs, only squared Euclidean distance is considered.

[stefankoegl]

search_knn will use Euclidean distance as a default if no own dist function is provided, see

kdtree/kdtree.py

Lines 417 to 420 in 587edc7

	if dist is None:
	get_dist = lambda n: n.dist(point)
	else:
	get_dist = lambda n: dist(n.data, point)

search_nn calls search_knn and passes along its dist parameter.

Maybe I'm missing something here. Can you please elaborate?

[betterenvi]

If no own dist function is provided, everything is fine. The API will break if dist function is provided and is not squared Euclidean distance, because the implementation uses this distance.

kdtree/kdtree.py

Lines 453 to 454 in 587edc7

	plane_dist = point[self.axis] - split_plane
	plane_dist2 = plane_dist * plane_dist

[stefankoegl]

I have implemented a fix in #43, which should address this issue. Please let me know if this works for you.