Skip to content

Document generic parameters of KdTree #171

@Imberflur

Description

@Imberflur

KdTree has several parameters and it isn't immediately apparent what they all are. IMO, further documentation here would be very helpful (unless I missed some existing documentation!).

In particular for the parameter B, I ended up looking into the changelog and the implementation to figure out that this is the leaf node bucket size. Beyond what parameters like this are, any guidance on how they might affect performance would also be nice.

Other parameters are easier to infer due to their usage in methods and/or the trait requirements on them, but I could see some explicit documentation for them also being useful!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions