TheRock/rocm-libraries/projects/rocthrust/thrust/detail/contiguous_storage.h

/*
 *  Copyright 2008-2018 NVIDIA Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

#pragma once

#include <thrust/detail/config.h>

#if defined(_CCCL_IMPLICIT_SYSTEM_HEADER_GCC)
#  pragma GCC system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_CLANG)
#  pragma clang system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_MSVC)
#  pragma system_header
#endif // no system header

#include <thrust/detail/allocator/allocator_traits.h>
#include <thrust/detail/execution_policy.h>
#include <thrust/iterator/detail/normal_iterator.h>
#include <thrust/sequence_access.h>

THRUST_NAMESPACE_BEGIN

namespace detail
{

struct copy_allocator_t
{};

// XXX parameter T is redundant with parameter Alloc
template <typename T, typename Alloc>
class contiguous_storage
{
private:
  using alloc_traits = thrust::detail::allocator_traits<Alloc>;

public:
  using allocator_type  = Alloc;
  using value_type      = T;
  using pointer         = typename alloc_traits::pointer;
  using const_pointer   = typename alloc_traits::const_pointer;
  using size_type       = typename alloc_traits::size_type;
  using difference_type = typename alloc_traits::difference_type;
  using reference       = typename alloc_traits::reference;
  using const_reference = typename alloc_traits::const_reference;

  using iterator       = thrust::detail::normal_iterator<pointer>;
  using const_iterator = thrust::detail::normal_iterator<const_pointer>;

  THRUST_EXEC_CHECK_DISABLE
  THRUST_HOST_DEVICE explicit contiguous_storage(const allocator_type& alloc = allocator_type());

  THRUST_EXEC_CHECK_DISABLE
  THRUST_HOST_DEVICE explicit contiguous_storage(size_type n, const allocator_type& alloc = allocator_type());

  THRUST_EXEC_CHECK_DISABLE
  THRUST_HOST_DEVICE explicit contiguous_storage(copy_allocator_t, const contiguous_storage& other);

  THRUST_EXEC_CHECK_DISABLE
  THRUST_HOST_DEVICE explicit contiguous_storage(copy_allocator_t, const contiguous_storage& other, size_type n);

  THRUST_EXEC_CHECK_DISABLE
  THRUST_HOST_DEVICE ~contiguous_storage();

  THRUST_HOST_DEVICE size_type size() const;

  THRUST_HOST_DEVICE size_type max_size() const;

  THRUST_HOST_DEVICE pointer data();

  THRUST_HOST_DEVICE const_pointer data() const;

  THRUST_HOST_DEVICE iterator begin();

  THRUST_HOST_DEVICE const_iterator begin() const;

  THRUST_HOST_DEVICE iterator end();

  THRUST_HOST_DEVICE const_iterator end() const;

  THRUST_HOST_DEVICE reference operator[](size_type n);

  THRUST_HOST_DEVICE const_reference operator[](size_type n) const;

  THRUST_HOST_DEVICE allocator_type get_allocator() const;

  // note that allocate does *not* automatically call deallocate
  THRUST_HOST_DEVICE void allocate(size_type n);

  THRUST_HOST_DEVICE void deallocate() noexcept;

  THRUST_HOST_DEVICE void swap(contiguous_storage& x);

  THRUST_HOST_DEVICE void value_initialize_n(iterator first, size_type n);

  THRUST_HOST_DEVICE void uninitialized_fill_n(iterator first, size_type n, const value_type& value);

  template <typename InputIterator>
  THRUST_HOST_DEVICE iterator uninitialized_copy(InputIterator first, InputIterator last, iterator result);

  template <typename System, typename InputIterator>
  THRUST_HOST_DEVICE iterator uninitialized_copy(
    thrust::execution_policy<System>& from_system, InputIterator first, InputIterator last, iterator result);

  template <typename InputIterator, typename Size>
  THRUST_HOST_DEVICE iterator uninitialized_copy_n(InputIterator first, Size n, iterator result);

  template <typename System, typename InputIterator, typename Size>
  THRUST_HOST_DEVICE iterator
  uninitialized_copy_n(thrust::execution_policy<System>& from_system, InputIterator first, Size n, iterator result);

  THRUST_HOST_DEVICE void destroy(iterator first, iterator last) noexcept;

  THRUST_HOST_DEVICE void deallocate_on_allocator_mismatch(const contiguous_storage& other) noexcept;

  THRUST_HOST_DEVICE void
  destroy_on_allocator_mismatch(const contiguous_storage& other, iterator first, iterator last) noexcept;

  THRUST_HOST_DEVICE void set_allocator(const allocator_type& alloc);

  THRUST_HOST_DEVICE bool is_allocator_not_equal(const allocator_type& alloc) const;

  THRUST_HOST_DEVICE bool is_allocator_not_equal(const contiguous_storage& other) const;

  THRUST_HOST_DEVICE void propagate_allocator(const contiguous_storage& other);

  THRUST_HOST_DEVICE void propagate_allocator(contiguous_storage& other);

  // allow move assignment for a sane implementation of allocator propagation
  // on move assignment
  THRUST_HOST_DEVICE contiguous_storage& operator=(contiguous_storage&& other);

  THRUST_SYNTHESIZE_SEQUENCE_ACCESS(contiguous_storage, const_iterator);

private:
  // XXX we could inherit from this to take advantage of empty base class optimization
  allocator_type m_allocator;

  iterator m_begin;

  size_type m_size;

  // disallow assignment
  contiguous_storage& operator=(const contiguous_storage& x);

  THRUST_HOST_DEVICE void swap_allocators(true_type, const allocator_type&);

  THRUST_HOST_DEVICE void swap_allocators(false_type, allocator_type&);

  THRUST_HOST_DEVICE bool is_allocator_not_equal_dispatch(true_type, const allocator_type&) const;

  THRUST_HOST_DEVICE bool is_allocator_not_equal_dispatch(false_type, const allocator_type&) const;

  THRUST_HOST_DEVICE void deallocate_on_allocator_mismatch_dispatch(true_type, const contiguous_storage& other) noexcept;

  THRUST_HOST_DEVICE void
  deallocate_on_allocator_mismatch_dispatch(false_type, const contiguous_storage& other) noexcept;

  THRUST_HOST_DEVICE void destroy_on_allocator_mismatch_dispatch(
    true_type, const contiguous_storage& other, iterator first, iterator last) noexcept;

  THRUST_HOST_DEVICE void destroy_on_allocator_mismatch_dispatch(
    false_type, const contiguous_storage& other, iterator first, iterator last) noexcept;

  THRUST_HOST_DEVICE void propagate_allocator_dispatch(true_type, const contiguous_storage& other);

  THRUST_HOST_DEVICE void propagate_allocator_dispatch(false_type, const contiguous_storage& other);

  THRUST_HOST_DEVICE void propagate_allocator_dispatch(true_type, contiguous_storage& other);

  THRUST_HOST_DEVICE void propagate_allocator_dispatch(false_type, contiguous_storage& other);

  friend THRUST_HOST_DEVICE void swap(contiguous_storage& lhs, contiguous_storage& rhs) noexcept(noexcept(lhs.swap(rhs)))
  {
    lhs.swap(rhs);
  }
}; // end contiguous_storage

} // namespace detail

THRUST_NAMESPACE_END

#include <thrust/detail/contiguous_storage.inl>