Skip to content
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.

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

Add documentation #7

Open
ForNeVeR opened this issue Mar 6, 2016 · 7 comments
Open

Add documentation #7

ForNeVeR opened this issue Mar 6, 2016 · 7 comments

Comments

@ForNeVeR
Copy link

ForNeVeR commented Mar 6, 2016

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 Allow for duplicate coordinates #4 and Inserted values are ignored if inserted with the same key #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.
@codeandcats
Copy link
Owner

Agreed 👍

@codeandcats codeandcats changed the title Add a documentation Add documentation Mar 28, 2016
@james-gould
Copy link

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

@codeandcats
Copy link
Owner

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

@james-gould
Copy link

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

@KingKnecht
Copy link

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

@RobThree
Copy link
Collaborator

RobThree commented Aug 7, 2018

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

@stephanmg
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants