knnGraphKNearestQuery.h

/*
 This Source Code Form is subject to the terms of the Mozilla Public
 License, v. 2.0. If a copy of the MPL was not distributed with this
 file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
 
#pragma once
 
#include "../../query.h"
#include "../Iterator/knnGraphKNearestIterator.h"
 
namespace Ponca
{
 
    template <typename Traits>
    class StaticKnnGraphBase; // Need forward declaration to avoid mutual inclusion
 
#ifndef PARSED_WITH_DOXYGEN
    struct KnnGraphQueryOutputType : public QueryOutputBase
    {
        using OutputParameter = typename QueryOutputBase::DummyOutputParameter;
    };
#endif
 
    template <typename Traits>
    class KnnGraphKNearestQuery
#ifdef PARSED_WITH_DOXYGEN
        : public KNearestIndexQuery<typename Traits::IndexType, typename Traits::DataPoint::Scalar>
#else
        // we skip output because we don't need it: k is static, and already stored in the index array
        : public Query<QueryInputIsIndex<typename Traits::IndexType>, KnnGraphQueryOutputType>
#endif
    {
    public:
        using Iterator = KnnGraphKNearestIterator<const typename Traits::IndexType*, typename Traits::IndexType>;
#ifdef PARSED_WITH_DOXYGEN
        using QueryType = KNearestIndexQuery<typename Traits::IndexType, typename Traits::DataPoint::Scalar>;
#else
        using QueryType = Query<QueryInputIsIndex<typename Traits::IndexType>, KnnGraphQueryOutputType>;
#endif
        using Self = KnnGraphKNearestQuery<Traits>;
 
    public:
        PONCA_MULTIARCH inline KnnGraphKNearestQuery(const StaticKnnGraphBase<Traits>* graph, int index)
            : QueryType(index), m_graph(graph)
        {
        }
        PONCA_MULTIARCH inline Self& operator()(int index) { return QueryType::template operator()<Self>(index); }
 
        PONCA_MULTIARCH [[nodiscard]] inline Iterator begin() const
        {
            return Iterator(m_graph->getIndexPtr()) + QueryType::input() * m_graph->k();
        }
 
        PONCA_MULTIARCH [[nodiscard]] inline Iterator end() const
        {
            return Iterator(m_graph->getIndexPtr()) + (QueryType::input() + 1) * m_graph->k();
        }
 
    protected:
        const StaticKnnGraphBase<Traits>* m_graph{nullptr};
    };
 
} // namespace Ponca