AlignedDynArray.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef GSFUtils_AlignedDynArray_H
#define GSFUtils_AlignedDynArray_H
#include <cstdlib>
#include <memory>
#include <type_traits>
namespace GSFUtils {

template<typename T, size_t ALIGNMENT>
struct AlignedDynArray
{
 
  // These come from the posix_memalign
  // which is the typical underlying implementation
  static_assert(ALIGNMENT != 0, "Zero alignment 0");
  static_assert(
    (ALIGNMENT & (ALIGNMENT - 1)) == 0,
    "Alignment not a power of 2");
  static_assert(
    (ALIGNMENT % sizeof(void*)) == 0,
    "Alignment not an integral multiple of sizeof(void*)");
  //Also we assert is POD
  static_assert(
    std::is_standard_layout_v<T>,
    "Type T is not standard layout");
  // Standard typedefs
  typedef T value_type;
  typedef T* pointer;
  typedef const T* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;
  typedef value_type* iterator;
  typedef const value_type* const_iterator;
  typedef std::size_t size_type;
  typedef std::ptrdiff_t difference_type;

  AlignedDynArray() = delete;

  AlignedDynArray(AlignedDynArray const&) = delete;

  AlignedDynArray& operator=(AlignedDynArray const&) = delete;

  explicit AlignedDynArray(const size_type n);

  explicit AlignedDynArray(const size_type n, const T& value);

  AlignedDynArray(AlignedDynArray&&) noexcept;

  AlignedDynArray& operator=(AlignedDynArray&&) noexcept;

  ~AlignedDynArray();

  pointer buffer() noexcept;

  const_pointer buffer() const noexcept;

  reference operator[](size_type pos) noexcept;

  const_reference operator[](size_type pos) const noexcept;

  iterator begin() noexcept;

  const_iterator begin() const noexcept;

  iterator end() noexcept;

  const_iterator end() const noexcept;

  size_type size() const noexcept;

  bool empty() const noexcept;
 
private:
  void cleanup();

  pointer m_buffer = nullptr;

  size_type m_size = 0;
};
 
} // namespace GSFUtils
 
// impl .icc
#include "TrkGaussianSumFilterUtils/AlignedDynArray.icc"
 
#endif