adjacent_vertices.h

/*****************************************************************************
 * VCLib                                                                     *
 * Visual Computing Library                                                  *
 *                                                                           *
 * Copyright(C) 2021-2025                                                    *
 * Visual Computing Lab                                                      *
 * ISTI - Italian National Research Council                                  *
 *                                                                           *
 * All rights reserved.                                                      *
 *                                                                           *
 * This program is free software; you can redistribute it and/or modify      *
 * it under the terms of the Mozilla Public License Version 2.0 as published *
 * by the Mozilla Foundation; either version 2 of the License, or            *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This program is distributed in the hope that it will be useful,           *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the              *
 * Mozilla Public License Version 2.0                                        *
 * (https://www.mozilla.org/en-US/MPL/2.0/) for more details.                *
 ****************************************************************************/
 
#ifndef VCL_MESH_COMPONENTS_ADJACENT_VERTICES_H
#define VCL_MESH_COMPONENTS_ADJACENT_VERTICES_H
 
#include "base/predicates.h"
#include "base/reference_container_component.h"
 
#include <vclib/base.h>
 
namespace vcl::comp {
 
template<
    bool STORE_INDICES,
    typename Vertex,
    typename ParentElemType = void,
    bool VERT               = false,
    bool OPT                = false>
class AdjacentVertices :
        public ReferenceContainerComponent<
            STORE_INDICES,
            AdjacentVertices<STORE_INDICES, Vertex, ParentElemType, VERT, OPT>,
            CompId::ADJACENT_VERTICES,
            Vertex,
            -1,
            ParentElemType,
            VERT,
            OPT,
            false>
{
    using Base = ReferenceContainerComponent<
        STORE_INDICES,
        AdjacentVertices<STORE_INDICES, Vertex, ParentElemType, VERT, OPT>,
        CompId::ADJACENT_VERTICES,
        Vertex,
        -1,
        ParentElemType,
        VERT,
        OPT,
        false>;
 
public:
    using AdjacentVertexType = Vertex;
 
    /* Iterator Types declaration */
 
    using AdjacentVertexIterator           = Base::Iterator;
    using ConstAdjacentVertexIterator      = Base::ConstIterator;
    using ConstAdjacentVertexIndexIterator = Base::ConstIndexIterator;
 
    /* Constructors */
 
    AdjacentVertices() = default;
 
    /* Member functions */
 
    uint adjVerticesNumber() const { return Base::size(); }
 
    Vertex* adjVertex(uint i) { return Base::element(i); }
 
    const Vertex* adjVertex(uint i) const { return Base::element(i); }
 
    uint adjVertexIndex(uint i) const { return Base::elementIndex(i); }
 
    Vertex* adjVertexMod(int i) { return Base::elementMod(i); }
 
    const Vertex* adjVertexMod(int i) const { return Base::elementMod(i); }
 
    uint adjVertexIndexMod(int i) const { return Base::elementIndexMod(i); }
 
    void setAdjVertex(uint i, Vertex* v) { Base::setElement(i, v); }
 
    void setAdjVertex(uint i, uint vi) { Base::setElement(i, vi); }
 
    void setAdjVertex(ConstAdjacentVertexIterator it, Vertex* v)
    {
        Base::setElement(it, v);
    }
 
    void setAdjVertex(ConstAdjacentVertexIterator it, uint vi)
    {
        Base::setElement(it, vi);
    }
 
    void setAdjVertex(ConstAdjacentVertexIndexIterator it, Vertex* v)
    {
        Base::setElement(it, v);
    }
 
    void setAdjVertex(ConstAdjacentVertexIndexIterator it, uint vi)
    {
        Base::setElement(it, vi);
    }
 
    void setAdjVertexMod(int i, Vertex* v) { Base::setElementMod(i, v); }
 
    void setAdjVertexMod(int i, uint vi) { Base::setElementMod(i, vi); }
 
    template<Range Rng>
    void setAdjVertices(Rng&& r) requires InputRange<Rng, Vertex*>
    {
        Base::setElements(r);
    }
 
    template<Range Rng>
    void setAdjVertices(Rng&& r) requires InputRange<Rng, uint>
    {
        Base::setElements(r);
    }
 
    bool containsAdjVertex(const Vertex* v) const
    {
        return Base::containsElement(v);
    }
 
    bool containsAdjVertex(uint vi) const { return Base::containsElement(vi); }
 
    uint indexOfAdjVertex(const Vertex* v) const
    {
        return Base::indexOfElement(v);
    }
 
    uint indexOfAdjVertex(uint vi) const { return Base::indexOfElement(vi); }
 
    void resizeAdjVertices(uint n) { Base::resize(n); }
 
    void pushAdjVertex(Vertex* v) { Base::pushBack(v); }
 
    void pushAdjVertex(uint vi) { Base::pushBack(vi); }
 
    void insertAdjVertex(uint i, Vertex* v) { Base::insert(i, v); }
 
    void insertAdjVertex(uint i, uint vi) { Base::insert(i, vi); }
 
    void eraseAdjVertex(uint i) { Base::erase(i); }
 
    void clearAdjVertices() { Base::clear(); }
 
    /* Iterator Member functions */
 
    AdjacentVertexIterator adjVertexBegin() { return Base::elementBegin(); }
 
    AdjacentVertexIterator adjVertexEnd() { return Base::elementEnd(); }
 
    ConstAdjacentVertexIterator adjVertexBegin() const
    {
        return Base::elementBegin();
    }
 
    ConstAdjacentVertexIterator adjVertexEnd() const
    {
        return Base::elementEnd();
    }
 
    ConstAdjacentVertexIndexIterator adjVertexIndexBegin() const
    {
        return Base::elementIndexBegin();
    }
 
    ConstAdjacentVertexIndexIterator adjVertexIndexEnd() const
    {
        return Base::elementIndexEnd();
    }
 
    View<AdjacentVertexIterator> adjVertices() { return Base::elements(); }
 
    View<ConstAdjacentVertexIterator> adjVertices() const
    {
        return Base::elements();
    }
 
    View<ConstAdjacentVertexIndexIterator> adjVertexIndices() const
    {
        return Base::elementIndices();
    }
 
    // dummy member to discriminate between AdjacentVertices and
    // VertexHalfEdgePointers
    void __adjacentVertices() const {}
 
protected:
    // Component interface functions
    template<typename Element>
    void importFrom(const Element& e, bool importRefs = true);
 
    void serialize(std::ostream& os) const
    {
        // regardless of the type of the container (indices or pointers), the
        // serialization is always done using the indices
 
        vcl::serialize(os, adjVerticesNumber());
        for (uint i = 0; i < adjVerticesNumber(); ++i) {
            vcl::serialize(os, adjVertexIndex(i));
        }
    }
 
    void deserialize(std::istream& is)
    {
        uint n;
        vcl::deserialize(is, n);
        resizeAdjVertices(n);
 
        for (uint i = 0; i < adjVerticesNumber(); ++i) {
            uint aei;
            vcl::deserialize(is, aei);
            setAdjVertex(i, aei);
        }
    }
 
private:
    template<typename Element>
    void importIndicesFrom(const Element& e)
    {
        for (uint i = 0; i < e.adjVerticesNumber(); ++i) {
            setAdjVertex(i, e.adjVertexIndex(i));
        }
    }
};
 
/* concepts */
 
template<typename T>
concept HasAdjacentVertices =
    BTTBB::IsDerivedFromSpecializationOfV<T, AdjacentVertices>;
 
template<typename T>
concept HasOptionalAdjacentVertices =
    HasAdjacentVertices<T> &&
    IsOptionalComponent<typename RemoveRef<T>::AdjacentVertices>;
 
/* importFrom function */
 
template<
    bool STORE_INDICES,
    typename Vertex,
    typename ParentElemType,
    bool VERT,
    bool OPT>
template<typename Element>
void AdjacentVertices<STORE_INDICES, Vertex, ParentElemType, VERT, OPT>::
    importFrom(const Element& e, bool importRefs)
{
    if (importRefs) {
        if constexpr (HasAdjacentVertices<Element>) {
            if (isAdjacentVerticesAvailableOn(e)) {
                // from static/dynamic to dynamic size: need to resize
                // first, then import
                resizeAdjVertices(e.adjVerticesNumber());
                importIndicesFrom(e);
            }
        }
    }
}
 
/* Detector function to check if a class has AdjacentVertices available */
 
bool isAdjacentVerticesAvailableOn(const auto& element)
{
    return isComponentAvailableOn<CompId::ADJACENT_VERTICES>(element);
}
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_ADJACENT_VERTICES_H