jagged_device_vector_iterator.hpp

/*
 * VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2021-2026 CERN for the benefit of the ACTS project
 *
 * Mozilla Public License Version 2.0
 */
#pragma once
 
// Local include(s).
#include "vecmem/containers/data/vector_view.hpp"
#include "vecmem/containers/device_vector.hpp"
#include "vecmem/utils/types.hpp"
 
// System include(s).
#include <cstddef>
#include <iterator>
#include <type_traits>
 
namespace vecmem {
namespace details {
 
template <typename TYPE>
class jagged_device_vector_iterator {
 
    // Make other specializations of the class a friend of this class.
    template <typename OTHERTYPE>
    friend class jagged_device_vector_iterator;
 
public:
 
    typedef data::vector_view<TYPE> data_type;
    typedef std::add_pointer_t<std::add_const_t<data_type>> data_pointer;
 
 
 
    typedef device_vector<TYPE> value_type;
    typedef std::ptrdiff_t difference_type;
    typedef value_type reference;
 
    class pointer {
 
    public:
        VECMEM_HOST_AND_DEVICE
        explicit pointer(const data_pointer data);
 
        VECMEM_HOST_AND_DEVICE
        value_type* operator->();
        VECMEM_HOST_AND_DEVICE
        const value_type* operator->() const;
 
    private:
        value_type m_vec;
 
    };  // class pointer
 
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator();
    VECMEM_HOST_AND_DEVICE
    explicit jagged_device_vector_iterator(data_pointer data);
    template <typename OTHERTYPE,
              std::enable_if_t<details::is_same_nc<TYPE, OTHERTYPE>::value,
                               bool> = true>
    VECMEM_HOST_AND_DEVICE jagged_device_vector_iterator(
        const data::vector_view<OTHERTYPE>* data);
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator(const jagged_device_vector_iterator& parent);
    template <typename OTHERTYPE,
              std::enable_if_t<details::is_same_nc<TYPE, OTHERTYPE>::value,
                               bool> = true>
    VECMEM_HOST_AND_DEVICE jagged_device_vector_iterator(
        const jagged_device_vector_iterator<OTHERTYPE>& parent);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator& operator=(
        const jagged_device_vector_iterator& rhs);
 
 
    VECMEM_HOST_AND_DEVICE
    reference operator*() const;
    VECMEM_HOST_AND_DEVICE
    pointer operator->() const;
    VECMEM_HOST_AND_DEVICE
    reference operator[](difference_type n) const;
 
 
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator& operator++();
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator operator++(int);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator& operator--();
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator operator--(int);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator operator+(difference_type n) const;
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator& operator+=(difference_type n);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator operator-(difference_type n) const;
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector_iterator& operator-=(difference_type n);
 
 
 
    VECMEM_HOST_AND_DEVICE
    bool operator==(const jagged_device_vector_iterator& other) const;
    VECMEM_HOST_AND_DEVICE
    bool operator!=(const jagged_device_vector_iterator& other) const;
 
 
private:
    data_pointer m_ptr;
 
};  // class jagged_device_vector_iterator
 
}  // namespace details
}  // namespace vecmem
 
namespace std {
 
template <typename T>
struct iterator_traits<vecmem::details::jagged_device_vector_iterator<T>> {
    typedef
        typename vecmem::details::jagged_device_vector_iterator<T>::value_type
            value_type;
    typedef typename vecmem::details::jagged_device_vector_iterator<
        T>::difference_type difference_type;
    typedef typename vecmem::details::jagged_device_vector_iterator<T>::pointer
        pointer;
    typedef
        typename vecmem::details::jagged_device_vector_iterator<T>::reference
            reference;
    typedef std::random_access_iterator_tag iterator_category;
};
 
}  // namespace std
 
// Include the implementation.
#include "vecmem/containers/impl/jagged_device_vector_iterator.ipp"