piercedKernelIterator.hpp

/*---------------------------------------------------------------------------*\
 *
 *  bitpit
 *
 *  Copyright (C) 2015-2021 OPTIMAD engineering Srl
 *
 *  -------------------------------------------------------------------------
 *  License
 *  This file is part of bitpit.
 *
 *  bitpit is free software: you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License v3 (LGPL)
 *  as published by the Free Software Foundation.
 *
 *  bitpit 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 GNU Lesser General Public
 *  License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with bitpit. If not, see <http://www.gnu.org/licenses/>.
 *
\*---------------------------------------------------------------------------*/
 
#ifndef __BITPIT_PIERCED_KERNEL_ITERATOR_HPP__
#define __BITPIT_PIERCED_KERNEL_ITERATOR_HPP__
 
#include <cassert>
#include <iterator>
#include <limits>
#include <type_traits>
 
namespace bitpit{
 
template<typename id_t>
class PiercedKernel;

template<typename id_t = long>
class PiercedKernelIterator
{
 
template<typename PK_id_t>
friend class PiercedKernel;
 
template<typename PSI_value_t, typename PSI_id_t, typename PSI_value_no_cv_t>
friend class PiercedStorageIterator;
 
private:
    template<typename PK_id_t>
    using Kernel = PiercedKernel<PK_id_t>;

    typedef Kernel<id_t> kernel_t;
 
public:
    using iterator_category = std::bidirectional_iterator_tag;

    using value_type = id_t;

    using difference_type = std::ptrdiff_t;

    using pointer = id_t *;

    using reference = id_t &;

    typedef kernel_t kernel_type;

    typedef id_t id_type;
 
    // Constructors
    PiercedKernelIterator();
 
    // General methods
    void swap(PiercedKernelIterator& other) noexcept;
 
    const kernel_type & getKernel() const;
 
    // Methos to extract information on the current element
    id_t getId(const id_t &fallback = -1) const noexcept;
    std::size_t getRawIndex() const noexcept;
    std::size_t getPos() const noexcept;
 
    // Operators
    PiercedKernelIterator& operator++();
    PiercedKernelIterator operator++(int);
 
    PiercedKernelIterator& operator--();
    PiercedKernelIterator operator--(int);
 
    const id_t & operator*() const;
    const id_t * operator->() const;

    bool operator==(const PiercedKernelIterator &rhs) const
    {
        return (m_kernel == rhs.m_kernel) && (m_pos == rhs.m_pos);
    }

    bool operator!=(const PiercedKernelIterator &rhs) const
    {
        return (m_kernel != rhs.m_kernel) || (m_pos != rhs.m_pos);
    }
 
private:
    const kernel_t *m_kernel;

    std::size_t m_pos;
 
    // Constructors
    explicit PiercedKernelIterator(const kernel_t *kernel, std::size_t pos);
 
};
 
}
 
// Include the implementation
#include "piercedKernelIterator.tpp"
 
#endif