DevAM.BKDTree 1.1.0

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 any queying of multidimensional data. Non of these support a method for removing items.

For nearest neighbor queries there are dediated variants like MetricBKDTree<T> and MetricKDTree<T>. As nearest neighbor queries require to calculate euclidean distance between values T must implement IMetricTreeItem<in T>.

<img src="./icon.png" width="256" height="256"/>

Usage

Items of type T that shall be stored in a BKDTree<T> or a KDTree<T> must implement the interface ITreeItem<T> with its method CompareDimensionTo().

public interface ITreeItem<in T>
{
    int CompareDimensionTo(T other, int dimension);
}

For nearest neighbor queries there are dediated variants MetricBKDTree<T> and MetricKDTree<T> while T must implement IMetricTreeItem<in T> to allow calculation of euclidean distance between values.

public interface IMetricTreeItem<in T> : ITreeItem<T>
{
    double GetDimension(int dimension);
}

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.