PointParallelHashGridSearcher.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_POINT_PARALLEL_HASH_GRID_SEARCHER_HPP
#define CUBBYFLOW_POINT_PARALLEL_HASH_GRID_SEARCHER_HPP

#include <Core/Matrix/Matrix.hpp>
#include <Core/Searcher/PointNeighborSearcher.hpp>

namespace CubbyFlow
{
template <size_t N>
class PointParallelHashGridSearcher final : public PointNeighborSearcher<N>
{
 public:
    CUBBYFLOW_NEIGHBOR_SEARCHER_TYPE_NAME(PointParallelHashGridSearcher, N)

    class Builder;

    using typename PointNeighborSearcher<N>::ForEachNearbyPointFunc;
    using PointNeighborSearcher<N>::Build;

    PointParallelHashGridSearcher(const Vector<size_t, N>& resolution,
                                  double gridSpacing);

    ~PointParallelHashGridSearcher() override = default;

    PointParallelHashGridSearcher(const PointParallelHashGridSearcher& other);

    PointParallelHashGridSearcher(
        PointParallelHashGridSearcher&& other) noexcept;

    PointParallelHashGridSearcher& operator=(
        const PointParallelHashGridSearcher& other);

    PointParallelHashGridSearcher& operator=(
        PointParallelHashGridSearcher&& other) noexcept;

    void Build(const ConstArrayView1<Vector<double, N>>& points) override;

    void Build(const ConstArrayView1<Vector<double, N>>& points,
               double maxSearchRadius) override;

    void ForEachNearbyPoint(
        const Vector<double, N>& origin, double radius,
        const ForEachNearbyPointFunc& callback) const override;

    [[nodiscard]] bool HasNearbyPoint(const Vector<double, N>& origin,
                                      double radius) const override;

    [[nodiscard]] ConstArrayView1<size_t> Keys() const;

    [[nodiscard]] ConstArrayView1<size_t> StartIndexTable() const;

    [[nodiscard]] ConstArrayView1<size_t> EndIndexTable() const;

    [[nodiscard]] ConstArrayView1<size_t> SortedIndices() const;

    [[nodiscard]] std::shared_ptr<PointNeighborSearcher<N>> Clone()
        const override;

    void Set(const PointParallelHashGridSearcher& other);

    void Serialize(std::vector<uint8_t>* buffer) const override;

    void Deserialize(const std::vector<uint8_t>& buffer) override;

    static Builder GetBuilder();

 private:
    friend class PointParallelHashGridSearcherTests;

    template <size_t M = N>
    static std::enable_if_t<M == 2, void> Serialize(
        const PointParallelHashGridSearcher<2>& searcher,
        std::vector<uint8_t>* buffer);

    template <size_t M = N>
    static std::enable_if_t<M == 3, void> Serialize(
        const PointParallelHashGridSearcher<3>& searcher,
        std::vector<uint8_t>* buffer);

    template <size_t M = N>
    static std::enable_if_t<M == 2, void> Deserialize(
        const std::vector<uint8_t>& buffer,
        PointParallelHashGridSearcher<2>& searcher);

    template <size_t M = N>
    static std::enable_if_t<M == 3, void> Deserialize(
        const std::vector<uint8_t>& buffer,
        PointParallelHashGridSearcher<3>& searcher);

    double m_gridSpacing = 1.0;
    Vector<ssize_t, N> m_resolution = Vector<ssize_t, N>::MakeConstant(1);
    Array1<Vector<double, N>> m_points;
    Array1<size_t> m_keys;
    Array1<size_t> m_startIndexTable;
    Array1<size_t> m_endIndexTable;
    Array1<size_t> m_sortedIndices;
};

using PointParallelHashGridSearcher2 = PointParallelHashGridSearcher<2>;

using PointParallelHashGridSearcher3 = PointParallelHashGridSearcher<3>;

using PointParallelHashGridSearcher2Ptr =
    std::shared_ptr<PointParallelHashGridSearcher2>;

using PointParallelHashGridSearcher3Ptr =
    std::shared_ptr<PointParallelHashGridSearcher3>;

template <size_t N>
class PointParallelHashGridSearcher<N>::Builder final
    : public PointNeighborSearcherBuilder<N>
{
 public:
    Builder() = default;

    ~Builder() override = default;

    Builder(const Builder& other) = delete;

    Builder(Builder&& other) noexcept = delete;

    Builder& operator=(const Builder& other) = delete;

    Builder& operator=(Builder&& other) noexcept = delete;

    Builder& WithResolution(const Vector<size_t, N>& resolution);

    Builder& WithGridSpacing(double gridSpacing);

    PointParallelHashGridSearcher<N> Build() const;

    std::shared_ptr<PointParallelHashGridSearcher<N>> MakeShared() const;

    std::shared_ptr<PointNeighborSearcher<N>> BuildPointNeighborSearcher()
        const override;

 private:
    Vector<size_t, N> m_resolution = Vector<size_t, N>::MakeConstant(64);
    double m_gridSpacing = 1.0;
};
}  // namespace CubbyFlow

#endif