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_CONCEPTS_MESH_COMPONENTS_ADJACENT_VERTICES_H
#define VCL_CONCEPTS_MESH_COMPONENTS_ADJACENT_VERTICES_H
 
#include "component.h"
 
#include <vclib/concepts/const_correctness.h>
#include <vclib/concepts/iterators.h>
#include <vclib/concepts/ranges/range.h>
 
#include <vector>
 
namespace vcl::comp {
 
template<typename T>
concept HasAdjacentVertices = requires (
    T&&                                                     obj,
    typename RemoveRef<T>::AdjacentVertexType               v,
    typename RemoveRef<T>::AdjacentVertexIterator           it,
    typename RemoveRef<T>::ConstAdjacentVertexIterator      cIt,
    typename RemoveRef<T>::ConstAdjacentVertexIndexIterator cIIt,
    typename RemoveRef<T>::AdjacentVertexType*              vP,
    const typename RemoveRef<T>::AdjacentVertexType*        cVP,
    std::vector<typename RemoveRef<T>::AdjacentVertexType*> vec) {
    typename RemoveRef<T>::AdjacentVertexType;
    typename RemoveRef<T>::AdjacentVertexIterator;
    typename RemoveRef<T>::ConstAdjacentVertexIterator;
    typename RemoveRef<T>::ConstAdjacentVertexIndexIterator;
 
    { obj.adjVerticesNumber() } -> std::same_as<uint>;
 
    { obj.adjVertex(uint()) } -> std::convertible_to<decltype(cVP)>;
    { obj.adjVertexIndex(uint()) } -> std::same_as<uint>;
    { obj.adjVertexMod(int()) } -> std::convertible_to<decltype(cVP)>;
    { obj.adjVertexIndexMod(uint()) } -> std::same_as<uint>;
 
    { obj.containsAdjVertex(&v) } -> std::same_as<bool>;
    { obj.containsAdjVertex(uint()) } -> std::same_as<bool>;
    { obj.indexOfAdjVertex(&v) } -> std::same_as<uint>;
    { obj.indexOfAdjVertex(uint()) } -> std::same_as<uint>;
 
    { obj.adjVertexBegin() } -> InputIterator<decltype(cVP)>;
    { obj.adjVertexEnd() } -> InputIterator<decltype(cVP)>;
 
    { obj.adjVertexIndexBegin() } -> InputIterator<uint>;
    { obj.adjVertexIndexEnd() } -> InputIterator<uint>;
 
    { obj.adjVertices() } -> InputRange<decltype(cVP)>;
    { obj.adjVertexIndices() } -> InputRange<uint>;
 
    // non const requirements
    requires IsConst<T> || requires {
        { obj.adjVertex(uint()) } -> std::same_as<decltype(vP)>;
        { obj.adjVertexMod(int()) } -> std::same_as<decltype(vP)>;
 
        { obj.setAdjVertex(uint(), &v) } -> std::same_as<void>;
        { obj.setAdjVertex(uint(), uint()) } -> std::same_as<void>;
        { obj.setAdjVertex(it, &v) } -> std::same_as<void>;
        { obj.setAdjVertex(it, uint()) } -> std::same_as<void>;
        { obj.setAdjVertex(cIt, &v) } -> std::same_as<void>;
        { obj.setAdjVertex(cIt, uint()) } -> std::same_as<void>;
        { obj.setAdjVertex(cIIt, &v) } -> std::same_as<void>;
        { obj.setAdjVertex(cIIt, uint()) } -> std::same_as<void>;
        { obj.setAdjVertexMod(int(), &v) } -> std::same_as<void>;
        { obj.setAdjVertexMod(int(), uint()) } -> std::same_as<void>;
        { obj.setAdjVertices(vec) } -> std::same_as<void>;
 
        // for references components, the iterators returned by begin() and
        // end() are input iterators because they do not allow to modify the
        // content of the container (the only way to do that is by using the set
        // member functions). However, they allow to modify the elements
        // pointed by the iterators (const references components allow to
        // iterate only trough const pointers instead).
        { obj.adjVertexBegin() } -> InputIterator<decltype(vP)>;
        { obj.adjVertexEnd() } -> InputIterator<decltype(vP)>;
 
        { obj.adjVertices() } -> InputRange<decltype(vP)>;
    };
};
 
template<typename T>
concept HasOptionalAdjacentVertices =
    HasAdjacentVertices<T> &&
    IsOptionalComponent<typename RemoveRef<T>::AdjacentVertices>;
 
} // namespace vcl::comp
 
#endif // VCL_CONCEPTS_MESH_COMPONENTS_ADJACENT_VERTICES_H