device_array.hpp

/* VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2021 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/details/reverse_iterator.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, std::size_t N>
class device_array {
 
public:
 
    typedef T value_type;
    typedef std::size_t size_type;
    typedef std::ptrdiff_t difference_type;
 
    typedef value_type& reference;
    typedef const value_type& const_reference;
    typedef value_type* pointer;
    typedef const value_type* const_pointer;
 
    typedef pointer iterator;
    typedef const_pointer const_iterator;
    typedef vecmem::details::reverse_iterator<iterator> reverse_iterator;
    typedef vecmem::details::reverse_iterator<const_iterator>
        const_reverse_iterator;
 
 
    VECMEM_HOST_AND_DEVICE
    explicit device_array(const data::vector_view<value_type>& data);
    template <
        typename OTHERTYPE,
        std::enable_if_t<details::is_same_nc<T, OTHERTYPE>::value, bool> = true>
    VECMEM_HOST_AND_DEVICE explicit device_array(
        const data::vector_view<OTHERTYPE>& data);
    VECMEM_HOST_AND_DEVICE
    device_array(const device_array& parent);
 
    VECMEM_HOST_AND_DEVICE
    device_array& operator=(const device_array& 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
    pointer data();
    VECMEM_HOST_AND_DEVICE
    const_pointer data() 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
    constexpr bool empty() const;
    VECMEM_HOST_AND_DEVICE
    constexpr size_type size() const;
    VECMEM_HOST_AND_DEVICE
    constexpr size_type max_size() const;
 
 
private:
    pointer m_ptr;
 
};  // class device_array
 
}  // namespace vecmem
 
// Include the implementation.
#include "vecmem/containers/impl/device_array.ipp"