NearestNeighborQueryEngine.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_NEAREST_NEIGHBOR_QUERY_ENGINE_HPP
#define CUBBYFLOW_NEAREST_NEIGHBOR_QUERY_ENGINE_HPP

#include <Core/Matrix/Matrix.hpp>

#include <functional>
#include <limits>

namespace CubbyFlow
{
template <typename T, size_t N>
struct NearestNeighborQueryResult
{
    const T* item = nullptr;
    double distance = std::numeric_limits<double>::max();
};

template <typename T>
using NearestNeighborQueryResult2 = NearestNeighborQueryResult<T, 2>;

template <typename T>
using NearestNeighborQueryResult3 = NearestNeighborQueryResult<T, 3>;

template <typename T, size_t N>
using NearestNeighborDistanceFunc =
    std::function<double(const T&, const Vector<double, N>&)>;

template <typename T>
using NearestNeighborDistanceFunc2 = NearestNeighborDistanceFunc<T, 2>;

template <typename T>
using NearestNeighborDistanceFunc3 = NearestNeighborDistanceFunc<T, 3>;

template <typename T, size_t N>
class NearestNeighborQueryEngine
{
 public:
    NearestNeighborQueryEngine() = default;

    virtual ~NearestNeighborQueryEngine() = default;

    NearestNeighborQueryEngine(const NearestNeighborQueryEngine& other) =
        default;

    NearestNeighborQueryEngine(NearestNeighborQueryEngine&& other) noexcept =
        default;

    NearestNeighborQueryEngine& operator=(
        const NearestNeighborQueryEngine& other) = default;

    NearestNeighborQueryEngine& operator=(
        NearestNeighborQueryEngine&& other) noexcept = default;

    [[nodiscard]] virtual NearestNeighborQueryResult<T, N> Nearest(
        const Vector<double, N>& pt,
        const NearestNeighborDistanceFunc<T, N>& distanceFunc) const = 0;
};

template <typename T>
using NearestNeighborQueryEngine2 = NearestNeighborQueryEngine<T, 2>;

template <typename T>
using NearestNeighborQueryEngine3 = NearestNeighborQueryEngine<T, 3>;
}  // namespace CubbyFlow

#endif