123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326 |
- // Boost.Container static_vector
- //
- // Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
- // Copyright (c) 2011-2013 Andrew Hundt.
- // Copyright (c) 2013-2014 Ion Gaztanaga
- //
- // Use, modification and distribution is subject to 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)
- #ifndef BOOST_CONTAINER_STATIC_VECTOR_HPP
- #define BOOST_CONTAINER_STATIC_VECTOR_HPP
- #ifndef BOOST_CONFIG_HPP
- # include <boost/config.hpp>
- #endif
- #if defined(BOOST_HAS_PRAGMA_ONCE)
- # pragma once
- #endif
- #include <boost/container/detail/config_begin.hpp>
- #include <boost/container/detail/workaround.hpp>
- #include <boost/container/detail/type_traits.hpp>
- #include <boost/container/vector.hpp>
- #include <cstddef>
- #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST)
- #include <initializer_list>
- #endif
- namespace boost { namespace container {
- #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
- namespace dtl {
- template<class T, std::size_t N, std::size_t InplaceAlignment, bool ThrowOnOverflow>
- class static_storage_allocator
- {
- typedef bool_<ThrowOnOverflow> throw_on_overflow_t;
- static BOOST_NORETURN inline void on_capacity_overflow(true_type)
- {
- (throw_bad_alloc)();
- }
- static inline void on_capacity_overflow(false_type)
- {
- BOOST_ASSERT_MSG(false, "ERROR: static vector capacity overflow");
- }
-
- public:
- typedef T value_type;
- inline static_storage_allocator() BOOST_NOEXCEPT_OR_NOTHROW
- {}
- inline static_storage_allocator(const static_storage_allocator &) BOOST_NOEXCEPT_OR_NOTHROW
- {}
- inline static_storage_allocator & operator=(const static_storage_allocator &) BOOST_NOEXCEPT_OR_NOTHROW
- { return *this; }
- inline T* internal_storage() const BOOST_NOEXCEPT_OR_NOTHROW
- { return const_cast<T*>(static_cast<const T*>(static_cast<const void*>(storage.data))); }
- inline T* internal_storage() BOOST_NOEXCEPT_OR_NOTHROW
- { return static_cast<T*>(static_cast<void*>(storage.data)); }
- static const std::size_t internal_capacity = N;
- std::size_t max_size() const
- { return N; }
- static inline void on_capacity_overflow()
- {
- (on_capacity_overflow)(throw_on_overflow_t());
- }
- typedef boost::container::dtl::version_type<static_storage_allocator, 0> version;
- inline friend bool operator==(const static_storage_allocator &, const static_storage_allocator &) BOOST_NOEXCEPT_OR_NOTHROW
- { return false; }
- inline friend bool operator!=(const static_storage_allocator &, const static_storage_allocator &) BOOST_NOEXCEPT_OR_NOTHROW
- { return true; }
- private:
- BOOST_CONTAINER_STATIC_ASSERT_MSG(!InplaceAlignment || (InplaceAlignment & (InplaceAlignment-1)) == 0, "Alignment option must be zero or power of two");
- static const std::size_t final_alignment = InplaceAlignment ? InplaceAlignment : dtl::alignment_of<T>::value;
- typename dtl::aligned_storage<sizeof(T)*N, final_alignment>::type storage;
- };
- template<class Options>
- struct get_static_vector_opt
- {
- typedef Options type;
- };
- template<>
- struct get_static_vector_opt<void>
- {
- typedef static_vector_null_opt type;
- };
- template <typename T, std::size_t Capacity, class Options>
- struct get_static_vector_allocator
- {
- typedef typename get_static_vector_opt<Options>::type options_t;
- typedef dtl::static_storage_allocator
- < T
- , Capacity
- , options_t::inplace_alignment
- , options_t::throw_on_overflow
- > type;
- };
- } //namespace dtl {
- #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
- //!
- //!@brief A variable-size array container with fixed capacity.
- //!
- //!static_vector is a sequence container like boost::container::vector with contiguous storage that can
- //!change in size, along with the static allocation, low overhead, and fixed capacity of boost::array.
- //!
- //!A static_vector is a sequence that supports random access to elements, constant time insertion and
- //!removal of elements at the end, and linear time insertion and removal of elements at the beginning or
- //!in the middle. The number of elements in a static_vector may vary dynamically up to a fixed capacity
- //!because elements are stored within the object itself similarly to an array. However, objects are
- //!initialized as they are inserted into static_vector unlike C arrays or std::array which must construct
- //!all elements on instantiation. The behavior of static_vector enables the use of statically allocated
- //!elements in cases with complex object lifetime requirements that would otherwise not be trivially
- //!possible.
- //!
- //!@par Error Handling
- //! If `throw_on_overflow` option is true (default behaviour), insertion beyond the capacity result
- //! in throwing bad_alloc() if exceptions are enabled and or calling throw_bad_alloc() if not enabled.
- //! If `throw_on_overflow` option is false, insertion beyond capacity results in Undefined Behaviour.
- //!
- //! out_of_range is thrown if out of bounds access is performed in <code>at()</code> if exceptions are
- //! enabled, throw_out_of_range() if not enabled.
- //!
- //!@tparam T The type of element that will be stored.
- //!@tparam Capacity The maximum number of elements static_vector can store, fixed at compile time.
- //!@tparam Options A type produced from \c boost::container::static_vector_options. If no option
- //! is specified, by default throw_on_overflow<true> option is set.
- template <typename T, std::size_t Capacity, class Options BOOST_CONTAINER_DOCONLY(= void) >
- class static_vector
- : public vector<T, typename dtl::get_static_vector_allocator< T, Capacity, Options>::type>
- {
- public:
- #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
- typedef typename dtl::get_static_vector_allocator< T, Capacity, Options>::type allocator_type;
- typedef vector<T, allocator_type > base_t;
- BOOST_COPYABLE_AND_MOVABLE(static_vector)
- template<class U, std::size_t OtherCapacity, class OtherOptions>
- friend class static_vector;
- public:
- #endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
- public:
- //! @brief The type of elements stored in the container.
- typedef typename base_t::value_type value_type;
- //! @brief The unsigned integral type used by the container.
- typedef typename base_t::size_type size_type;
- //! @brief The pointers difference type.
- typedef typename base_t::difference_type difference_type;
- //! @brief The pointer type.
- typedef typename base_t::pointer pointer;
- //! @brief The const pointer type.
- typedef typename base_t::const_pointer const_pointer;
- //! @brief The value reference type.
- typedef typename base_t::reference reference;
- //! @brief The value const reference type.
- typedef typename base_t::const_reference const_reference;
- //! @brief The iterator type.
- typedef typename base_t::iterator iterator;
- //! @brief The const iterator type.
- typedef typename base_t::const_iterator const_iterator;
- //! @brief The reverse iterator type.
- typedef typename base_t::reverse_iterator reverse_iterator;
- //! @brief The const reverse iterator.
- typedef typename base_t::const_reverse_iterator const_reverse_iterator;
- //! @brief The capacity/max size of the container
- static const size_type static_capacity = Capacity;
- //! @brief Constructs an empty static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- inline static_vector() BOOST_NOEXCEPT_OR_NOTHROW
- : base_t()
- {}
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Constructs a static_vector containing count value initialized values.
- //!
- //! @param count The number of values which will be contained in the container.
- //!
- //! @par Throws
- //! @li If T's value initialization throws
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline explicit static_vector(size_type count)
- : base_t(count)
- {}
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Constructs a static_vector containing count default initialized values.
- //!
- //! @param count The number of values which will be contained in the container.
- //!
- //! @par Throws
- //! @li If T's default initialization throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- //!
- //! @par Note
- //! Non-standard extension
- inline static_vector(size_type count, default_init_t)
- : base_t(count, default_init_t())
- {}
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Constructs a static_vector containing count copies of value.
- //!
- //! @param count The number of copies of a values that will be contained in the container.
- //! @param value The value which will be used to copy construct values.
- //!
- //! @par Throws
- //! @li If T's copy constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector(size_type count, value_type const& value)
- : base_t(count, value)
- {}
- //! @pre
- //! @li <tt>distance(first, last) <= capacity()</tt>
- //! @li Iterator must meet the \c ForwardTraversalIterator concept.
- //!
- //! @brief Constructs a static_vector containing copy of a range <tt>[first, last)</tt>.
- //!
- //! @param first The iterator to the first element in range.
- //! @param last The iterator to the one after the last element in range.
- //!
- //! @par Throws
- //! @li If T's constructor taking a dereferenced Iterator throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <typename Iterator>
- inline static_vector(Iterator first, Iterator last)
- : base_t(first, last)
- {}
- #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST)
- //! @pre
- //! @li <tt>distance(il.begin(), il.end()) <= capacity()</tt>
- //!
- //! @brief Constructs a static_vector containing copy of a range <tt>[il.begin(), il.end())</tt>.
- //!
- //! @param il std::initializer_list with values to initialize vector.
- //!
- //! @par Throws
- //! @li If T's constructor taking a dereferenced std::initializer_list throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector(std::initializer_list<value_type> il)
- : base_t(il)
- {}
- #endif
- //! @brief Constructs a copy of other static_vector.
- //!
- //! @param other The static_vector which content will be copied to this one.
- //!
- //! @par Throws
- //! If T's copy constructor throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector(static_vector const& other)
- : base_t(other)
- {}
- inline static_vector(static_vector const& other, const allocator_type &)
- : base_t(other)
- {}
- inline static_vector(BOOST_RV_REF(static_vector) other, const allocator_type &)
- BOOST_NOEXCEPT_IF(boost::container::dtl::is_nothrow_move_constructible<value_type>::value)
- : base_t(BOOST_MOVE_BASE(base_t, other))
- {}
- inline explicit static_vector(const allocator_type &)
- : base_t()
- {}
- //! @pre <tt>other.size() <= capacity()</tt>.
- //!
- //! @brief Constructs a copy of other static_vector.
- //!
- //! @param other The static_vector which content will be copied to this one.
- //!
- //! @par Throws
- //! @li If T's copy constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <std::size_t C, class O>
- inline static_vector(static_vector<T, C, O> const& other)
- : base_t(other)
- {}
- //! @brief Move constructor. Moves Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be moved to this one.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor throws.
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector(BOOST_RV_REF(static_vector) other)
- BOOST_NOEXCEPT_IF(boost::container::dtl::is_nothrow_move_constructible<value_type>::value)
- : base_t(BOOST_MOVE_BASE(base_t, other))
- {}
- //! @pre <tt>other.size() <= capacity()</tt>
- //!
- //! @brief Move constructor. Moves Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be moved to this one.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor throws.
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <std::size_t C, class O>
- inline static_vector(BOOST_RV_REF_BEG static_vector<T, C, O> BOOST_RV_REF_END other)
- : base_t(BOOST_MOVE_BASE(typename static_vector<T BOOST_MOVE_I C>::base_t, other))
- {}
- //! @brief Copy assigns Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be copied to this one.
- //!
- //! @par Throws
- //! If T's copy constructor or copy assignment throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector & operator=(BOOST_COPY_ASSIGN_REF(static_vector) other)
- {
- return static_cast<static_vector&>(base_t::operator=(static_cast<base_t const&>(other)));
- }
- #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST)
- //! @brief Copy assigns Values stored in std::initializer_list to *this.
- //!
- //! @param il The std::initializer_list which content will be copied to this one.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector & operator=(std::initializer_list<value_type> il)
- { return static_cast<static_vector&>(base_t::operator=(il)); }
- #endif
- //! @pre <tt>other.size() <= capacity()</tt>
- //!
- //! @brief Copy assigns Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be copied to this one.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <std::size_t C, class O>
- inline static_vector & operator=(static_vector<T, C, O> const& other)
- {
- return static_cast<static_vector&>(base_t::operator=
- (static_cast<typename static_vector<T, C, O>::base_t const&>(other)));
- }
- //! @brief Move assignment. Moves Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be moved to this one.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor or move assignment throws.
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor or copy assignment throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- inline static_vector & operator=(BOOST_RV_REF(static_vector) other)
- BOOST_NOEXCEPT_IF(boost::container::dtl::is_nothrow_move_assignable<value_type>::value)
- {
- return static_cast<static_vector&>(base_t::operator=(BOOST_MOVE_BASE(base_t, other)));
- }
- //! @pre <tt>other.size() <= capacity()</tt>
- //!
- //! @brief Move assignment. Moves Values stored in the other static_vector to this one.
- //!
- //! @param other The static_vector which content will be moved to this one.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor or move assignment throws.
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor or copy assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <std::size_t C, class O>
- inline static_vector & operator=(BOOST_RV_REF_BEG static_vector<T, C, O> BOOST_RV_REF_END other)
- {
- return static_cast<static_vector&>(base_t::operator=
- (BOOST_MOVE_BASE(typename static_vector<T BOOST_MOVE_I C>::base_t, other)));
- }
- #ifdef BOOST_CONTAINER_DOXYGEN_INVOKED
- //! @brief Destructor. Destroys Values stored in this container.
- //!
- //! @par Throws
- //! Nothing
- //!
- //! @par Complexity
- //! Linear O(N).
- ~static_vector();
- //! @brief Swaps contents of the other static_vector and this one.
- //!
- //! @param other The static_vector which content will be swapped with this one's content.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor or move assignment throws,
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor or copy assignment throws,
- //!
- //! @par Complexity
- //! Linear O(N).
- void swap(static_vector & other);
- //! @pre <tt>other.size() <= capacity() && size() <= other.capacity()</tt>
- //!
- //! @brief Swaps contents of the other static_vector and this one.
- //!
- //! @param other The static_vector which content will be swapped with this one's content.
- //!
- //! @par Throws
- //! @li If \c has_nothrow_move<T>::value is \c true and T's move constructor or move assignment throws,
- //! @li If \c has_nothrow_move<T>::value is \c false and T's copy constructor or copy assignment throws,
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <std::size_t C, class O>
- void swap(static_vector<T, C, O> & other);
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Inserts or erases elements at the end such that
- //! the size becomes count. New elements are value initialized.
- //!
- //! @param count The number of elements which will be stored in the container.
- //!
- //! @par Throws
- //! @li If T's value initialization throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- void resize(size_type count);
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Inserts or erases elements at the end such that
- //! the size becomes count. New elements are default initialized.
- //!
- //! @param count The number of elements which will be stored in the container.
- //!
- //! @par Throws
- //! @li If T's default initialization throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- //!
- //! @par Note
- //! Non-standard extension
- void resize(size_type count, default_init_t);
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Inserts or erases elements at the end such that
- //! the size becomes count. New elements are copy constructed from value.
- //!
- //! @param count The number of elements which will be stored in the container.
- //! @param value The value used to copy construct the new element.
- //!
- //! @par Throws
- //! @li If T's copy constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- void resize(size_type count, value_type const& value);
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief This call has no effect because the Capacity of this container is constant.
- //!
- //! @param count The number of elements which the container should be able to contain.
- //!
- //! @par Throws
- //! If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant O(1).
- void reserve(size_type count);
- //! @pre <tt>size() < capacity()</tt>
- //!
- //! @brief Adds a copy of value at the end.
- //!
- //! @param value The value used to copy construct the new element.
- //!
- //! @par Throws
- //! @li If T's copy constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant O(1).
- void push_back(value_type const& value);
- //! @pre <tt>size() < capacity()</tt>
- //!
- //! @brief Moves value to the end.
- //!
- //! @param value The value to move construct the new element.
- //!
- //! @par Throws
- //! @li If T's move constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant O(1).
- void push_back(BOOST_RV_REF(value_type) value);
- //! @pre <tt>!empty()</tt>
- //!
- //! @brief Destroys last value and decreases the size.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- void pop_back() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>.
- //! @li <tt>size() < capacity()</tt>
- //!
- //! @brief Inserts a copy of element at p.
- //!
- //! @param p The position at which the new value will be inserted.
- //! @param value The value used to copy construct the new element.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws
- //! @li If T's move constructor or move assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant or linear.
- iterator insert(const_iterator p, value_type const& value);
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>.
- //! @li <tt>size() < capacity()</tt>
- //!
- //! @brief Inserts a move-constructed element at p.
- //!
- //! @param p The position at which the new value will be inserted.
- //! @param value The value used to move construct the new element.
- //!
- //! @par Throws
- //! @li If T's move constructor or move assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant or linear.
- iterator insert(const_iterator p, BOOST_RV_REF(value_type) value);
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>.
- //! @li <tt>size() + count <= capacity()</tt>
- //!
- //! @brief Inserts a count copies of value at p.
- //!
- //! @param p The position at which new elements will be inserted.
- //! @param count The number of new elements which will be inserted.
- //! @param value The value used to copy construct new elements.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws.
- //! @li If T's move constructor or move assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- iterator insert(const_iterator p, size_type count, value_type const& value);
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>.
- //! @li <tt>distance(first, last) <= capacity()</tt>
- //! @li \c Iterator must meet the \c ForwardTraversalIterator concept.
- //!
- //! @brief Inserts a copy of a range <tt>[first, last)</tt> at p.
- //!
- //! @param p The position at which new elements will be inserted.
- //! @param first The iterator to the first element of a range used to construct new elements.
- //! @param last The iterator to the one after the last element of a range used to construct new elements.
- //!
- //! @par Throws
- //! @li If T's constructor and assignment taking a dereferenced \c Iterator.
- //! @li If T's move constructor or move assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <typename Iterator>
- iterator insert(const_iterator p, Iterator first, Iterator last);
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>.
- //! @li <tt>distance(il.begin(), il.end()) <= capacity()</tt>
- //!
- //! @brief Inserts a copy of a range <tt>[il.begin(), il.end())</tt> at p.
- //!
- //! @param p The position at which new elements will be inserted.
- //! @param il The std::initializer_list which contains elements that will be inserted.
- //!
- //! @par Throws
- //! @li If T's constructor and assignment taking a dereferenced std::initializer_list iterator.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- iterator insert(const_iterator p, std::initializer_list<value_type> il);
- //! @pre \c p must be a valid iterator of \c *this in range <tt>[begin(), end())</tt>
- //!
- //! @brief Erases T from p.
- //!
- //! @param p The position of the element which will be erased from the container.
- //!
- //! @par Throws
- //! If T's move assignment throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- iterator erase(const_iterator p);
- //! @pre
- //! @li \c first and \c last must define a valid range
- //! @li iterators must be in range <tt>[begin(), end()]</tt>
- //!
- //! @brief Erases Values from a range <tt>[first, last)</tt>.
- //!
- //! @param first The position of the first element of a range which will be erased from the container.
- //! @param last The position of the one after the last element of a range which will be erased from the container.
- //!
- //! @par Throws
- //! If T's move assignment throws.
- //!
- //! @par Complexity
- //! Linear O(N).
- iterator erase(const_iterator first, const_iterator last);
- //! @pre <tt>distance(first, last) <= capacity()</tt>
- //!
- //! @brief Assigns a range <tt>[first, last)</tt> of Values to this container.
- //!
- //! @param first The iterator to the first element of a range used to construct new content of this container.
- //! @param last The iterator to the one after the last element of a range used to construct new content of this container.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws,
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- template <typename Iterator>
- void assign(Iterator first, Iterator last);
- //! @pre <tt>distance(il.begin(), il.end()) <= capacity()</tt>
- //!
- //! @brief Assigns a range <tt>[il.begin(), il.end())</tt> of Values to this container.
- //!
- //! @param il std::initializer_list with values used to construct new content of this container.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws,
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- void assign(std::initializer_list<value_type> il);
- //! @pre <tt>count <= capacity()</tt>
- //!
- //! @brief Assigns a count copies of value to this container.
- //!
- //! @param count The new number of elements which will be container in the container.
- //! @param value The value which will be used to copy construct the new content.
- //!
- //! @par Throws
- //! @li If T's copy constructor or copy assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Linear O(N).
- void assign(size_type count, value_type const& value);
- //! @pre <tt>size() < capacity()</tt>
- //!
- //! @brief Inserts a T constructed with
- //! \c std::forward<Args>(args)... in the end of the container.
- //!
- //! @return A reference to the created object.
- //!
- //! @param args The arguments of the constructor of the new element which will be created at the end of the container.
- //!
- //! @par Throws
- //! @li If in-place constructor throws or T's move constructor throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant O(1).
- template<class ...Args>
- reference emplace_back(Args &&...args);
- //! @pre
- //! @li \c p must be a valid iterator of \c *this in range <tt>[begin(), end()]</tt>
- //! @li <tt>size() < capacity()</tt>
- //!
- //! @brief Inserts a T constructed with
- //! \c std::forward<Args>(args)... before p
- //!
- //! @param p The position at which new elements will be inserted.
- //! @param args The arguments of the constructor of the new element.
- //!
- //! @par Throws
- //! @li If in-place constructor throws or if T's move constructor or move assignment throws.
- //! @li If \c throw_on_overflow<true> option is set and the container runs out of capacity.
- //!
- //! @par Complexity
- //! Constant or linear.
- template<class ...Args>
- iterator emplace(const_iterator p, Args &&...args);
- //! @brief Removes all elements from the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- void clear() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>i < size()</tt>
- //!
- //! @brief Returns reference to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return reference to the i-th element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! \c out_of_range exception by default.
- //!
- //! @par Complexity
- //! Constant O(1).
- reference at(size_type i);
- //! @pre <tt>i < size()</tt>
- //!
- //! @brief Returns const reference to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return const reference to the i-th element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! \c out_of_range exception by default.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reference at(size_type i) const;
- //! @pre <tt>i < size()</tt>
- //!
- //! @brief Returns reference to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return reference to the i-th element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- reference operator[](size_type i) BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>i < size()</tt>
- //!
- //! @brief Returns const reference to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return const reference to the i-th element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reference operator[](size_type i) const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>i =< size()</tt>
- //!
- //! @brief Returns a iterator to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return a iterator to the i-th element.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- iterator nth(size_type i) BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>i =< size()</tt>
- //!
- //! @brief Returns a const_iterator to the i-th element.
- //!
- //! @param i The element's index.
- //!
- //! @return a const_iterator to the i-th element.
- //!
- //! @par Throws
- //! Nothing by default.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_iterator nth(size_type i) const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>begin() <= p <= end()</tt>
- //!
- //! @brief Returns the index of the element pointed by p.
- //!
- //! @param p An iterator to the element.
- //!
- //! @return The index of the element pointed by p.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- size_type index_of(iterator p) BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre <tt>begin() <= p <= end()</tt>
- //!
- //! @brief Returns the index of the element pointed by p.
- //!
- //! @param p A const_iterator to the element.
- //!
- //! @return a const_iterator to the i-th element.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- size_type index_of(const_iterator p) const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre \c !empty()
- //!
- //! @brief Returns reference to the first element.
- //!
- //! @return reference to the first element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- reference front() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre \c !empty()
- //!
- //! @brief Returns const reference to the first element.
- //!
- //! @return const reference to the first element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reference front() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre \c !empty()
- //!
- //! @brief Returns reference to the last element.
- //!
- //! @return reference to the last element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- reference back() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @pre \c !empty()
- //!
- //! @brief Returns const reference to the first element.
- //!
- //! @return const reference to the last element
- //! from the beginning of the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reference back() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Pointer such that <tt>[data(), data() + size())</tt> is a valid range.
- //! For a non-empty vector <tt>data() == &front()</tt>.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- T * data() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Const pointer such that <tt>[data(), data() + size())</tt> is a valid range.
- //! For a non-empty vector <tt>data() == &front()</tt>.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const T * data() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns iterator to the first element.
- //!
- //! @return iterator to the first element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- iterator begin() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const iterator to the first element.
- //!
- //! @return const_iterator to the first element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_iterator begin() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const iterator to the first element.
- //!
- //! @return const_iterator to the first element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_iterator cbegin() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns iterator to the one after the last element.
- //!
- //! @return iterator pointing to the one after the last element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- iterator end() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const iterator to the one after the last element.
- //!
- //! @return const_iterator pointing to the one after the last element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_iterator end() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const iterator to the one after the last element.
- //!
- //! @return const_iterator pointing to the one after the last element contained in the vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_iterator cend() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns reverse iterator to the first element of the reversed container.
- //!
- //! @return reverse_iterator pointing to the beginning
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- reverse_iterator rbegin() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const reverse iterator to the first element of the reversed container.
- //!
- //! @return const_reverse_iterator pointing to the beginning
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reverse_iterator rbegin() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const reverse iterator to the first element of the reversed container.
- //!
- //! @return const_reverse_iterator pointing to the beginning
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reverse_iterator crbegin() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns reverse iterator to the one after the last element of the reversed container.
- //!
- //! @return reverse_iterator pointing to the one after the last element
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- reverse_iterator rend() BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const reverse iterator to the one after the last element of the reversed container.
- //!
- //! @return const_reverse_iterator pointing to the one after the last element
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reverse_iterator rend() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Returns const reverse iterator to the one after the last element of the reversed container.
- //!
- //! @return const_reverse_iterator pointing to the one after the last element
- //! of the reversed static_vector.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- const_reverse_iterator crend() const BOOST_NOEXCEPT_OR_NOTHROW;
- #endif //#ifdef BOOST_CONTAINER_DOXYGEN_INVOKED
- //! @brief Returns container's capacity.
- //!
- //! @return container's capacity.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- inline static size_type capacity() BOOST_NOEXCEPT_OR_NOTHROW
- { return static_capacity; }
- //! @brief Returns container's capacity.
- //!
- //! @return container's capacity.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- inline static size_type max_size() BOOST_NOEXCEPT_OR_NOTHROW
- { return static_capacity; }
- #ifdef BOOST_CONTAINER_DOXYGEN_INVOKED
- //! @brief Returns the number of stored elements.
- //!
- //! @return Number of elements contained in the container.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- size_type size() const BOOST_NOEXCEPT_OR_NOTHROW;
- //! @brief Queries if the container contains elements.
- //!
- //! @return true if the number of elements contained in the
- //! container is equal to 0.
- //!
- //! @par Throws
- //! Nothing.
- //!
- //! @par Complexity
- //! Constant O(1).
- bool empty() const BOOST_NOEXCEPT_OR_NOTHROW;
- #else
- inline friend void swap(static_vector &x, static_vector &y)
- BOOST_NOEXCEPT_IF(BOOST_NOEXCEPT(x.swap(y)))
- {
- x.swap(y);
- }
- #endif // BOOST_CONTAINER_DOXYGEN_INVOKED
- };
- #ifdef BOOST_CONTAINER_DOXYGEN_INVOKED
- //! @brief Checks if contents of two static_vectors are equal.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if containers have the same size and elements in both containers are equal.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator== (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Checks if contents of two static_vectors are not equal.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if containers have different size or elements in both containers are not equal.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator!= (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Lexicographically compares static_vectors.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if x compares lexicographically less than y.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator< (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Lexicographically compares static_vectors.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if y compares lexicographically less than x.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator> (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Lexicographically compares static_vectors.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if y don't compare lexicographically less than x.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator<= (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Lexicographically compares static_vectors.
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @return \c true if x don't compare lexicographically less than y.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- bool operator>= (static_vector<V, C1, O1> const& x, static_vector<V, C2, O2> const& y);
- //! @brief Swaps contents of two static_vectors.
- //!
- //! This function calls static_vector::swap().
- //!
- //! @ingroup static_vector_non_member
- //!
- //! @param x The first static_vector.
- //! @param y The second static_vector.
- //!
- //! @par Complexity
- //! Linear O(N).
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- inline void swap(static_vector<V, C1, O1> & x, static_vector<V, C2, O2> & y)
- BOOST_NOEXCEPT_IF(BOOST_NOEXCEPT(x.swap(y)));
- #else
- template<typename V, std::size_t C1, std::size_t C2, class O1, class O2>
- inline void swap(static_vector<V, C1, O1> & x, static_vector<V, C2, O2> & y
- , typename dtl::enable_if_c< C1 != C2>::type * = 0)
- BOOST_NOEXCEPT_IF(BOOST_NOEXCEPT(x.swap(y)))
- {
- x.swap(y);
- }
- #endif // BOOST_CONTAINER_DOXYGEN_INVOKED
- }} // namespace boost::container
- #include <boost/container/detail/config_end.hpp>
- #endif // BOOST_CONTAINER_STATIC_VECTOR_HPP
|