jagged_device_vector.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/jagged_vector_view.hpp"
#include "vecmem/containers/details/jagged_device_vector_iterator.hpp"
#include "vecmem/containers/details/reverse_iterator.hpp"
#include "vecmem/containers/device_vector.hpp"
#include "vecmem/utils/type_traits.hpp"
#include "vecmem/utils/types.hpp"
 
// System include(s).
#include <cstddef>
#include <type_traits>
 
namespace vecmem {
 
template <typename T>
class jagged_device_vector {
 
public:
 
    using value_type = device_vector<T>;
    using size_type = std::size_t;
    using difference_type = std::ptrdiff_t;
 
    using reference = device_vector<T>;
    using const_reference = device_vector<std::add_const_t<T> >;
 
    using iterator = details::jagged_device_vector_iterator<T>;
    using const_iterator =
        details::jagged_device_vector_iterator<std::add_const_t<T> >;
    using reverse_iterator = details::reverse_iterator<iterator>;
    using const_reverse_iterator = details::reverse_iterator<const_iterator>;
 
 
    VECMEM_HOST_AND_DEVICE
    explicit jagged_device_vector(data::jagged_vector_view<T> data);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector(const jagged_device_vector& parent);
 
    VECMEM_HOST_AND_DEVICE
    jagged_device_vector& operator=(const jagged_device_vector& rhs);
 
 
    VECMEM_HOST_AND_DEVICE
    reference at(size_type pos);
    VECMEM_HOST_AND_DEVICE
    const_reference at(size_type pos) const;
 
    VECMEM_HOST_AND_DEVICE
    reference operator[](size_type pos);
    VECMEM_HOST_AND_DEVICE
    const_reference operator[](size_type pos) const;
 
    VECMEM_HOST_AND_DEVICE
    reference front();
    VECMEM_HOST_AND_DEVICE
    const_reference front() const;
 
    VECMEM_HOST_AND_DEVICE
    reference back();
    VECMEM_HOST_AND_DEVICE
    const_reference back() const;
 
 
 
    VECMEM_HOST_AND_DEVICE
    iterator begin();
    VECMEM_HOST_AND_DEVICE
    const_iterator begin() const;
    VECMEM_HOST_AND_DEVICE
    const_iterator cbegin() const;
 
    VECMEM_HOST_AND_DEVICE
    iterator end();
    VECMEM_HOST_AND_DEVICE
    const_iterator end() const;
    VECMEM_HOST_AND_DEVICE
    const_iterator cend() const;
 
    VECMEM_HOST_AND_DEVICE
    reverse_iterator rbegin();
    VECMEM_HOST_AND_DEVICE
    const_reverse_iterator rbegin() const;
    VECMEM_HOST_AND_DEVICE
    const_reverse_iterator crbegin() const;
 
    VECMEM_HOST_AND_DEVICE
    reverse_iterator rend();
    VECMEM_HOST_AND_DEVICE
    const_reverse_iterator rend() const;
    VECMEM_HOST_AND_DEVICE
    const_reverse_iterator crend() const;
 
 
 
    VECMEM_HOST_AND_DEVICE
    bool empty(void) const;
 
    VECMEM_HOST_AND_DEVICE
    size_type size(void) const;
 
    VECMEM_HOST_AND_DEVICE
    size_type max_size() const;
    VECMEM_HOST_AND_DEVICE
    size_type capacity() const;
 
 
private:
    size_type m_size;
 
    typename data::jagged_vector_view<T>::pointer m_ptr;
 
};  // class jagged_device_vector
 
}  // namespace vecmem
 
// Include the implementation.
#include "vecmem/containers/impl/jagged_device_vector.ipp"