Merge branch 'get_allocator-doc' into 'develop'

get_allocator-doc

See merge request correaa/boost-multi!1980

Author: correaa

include/boost/multi/array.hpp

@@ -149,19 +149,23 @@ struct
 	using array_alloc = detail::array_allocator<typename multi::allocator_traits<DummyAlloc>::template rebind_alloc<T>>;
 
  public:
-	using detail::array_allocator<typename multi::allocator_traits<DummyAlloc>::template rebind_alloc<T>>::get_allocator;
-
-	/// Alloc
+	/// Allocator type (returned by `get_allocator()`)
 	using allocator_type = typename detail::array_allocator<typename multi::allocator_traits<DummyAlloc>::template rebind_alloc<T>>::allocator_type;  // NOLINT(readability-redundant-typename) needed for C++17
+
 	/// Layout type (generally a strided layout `multi::layout_t<D>`)
 	using layout_type    = typename array_ref<T, D, typename multi::allocator_traits<allocator_type>::pointer>::layout_type;  // NOLINT(readability-redundant-typename) needed for C++17
+
 	/// Associalted array value type (generally itself, `multi::array<element, dimensionality, allocator_type>`)
 	using decay_type     = array<T, D, allocator_type>;
 
-	[[deprecated]] auto operator new(std::size_t count) -> void* { return ::operator new(count); }
-	[[deprecated]] auto operator new(std::size_t count, void* ptr) -> void* { return ::operator new(count, ptr); }
+	/// returns the allocator that is used to acquire/release memory and to construct/destroy the elements in that memory
+	BOOST_MULTI_HD constexpr auto get_allocator() const -> allocator_type { return detail::array_allocator<
+	  typename allocator_traits<DummyAlloc>::template rebind_alloc<T>>::get_allocator(); }
+
+	/*[[deprecated]]*/ auto operator new(std::size_t count) -> void* { return ::operator new(count); }                  // overrides the deleted new operator in reference (base) class subarray
+	/*[[deprecated]]*/ auto operator new(std::size_t count, void* ptr) -> void* { return ::operator new(count, ptr); }  // overrides the deleted new operator in reference (base) class subarray
 
-	[[deprecated]] void operator delete(void* ptr) noexcept { ::operator delete(ptr); }  // this overrides the deleted delete operator in reference (base) class subarray
+	/*[[deprecated]]*/ void operator delete(void* ptr) noexcept { ::operator delete(ptr); }  // overrides the deleted delete operator in reference (base) class subarray
 
  protected:  // TODO(correaa) make private
 	/// Associated array reference type, also its base class  (generally `multi::array_ref<element, dimensionality, allocator_type>`)
@@ -867,7 +871,7 @@ struct
 	/// Random-access iterator in the leading dimension, in general they dereference to an immutable subarrays of lower dimension (`multi::const_subarray<...>`) or, for `D == 1`, to an element immutable reference (`T const&`)
 	using const_iterator = multi::detail::array_iterator<T, D, typename dynamic_array::element_ptr, true>;
 
-	friend auto get_allocator(dynamic_array const& self) -> allocator_type { return self.get_allocator(); }
+	// friend auto get_allocator(dynamic_array const& self) -> allocator_type { return self.get_allocator(); }
 
 	/// gets a const-pointer to a contigous range of size `.num_elements()` containing the data of the array
 	BOOST_MULTI_HD constexpr auto data_elements() const& -> element_const_ptr { return this->base_; }  // cppcheck-suppress duplInheritedMember ; to override

include/boost/multi/array_ref.hpp

@@ -1405,12 +1405,13 @@ class const_subarray : public array_types<T, D, ElementPtr, Layout> {
 	using default_allocator_type = typename multi::pointer_traits<const_subarray::element_ptr>::default_allocator_type;
 
  public:
+	/// returns the associated allocator
 	BOOST_MULTI_HD constexpr auto get_allocator() const -> default_allocator_type {
 		using multi::get_allocator;
 		return get_allocator(this->base());
 	}
 
-	BOOST_MULTI_FRIEND_CONSTEXPR auto get_allocator(const_subarray const& self) -> default_allocator_type { return self.get_allocator(); }
+	// BOOST_MULTI_FRIEND_CONSTEXPR auto get_allocator(const_subarray const& self) -> default_allocator_type { return self.get_allocator(); }
 
 	/// Associated type that this reference decays to (when true copies are needed)
 	using decay_type = array<std::decay_t<typename types::element>, D, typename multi::pointer_traits<typename const_subarray::element_ptr>::default_allocator_type>;

test/allocator.cpp

@@ -282,6 +282,8 @@ auto main() -> int {  // NOLINT(readability-function-cognitive-complexity,bugpro
 
 		multi::array<char, 2, std::pmr::polymorphic_allocator<char>> Barr({3, 2}, 'o', &pool);
 
+		BOOST_TEST( Aarr.get_allocator() == Barr.get_allocator() );
+
 		BOOST_TEST(( buffer != std::array<char, 13>{{'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C'}} ));
 
 #ifdef __GLIBCXX__