adjacent_edges.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_EDGES_H
#define VCL_MESH_COMPONENTS_ADJACENT_EDGES_H
 
#include "base/predicates.h"
#include "base/reference_container_component.h"
 
#include <vclib/base.h>
 
namespace vcl::comp {
 
template<
    bool STORE_INDICES,
    typename Edge,
    int  N,
    bool TTVN,
    typename ParentElemType = void,
    bool VERT               = false,
    bool OPT                = false>
class AdjacentEdges :
        public ReferenceContainerComponent<
            STORE_INDICES,
            AdjacentEdges<
                STORE_INDICES,
                Edge,
                N,
                TTVN,
                ParentElemType,
                VERT,
                OPT>,
            CompId::ADJACENT_EDGES,
            Edge,
            N,
            ParentElemType,
            VERT,
            OPT,
            TTVN>
{
    using Base = ReferenceContainerComponent<
        STORE_INDICES,
        AdjacentEdges<STORE_INDICES, Edge, N, TTVN, ParentElemType, VERT, OPT>,
        CompId::ADJACENT_EDGES,
        Edge,
        N,
        ParentElemType,
        VERT,
        OPT,
        TTVN>;
 
public:
    using AdjacentEdgeType = Edge;
 
    /* Iterator Types declaration */
 
    using AdjacentEdgeIterator           = Base::Iterator;
    using ConstAdjacentEdgeIterator      = Base::ConstIterator;
    using ConstAdjacentEdgeIndexIterator = Base::ConstIndexIterator;
 
    static const int ADJ_EDGE_NUMBER = Base::SIZE;
 
    /* Constructors */
 
    AdjacentEdges() = default;
 
    /* Member functions */
 
    uint adjEdgesNumber() const { return Base::size(); }
 
    Edge* adjEdge(uint i) { return Base::element(i); }
 
    const Edge* adjEdge(uint i) const { return Base::element(i); }
 
    uint adjEdgeIndex(uint i) const { return Base::elementIndex(i); }
 
    Edge* adjEdgeMod(int i) { return Base::elementMod(i); }
 
    const Edge* adjEdgeMod(int i) const { return Base::elementMod(i); }
 
    uint adjEdgeIndexMod(int i) const { return Base::elementIndexMod(i); }
 
    void setAdjEdge(uint i, Edge* e) { Base::setElement(i, e); }
 
    void setAdjEdge(uint i, uint ei) { Base::setElement(i, ei); }
 
    void setAdjEdge(ConstAdjacentEdgeIterator it, Edge* e)
    {
        Base::setElement(it, e);
    }
 
    void setAdjEdge(ConstAdjacentEdgeIterator it, uint ei)
    {
        Base::setElement(it, ei);
    }
 
    void setAdjEdge(ConstAdjacentEdgeIndexIterator it, Edge* e)
    {
        Base::setElement(it, e);
    }
 
    void setAdjEdge(ConstAdjacentEdgeIndexIterator it, uint ei)
    {
        Base::setElement(it, ei);
    }
 
    void setAdjEdgeMod(int i, Edge* e) { Base::setElementMod(i, e); }
 
    void setAdjEdgeMod(int i, uint ei) { Base::setElementMod(i, ei); }
 
    template<Range Rng>
    void setAdjEdges(Rng&& r) requires InputRange<Rng, Edge*>
    {
        Base::setElements(r);
    }
 
    template<Range Rng>
    void setAdjEdges(Rng&& r) requires InputRange<Rng, uint>
    {
        Base::setElements(r);
    }
 
    bool containsAdjEdge(const Edge* e) const
    {
        return Base::containsElement(e);
    }
 
    bool containsAdjEdge(uint ei) const { return Base::containsElement(ei); }
 
    uint indexOfAdjEdge(const Edge* e) const { return Base::indexOfElement(e); }
 
    uint indexOfAdjEdge(uint ei) const { return Base::indexOfElement(ei); }
 
    /* Member functions specific for dynamic vector of adjacent edges */
 
    void resizeAdjEdges(uint n) requires (N < 0 && !TTVN) { Base::resize(n); }
 
    void pushAdjEdge(Edge* e) requires (N < 0 && !TTVN) { Base::pushBack(e); }
 
    void pushAdjEdge(uint ei) requires (N < 0 && !TTVN) { Base::pushBack(ei); }
 
    void insertAdjEdge(uint i, Edge* e) requires (N < 0 && !TTVN)
    {
        Base::insert(i, e);
    }
 
    void insertAdjEdge(uint i, uint ei) requires (N < 0 && !TTVN)
    {
        Base::insert(i, ei);
    }
 
    void eraseAdjEdge(uint i) requires (N < 0 && !TTVN) { Base::erase(i); }
 
    void clearAdjEdges() requires (N < 0 && !TTVN) { Base::clear(); }
 
    /* Iterator Member functions */
 
    AdjacentEdgeIterator adjEdgeBegin() { return Base::elementBegin(); }
 
    AdjacentEdgeIterator adjEdgeEnd() { return Base::elementEnd(); }
 
    ConstAdjacentEdgeIterator adjEdgeBegin() const
    {
        return Base::elementBegin();
    }
 
    ConstAdjacentEdgeIterator adjEdgeEnd() const { return Base::elementEnd(); }
 
    ConstAdjacentEdgeIndexIterator adjEdgeIndexBegin() const
    {
        return Base::elementIndexBegin();
    }
 
    ConstAdjacentEdgeIndexIterator adjEdgeIndexEnd() const
    {
        return Base::elementIndexEnd();
    }
 
    View<AdjacentEdgeIterator> adjEdges() { return Base::elements(); }
 
    View<ConstAdjacentEdgeIterator> adjEdges() const
    {
        return Base::elements();
    }
 
    View<ConstAdjacentEdgeIndexIterator> adjEdgeIndices() const
    {
        return Base::elementIndices();
    }
 
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
        if constexpr (N < 0) {
            vcl::serialize(os, adjEdgesNumber());
        }
        for (uint i = 0; i < adjEdgesNumber(); ++i) {
            vcl::serialize(os, adjEdgeIndex(i));
        }
    }
 
    void deserialize(std::istream& is)
    {
        if constexpr (N < 0) {
            uint n;
            vcl::deserialize(is, n);
            Base::resize(n);
        }
        for (uint i = 0; i < adjEdgesNumber(); ++i) {
            uint aei;
            vcl::deserialize(is, aei);
            setAdjEdge(i, aei);
        }
    }
 
private:
    template<typename Element>
    void importIndicesFrom(const Element& e)
    {
        for (uint i = 0; i < e.adjEdgesNumber(); ++i) {
            setAdjEdge(i, e.adjEdgeIndex(i));
        }
    }
};
 
/* concepts */
 
template<typename T>
concept HasAdjacentEdges =
    BTIBTBB::IsDerivedFromSpecializationOfV<T, AdjacentEdges>;
 
template<typename T>
concept HasOptionalAdjacentEdges =
    HasAdjacentEdges<T> &&
    IsOptionalComponent<typename RemoveRef<T>::AdjacentEdges>;
 
template<typename T>
concept HasRightNumberOfAdjacentEdges =
    !comp::IsTiedToVertexNumber<typename RemoveRef<T>::AdjacentEdges> ||
    RemoveRef<T>::VERTEX_NUMBER == RemoveRef<T>::ADJ_EDGE_NUMBER;
 
template<typename T>
concept SanityCheckAdjacentEdges =
    !HasAdjacentEdges<T> || HasRightNumberOfAdjacentEdges<T>;
 
/* importFrom function */
 
template<
    bool STORE_INDICES,
    typename Edge,
    int  N,
    bool TTVN,
    typename ParentElemType,
    bool VERT,
    bool OPT>
template<typename Element>
void AdjacentEdges<STORE_INDICES, Edge, N, TTVN, ParentElemType, VERT, OPT>::
    importFrom(const Element& e, bool importRefs)
{
    if (importRefs) {
        if constexpr (HasAdjacentEdges<Element>) {
            if (isAdjacentEdgesAvailableOn(e)) {
                if constexpr (N > 0) {
                    // same static size
                    if constexpr (N == Element::ADJ_EDGE_NUMBER) {
                        importIndicesFrom(e);
                    }
                    // from dynamic to static, but dynamic size == static
                    // size
                    else if constexpr (Element::ADJ_EDGE_NUMBER < 0) {
                        if (e.adjEdgesNumber() == N) {
                            importIndicesFrom(e);
                        }
                    }
                    else {
                        // do not import in this case: cannot import from
                        // dynamic size != static size
                    }
                }
                else {
                    // from static/dynamic to dynamic size: need to resize
                    // first, then import
                    Base::resize(e.adjEdgesNumber());
                    importIndicesFrom(e);
                }
            }
        }
    }
}
 
/* Detector function to check if a class has AdjacentEdges available */
 
bool isAdjacentEdgesAvailableOn(const auto& element)
{
    return isComponentAvailableOn<CompId::ADJACENT_EDGES>(element);
}
 
} // namespace vcl::comp
 
#endif // VCL_MESH_COMPONENTS_ADJACENT_EDGES_H