KdTree icon indicating copy to clipboard operation
KdTree copied to clipboard

Add documentation

Open ForNeVeR opened this issue 9 years ago • 7 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.

ForNeVeR avatar Mar 06 '16 10:03 ForNeVeR

Agreed :+1:

codeandcats avatar Mar 06 '16 10:03 codeandcats

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

james-gould avatar Sep 02 '16 13:09 james-gould

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

codeandcats avatar Sep 03 '16 02:09 codeandcats

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

james-gould avatar Sep 03 '16 13:09 james-gould

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

KingKnecht avatar Sep 16 '16 10:09 KingKnecht

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

RobThree avatar Aug 07 '18 08:08 RobThree

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

stephanmg avatar Jan 27 '20 19:01 stephanmg