codeandcats / KdTree

A fast, generic, multi-dimensional Binary Search Tree written in C#

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add documentation

ForNeVeR opened this issue · comments

It would be very nice to provide some basic usage examples. While using the library (which is very good and solved my tasks) I was confused by multiple things:

  1. Add behavior (already reported in #4 and #5).
  2. Whether I need to call Balance() at all.
  3. That I should declare my own instance for TypeMath<T> and whether I need to Register it or pass to KdTree constructor or both.
commented

Agreed 👍

Has this been started? I can write up the documentation over the next few days when i have some free time.

commented

Hi @james-gould, that would be greatly appreciated.

Cool, I'm still tinkering with it at work so I'll more than likely add the docs next weekend.

Any news on this? Would be really helpful to know how to use this package.

#17 now provides a (very basic) example. Not closing since a lot more/better is needed.

Btw.: You write fast, do you have any benchmark to confirm this? And what do you mean by fast (Which operations)?