Skip to content

DevAM-Tools/BKDTree

Repository files navigation

BKDTree

BKDTree offers a simple and high performant implementation of a growing only BKDTree<T> and a static KDTree<T> for C# and .NET.

A BKDTree and an KDTree allow storing and querying of multidimensional data. None of these support a method for removing items.

For nearest neighbor queries there are dedicated variants like MetricBKDTree<T, TMetric> and MetricKDTree<T, TMetric>. These only require a TMetric struct implementing IDimensionalMetric<T> which provides double GetDimension(in T value, int dimension). The comparison is derived automatically from the metric values.

icon

Usage

BKDTree<T, TComparer> or KDTree<T, TComparer> require a struct implementing IDimensionalComparer<T> with int Compare(in T left, in T right, int dimension).

MetricBKDTree<T, TMetric> and MetricKDTree<T, TMetric> support nearest neighbor queries and only require IDimensionalMetric<T> with double GetDimension(in T value, int dimension) for calculating euclidean distances. The comparison is automatically derived from the metric values.

Contribution

Contributions are welcome.

License

MIT License

Copyright (c) 2024 DevAM

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages