jagged_vector_view.hpp

/*
 * VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2021-2025 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/utils/type_traits.hpp"
#include "vecmem/utils/types.hpp"
 
// System include(s).
#include <cstddef>
#include <type_traits>
#include <vector>
 
namespace vecmem {
namespace data {
template <typename T>
class jagged_vector_view {
 
    static_assert(!std::is_same<std::remove_cv_t<T>, bool>::value,
                  "bool is not supported in VecMem containers");
 
public:
    using size_type = std::size_t;
    using value_type = vector_view<T>;
    using pointer = std::add_pointer_t<value_type>;
 
    jagged_vector_view() = default;
    VECMEM_HOST_AND_DEVICE
    jagged_vector_view(size_type size, pointer ptr, pointer host_ptr = nullptr);
 
    template <
        typename OTHERTYPE,
        std::enable_if_t<details::is_same_nc<T, OTHERTYPE>::value, bool> = true>
    VECMEM_HOST_AND_DEVICE jagged_vector_view(
        const jagged_vector_view<OTHERTYPE>& parent);
 
    template <
        typename OTHERTYPE,
        std::enable_if_t<details::is_same_nc<T, OTHERTYPE>::value, bool> = true>
    VECMEM_HOST_AND_DEVICE jagged_vector_view& operator=(
        const jagged_vector_view<OTHERTYPE>& rhs);
 
    template <
        typename OTHERTYPE,
        std::enable_if_t<std::is_same<std::remove_cv_t<T>,
                                      std::remove_cv_t<OTHERTYPE> >::value,
                         bool> = true>
    VECMEM_HOST_AND_DEVICE bool operator==(
        const jagged_vector_view<OTHERTYPE>& rhs) const;
 
    template <
        typename OTHERTYPE,
        std::enable_if_t<std::is_same<std::remove_cv_t<T>,
                                      std::remove_cv_t<OTHERTYPE> >::value,
                         bool> = true>
    VECMEM_HOST_AND_DEVICE bool operator!=(
        const jagged_vector_view<OTHERTYPE>& rhs) const;
 
    VECMEM_HOST_AND_DEVICE
    size_type size() const;
    VECMEM_HOST_AND_DEVICE
    size_type capacity() const;
 
    VECMEM_HOST_AND_DEVICE
    pointer ptr() const;
 
    VECMEM_HOST_AND_DEVICE
    pointer host_ptr() const;
 
private:
    size_type m_size;
 
    pointer m_ptr;
 
    pointer m_host_ptr;
 
};  // struct jagged_vector_view
 
template <typename T>
VECMEM_HOST std::vector<typename vector_view<T>::size_type> get_capacities(
    const jagged_vector_view<T>& data);
 
}  // namespace data
}  // namespace vecmem
 
// Include the implementation.
#include "vecmem/containers/impl/jagged_vector_view.ipp"