////////////////////////////////////////////////////////////////////////////// // // (C) Copyright Ion Gaztanaga 2015-2015. Distributed under the Boost // Software License, Version 1.0. (See accompanying file // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // // See http://www.boost.org/libs/container for documentation. // ////////////////////////////////////////////////////////////////////////////// #ifndef BOOST_CONTAINER_CONTAINER_SMALL_VECTOR_HPP #define BOOST_CONTAINER_CONTAINER_SMALL_VECTOR_HPP #ifndef BOOST_CONFIG_HPP # include #endif #if defined(BOOST_HAS_PRAGMA_ONCE) # pragma once #endif #include #include // container #include #include #include #include //new_allocator // container/detail #include #include //move #include #include //move/detail #if defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) #include #endif //std #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST) #include //for std::initializer_list #endif namespace boost { namespace container { #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED template > class small_vector_base; #endif //! A non-standard allocator used to implement `small_vector`. //! Users should never use it directly. It is described here //! for documentation purposes. //! //! This allocator inherits from a standard-conforming allocator //! and forwards member functions to the standard allocator except //! when internal storage is being used as memory source. //! //! This allocator is a "partially_propagable" allocator and //! defines `is_partially_propagable` as true_type. //! //! A partially propagable allocator means that not all storage //! allocatod by an instance of `small_vector_allocator` can be //! deallocated by another instance of this type, even if both //! instances compare equal or an instance is propagated to another //! one using the copy/move constructor or assignment. The storage that //! can never be propagated is identified by `storage_is_unpropagable(p)`. //! //! `boost::container::vector` supports partially propagable allocators //! fallbacking to deep copy/swap/move operations when internal storage //! is being used to store vector elements. //! //! `small_vector_allocator` assumes that will be instantiated as //! `boost::container::vector< T, small_vector_allocator >` //! and internal storage can be obtained downcasting that vector //! to `small_vector_base`. template class small_vector_allocator : public Allocator { typedef unsigned int allocation_type; #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED private: BOOST_COPYABLE_AND_MOVABLE(small_vector_allocator) BOOST_CONTAINER_FORCEINLINE const Allocator &as_base() const { return static_cast(*this); } BOOST_CONTAINER_FORCEINLINE Allocator &as_base() { return static_cast(*this); } #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED public: #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED typedef allocator_traits allocator_traits_type; #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED typedef typename allocator_traits::value_type value_type; typedef typename allocator_traits::pointer pointer; typedef typename allocator_traits::const_pointer const_pointer; typedef typename allocator_traits::reference reference; typedef typename allocator_traits::const_reference const_reference; typedef typename allocator_traits::size_type size_type; typedef typename allocator_traits::difference_type difference_type; typedef typename allocator_traits::void_pointer void_pointer; typedef typename allocator_traits::const_void_pointer const_void_pointer; typedef typename allocator_traits::propagate_on_container_copy_assignment propagate_on_container_copy_assignment; typedef typename allocator_traits::propagate_on_container_move_assignment propagate_on_container_move_assignment; typedef typename allocator_traits::propagate_on_container_swap propagate_on_container_swap; //! An integral constant with member `value == false` typedef BOOST_CONTAINER_IMPDEF(dtl::bool_) is_always_equal; //! An integral constant with member `value == true` typedef BOOST_CONTAINER_IMPDEF(dtl::bool_) is_partially_propagable; BOOST_CONTAINER_DOCIGN(typedef dtl::version_type version;) //!Obtains an small_vector_allocator that allocates //!objects of type T2 template struct rebind { typedef typename allocator_traits::template rebind_alloc::type other; }; #if !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED) //!Constructor from arbitrary arguments template BOOST_CONTAINER_FORCEINLINE explicit small_vector_allocator(BOOST_FWD_REF(Args) ...args) : Allocator(::boost::forward(args)...) {} #else #define BOOST_CONTAINER_SMALL_VECTOR_ALLOCATOR_CTOR_CODE(N) \ BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \ BOOST_CONTAINER_FORCEINLINE explicit small_vector_allocator(BOOST_MOVE_UREF##N)\ : Allocator(BOOST_MOVE_FWD##N)\ {}\ // BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_SMALL_VECTOR_ALLOCATOR_CTOR_CODE) #undef BOOST_CONTAINER_SMALL_VECTOR_ALLOCATOR_CTOR_CODE #endif //!Constructor from other small_vector_allocator. //!Never throws BOOST_CONTAINER_FORCEINLINE small_vector_allocator (const small_vector_allocator &other) BOOST_NOEXCEPT_OR_NOTHROW : Allocator(other.as_base()) {} //!Move constructor from small_vector_allocator. //!Never throws BOOST_CONTAINER_FORCEINLINE small_vector_allocator (BOOST_RV_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW : Allocator(::boost::move(other.as_base())) {} //!Constructor from related small_vector_allocator. //!Never throws template BOOST_CONTAINER_FORCEINLINE small_vector_allocator (const small_vector_allocator &other) BOOST_NOEXCEPT_OR_NOTHROW : Allocator(other.as_base()) {} //!Move constructor from related small_vector_allocator. //!Never throws template BOOST_CONTAINER_FORCEINLINE small_vector_allocator (BOOST_RV_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW : Allocator(::boost::move(other.as_base())) {} //!Assignment from other small_vector_allocator. //!Never throws BOOST_CONTAINER_FORCEINLINE small_vector_allocator & operator=(BOOST_COPY_ASSIGN_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW { return static_cast(this->Allocator::operator=(other.as_base())); } //!Move constructor from other small_vector_allocator. //!Never throws BOOST_CONTAINER_FORCEINLINE small_vector_allocator & operator=(BOOST_RV_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW { return static_cast(this->Allocator::operator=(::boost::move(other.as_base()))); } //!Assignment from related small_vector_allocator. //!Never throws template BOOST_CONTAINER_FORCEINLINE small_vector_allocator & operator=(BOOST_COPY_ASSIGN_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW { return static_cast(this->Allocator::operator=(other.as_base())); } //!Move assignment from related small_vector_allocator. //!Never throws template BOOST_CONTAINER_FORCEINLINE small_vector_allocator & operator=(BOOST_RV_REF(small_vector_allocator) other) BOOST_NOEXCEPT_OR_NOTHROW { return static_cast(this->Allocator::operator=(::boost::move(other.as_base()))); } //!Allocates storage from the standard-conforming allocator BOOST_CONTAINER_FORCEINLINE pointer allocate(size_type count, const_void_pointer hint = const_void_pointer()) { return allocator_traits_type::allocate(this->as_base(), count, hint); } //!Deallocates previously allocated memory. //!Never throws void deallocate(pointer ptr, size_type n) BOOST_NOEXCEPT_OR_NOTHROW { if(!this->is_internal_storage(ptr)) allocator_traits_type::deallocate(this->as_base(), ptr, n); } //!Returns the maximum number of elements that could be allocated. //!Never throws BOOST_CONTAINER_FORCEINLINE size_type max_size() const BOOST_NOEXCEPT_OR_NOTHROW { return allocator_traits_type::max_size(this->as_base()); } small_vector_allocator select_on_container_copy_construction() const { return small_vector_allocator(allocator_traits_type::select_on_container_copy_construction(this->as_base())); } bool storage_is_unpropagable(pointer p) const { return this->is_internal_storage(p) || allocator_traits_type::storage_is_unpropagable(this->as_base(), p); } //!Swaps two allocators, does nothing //!because this small_vector_allocator is stateless BOOST_CONTAINER_FORCEINLINE friend void swap(small_vector_allocator &l, small_vector_allocator &r) BOOST_NOEXCEPT_OR_NOTHROW { boost::adl_move_swap(l.as_base(), r.as_base()); } //!An small_vector_allocator always compares to true, as memory allocated with one //!instance can be deallocated by another instance (except for unpropagable storage) BOOST_CONTAINER_FORCEINLINE friend bool operator==(const small_vector_allocator &l, const small_vector_allocator &r) BOOST_NOEXCEPT_OR_NOTHROW { return allocator_traits_type::equal(l.as_base(), r.as_base()); } //!An small_vector_allocator always compares to false, as memory allocated with one //!instance can be deallocated by another instance BOOST_CONTAINER_FORCEINLINE friend bool operator!=(const small_vector_allocator &l, const small_vector_allocator &r) BOOST_NOEXCEPT_OR_NOTHROW { return !(l == r); } #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED /* //!An advanced function that offers in-place expansion shrink to fit and new allocation //!capabilities. Memory allocated with this function can only be deallocated with deallocate() //!or deallocate_many(). //!This function is available only with Version == 2 pointer allocation_command(allocation_type command, size_type limit_size, size_type &prefer_in_recvd_out_size, pointer &reuse) { return allocator_traits_type::allocation_command(command, limit_size, prefer_in_recvd_out_size, reuse); } //!Returns maximum the number of objects the previously allocated memory //!pointed by p can hold. //!Memory must not have been allocated with //!allocate_one or allocate_individual. //!This function is available only with Version == 2 size_type size(pointer p) const BOOST_NOEXCEPT_OR_NOTHROW { return allocator_traits_type::size(p); } */ private: /* //!Allocates just one object. Memory allocated with this function //!must be deallocated only with deallocate_one(). //!Throws bad_alloc if there is no enough memory //!This function is available only with Version == 2 using Allocator::allocate_one; using Allocator::allocate_individual; using Allocator::deallocate_one; using Allocator::deallocate_individual; using Allocator::allocate_many; using Allocator::deallocate_many;*/ BOOST_CONTAINER_FORCEINLINE bool is_internal_storage(pointer p) const { return this->internal_storage() == p; } pointer internal_storage() const { typedef typename Allocator::value_type value_type; typedef typename allocator_traits_type::size_type size_type; typedef vector_alloc_holder< small_vector_allocator, size_type > vector_alloc_holder_t; typedef vector > vector_base; typedef small_vector_base derived_type; // const vector_alloc_holder_t &v_holder = static_cast(*this); const vector_base &v_base = reinterpret_cast(v_holder); const derived_type &d_base = static_cast(v_base); return d_base.internal_storage(); } #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED }; //! This class consists of common code from all small_vector types that don't depend on the //! "N" template parameter. This class is non-copyable and non-destructible, so this class typically //! used as reference argument to functions that read or write small vectors. Since `small_vector` //! derives from `small_vector_base`, the conversion to `small_vector_base` is implicit //!
//!
//! //Clients can pass any small_vector.
//! void read_any_small_vector_of_foo(const small_vector_base &in_parameter);
//!
//! void modify_any_small_vector_of_foo(small_vector_base &in_out_parameter);
//!
//! void some_function()
//! {
//! 
//!    small_vector myvector;
//!
//!    read_any_small_vector_of_foo(myvector);   // Reads myvector
//!
//!    modify_any_small_vector_of_foo(myvector); // Modifies myvector
//! 
//! }
//! 
//! //! All `boost::container:vector` member functions are inherited. See `vector` documentation for details. //! template class small_vector_base : public vector > { #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED public: //Make it public as it will be inherited by small_vector and container //must have this public member typedef typename allocator_traits::pointer pointer; private: BOOST_COPYABLE_AND_MOVABLE(small_vector_base) friend class small_vector_allocator; pointer internal_storage() const BOOST_NOEXCEPT_OR_NOTHROW { return boost::intrusive::pointer_traits::pointer_to (*const_cast(static_cast(static_cast(m_storage_start.data)))); } typedef vector > base_type; base_type &as_base() { return static_cast(*this); } const base_type &as_base() const { return static_cast(*this); } public: typedef typename dtl::aligned_storage ::value>::type storage_type; typedef small_vector_allocator allocator_type; protected: BOOST_CONTAINER_FORCEINLINE explicit small_vector_base(initial_capacity_t, std::size_t initial_capacity) : base_type(initial_capacity_t(), this->internal_storage(), initial_capacity) {} template BOOST_CONTAINER_FORCEINLINE explicit small_vector_base(initial_capacity_t, std::size_t capacity, BOOST_FWD_REF(AllocFwd) a) : base_type(initial_capacity_t(), this->internal_storage(), capacity, ::boost::forward(a)) {} //~small_vector_base(){} private: //The only member storage_type m_storage_start; #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED public: BOOST_CONTAINER_FORCEINLINE small_vector_base& operator=(BOOST_COPY_ASSIGN_REF(small_vector_base) other) { return static_cast(this->base_type::operator=(static_cast(other))); } BOOST_CONTAINER_FORCEINLINE small_vector_base& operator=(BOOST_RV_REF(small_vector_base) other) { return static_cast(this->base_type::operator=(BOOST_MOVE_BASE(base_type, other))); } BOOST_CONTAINER_FORCEINLINE void swap(small_vector_base &other) { return this->base_type::swap(other); } #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED protected: void move_construct_impl(base_type &x, const allocator_type &a) { if(base_type::is_propagable_from(x.get_stored_allocator(), x.data(), a, true)){ this->steal_resources(x); } else{ this->assign( boost::make_move_iterator(boost::movelib::iterator_to_raw_pointer(x.begin())) , boost::make_move_iterator(boost::movelib::iterator_to_raw_pointer(x.end ())) ); } } #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED }; #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED ///////////////////////////////////////////////////// // // small_vector_storage_calculator // ///////////////////////////////////////////////////// template struct small_vector_storage_calculator_helper { static const std::size_t value = (Needed - Hdr - 1u)/SSize + 1u; }; template struct small_vector_storage_calculator_helper { static const std::size_t value = 0u; }; template struct small_vector_storage_calculator { typedef small_vector_base svh_type; typedef vector > svhb_type; static const std::size_t s_align = dtl::alignment_of::value; static const std::size_t s_size = sizeof(Storage); static const std::size_t svh_sizeof = sizeof(svh_type); static const std::size_t svhb_sizeof = sizeof(svhb_type); static const std::size_t s_start = ((svhb_sizeof-1)/s_align+1)*s_align; static const std::size_t header_bytes = svh_sizeof-s_start; static const std::size_t needed_bytes = sizeof(T)*N; static const std::size_t needed_extra_storages = small_vector_storage_calculator_helper::value; }; ///////////////////////////////////////////////////// // // small_vector_storage_definer // ///////////////////////////////////////////////////// template struct small_vector_storage { Storage m_rest_of_storage[N]; }; template struct small_vector_storage {}; template struct small_vector_storage_definer { typedef typename Allocator::value_type value_type; typedef typename small_vector_base::storage_type storage_type; static const std::size_t needed_extra_storages = small_vector_storage_calculator::needed_extra_storages; typedef small_vector_storage type; }; #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED //! small_vector is a vector-like container optimized for the case when it contains few elements. //! It contains some preallocated elements in-place, which can avoid the use of dynamic storage allocation //! when the actual number of elements is below that preallocated threshold. //! //! `small_vector` is convertible to `small_vector_base` that is independent //! from the preallocated element capacity, so client code does not need to be templated on that N argument. //! //! All `boost::container::vector` member functions are inherited. See `vector` documentation for details. //! //! \tparam T The type of object that is stored in the small_vector //! \tparam N The number of preallocated elements stored inside small_vector. It shall be less than Allocator::max_size(); //! \tparam Allocator The allocator used for memory management when the number of elements exceeds N. template ) > class small_vector : public small_vector_base #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED , private small_vector_storage_definer::type #endif { #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED typedef small_vector_base base_type; typedef typename small_vector_storage_definer::type remaining_storage_holder; BOOST_COPYABLE_AND_MOVABLE(small_vector) typedef allocator_traits allocator_traits_type; public: typedef small_vector_storage_calculator< typename small_vector_base ::storage_type, Allocator, T, N> storage_test; static const std::size_t needed_extra_storages = storage_test::needed_extra_storages; static const std::size_t needed_bytes = storage_test::needed_bytes; static const std::size_t header_bytes = storage_test::header_bytes; static const std::size_t s_start = storage_test::s_start; typedef typename base_type::allocator_type allocator_type; typedef typename base_type::size_type size_type; typedef typename base_type::value_type value_type; BOOST_CONTAINER_FORCEINLINE static std::size_t internal_capacity() { return (sizeof(small_vector) - storage_test::s_start)/sizeof(T); } #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED //! @brief The capacity/max size of the container static const size_type static_capacity = N; public: BOOST_CONTAINER_FORCEINLINE small_vector() BOOST_NOEXCEPT_IF(dtl::is_nothrow_default_constructible::value) : base_type(initial_capacity_t(), internal_capacity()) {} BOOST_CONTAINER_FORCEINLINE explicit small_vector(const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) {} BOOST_CONTAINER_FORCEINLINE explicit small_vector(size_type n) : base_type(initial_capacity_t(), internal_capacity()) { this->resize(n); } BOOST_CONTAINER_FORCEINLINE small_vector(size_type n, const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) { this->resize(n); } BOOST_CONTAINER_FORCEINLINE small_vector(size_type n, default_init_t) : base_type(initial_capacity_t(), internal_capacity()) { this->resize(n, default_init_t()); } BOOST_CONTAINER_FORCEINLINE small_vector(size_type n, default_init_t, const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) { this->resize(n, default_init_t()); } BOOST_CONTAINER_FORCEINLINE small_vector(size_type n, const value_type &v) : base_type(initial_capacity_t(), internal_capacity()) { this->resize(n, v); } BOOST_CONTAINER_FORCEINLINE small_vector(size_type n, const value_type &v, const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) { this->resize(n, v); } template BOOST_CONTAINER_FORCEINLINE small_vector(InIt first, InIt last BOOST_CONTAINER_DOCIGN(BOOST_MOVE_I typename dtl::disable_if_c < dtl::is_convertible::value BOOST_MOVE_I dtl::nat >::type * = 0) ) : base_type(initial_capacity_t(), internal_capacity()) { this->assign(first, last); } template BOOST_CONTAINER_FORCEINLINE small_vector(InIt first, InIt last, const allocator_type& a BOOST_CONTAINER_DOCIGN(BOOST_MOVE_I typename dtl::disable_if_c < dtl::is_convertible::value BOOST_MOVE_I dtl::nat >::type * = 0) ) : base_type(initial_capacity_t(), internal_capacity(), a) { this->assign(first, last); } BOOST_CONTAINER_FORCEINLINE small_vector(const small_vector &other) : base_type( initial_capacity_t(), internal_capacity() , allocator_traits_type::select_on_container_copy_construction(other.get_stored_allocator())) { this->assign(other.cbegin(), other.cend()); } BOOST_CONTAINER_FORCEINLINE small_vector(const small_vector &other, const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) { this->assign(other.cbegin(), other.cend()); } BOOST_CONTAINER_FORCEINLINE explicit small_vector(const base_type &other) : base_type( initial_capacity_t(), internal_capacity() , allocator_traits_type::select_on_container_copy_construction(other.get_stored_allocator())) { this->assign(other.cbegin(), other.cend()); } BOOST_CONTAINER_FORCEINLINE explicit small_vector(BOOST_RV_REF(base_type) other) : base_type(initial_capacity_t(), internal_capacity(), ::boost::move(other.get_stored_allocator())) { this->move_construct_impl(other, other.get_stored_allocator()); } BOOST_CONTAINER_FORCEINLINE small_vector(BOOST_RV_REF(small_vector) other) : base_type(initial_capacity_t(), internal_capacity(), ::boost::move(other.get_stored_allocator())) { this->move_construct_impl(other, other.get_stored_allocator()); } BOOST_CONTAINER_FORCEINLINE small_vector(BOOST_RV_REF(small_vector) other, const allocator_type &a) : base_type(initial_capacity_t(), internal_capacity(), a) { this->move_construct_impl(other, a); } #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST) BOOST_CONTAINER_FORCEINLINE small_vector(std::initializer_list il, const allocator_type& a = allocator_type()) : base_type(initial_capacity_t(), internal_capacity(), a) { this->assign(il.begin(), il.end()); } #endif BOOST_CONTAINER_FORCEINLINE small_vector& operator=(BOOST_COPY_ASSIGN_REF(small_vector) other) { return static_cast(this->base_type::operator=(static_cast(other))); } BOOST_CONTAINER_FORCEINLINE small_vector& operator=(BOOST_RV_REF(small_vector) other) { return static_cast(this->base_type::operator=(BOOST_MOVE_BASE(base_type, other))); } BOOST_CONTAINER_FORCEINLINE small_vector& operator=(const base_type &other) { return static_cast(this->base_type::operator=(other)); } BOOST_CONTAINER_FORCEINLINE small_vector& operator=(BOOST_RV_REF(base_type) other) { return static_cast(this->base_type::operator=(boost::move(other))); } BOOST_CONTAINER_FORCEINLINE void swap(small_vector &other) { return this->base_type::swap(other); } }; }} #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED /* namespace boost { //!has_trivial_destructor_after_move<> == true_type //!specialization for optimizations template struct has_trivial_destructor_after_move > { typedef typename ::boost::container::allocator_traits::pointer pointer; static const bool value = ::boost::has_trivial_destructor_after_move::value && ::boost::has_trivial_destructor_after_move::value; }; } */ #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED #include #endif // #ifndef BOOST_CONTAINER_CONTAINER_SMALL_VECTOR_HPP