Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r82332 - sandbox/static_vector/boost/container
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-03 10:41:15

Author: awulkiew
Date: 2013-01-03 10:41:14 EST (Thu, 03 Jan 2013)
New Revision: 82332
URL: http://svn.boost.org/trac/boost/changeset/82332

Log:
Added methods description
Text files modified:
sandbox/static_vector/boost/container/static_vector.hpp | 123 ++++++++++++++++++++++++++++++++++++++-
1 files changed, 118 insertions(+), 5 deletions(-)

Modified: sandbox/static_vector/boost/container/static_vector.hpp
==============================================================================
--- sandbox/static_vector/boost/container/static_vector.hpp (original)
+++ sandbox/static_vector/boost/container/static_vector.hpp 2013-01-03 10:41:14 EST (Thu, 03 Jan 2013)
@@ -210,6 +210,8 @@
 : m_size(0)
 {}

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: Constructs a static_vector containing count default constructed Values.
 //!
 //! Throws: If Value's default constructor throws.
@@ -222,6 +224,8 @@
 this->resize(count); // may throw
 }

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: Constructs a static_vector containing count copies of value.
 //!
 //! Throws: If Value's copy constructor throws.
@@ -234,6 +238,8 @@
 this->resize(count, value); // may throw
 }

+ //! Requires: distance(first, last) <= Capacity.
+ //!
 //! Effects: Constructs a static_vector containing copy of a range [first, last).
 //!
 //! Throws: If Value's constructor taking a dereferenced Iterator throws.
@@ -260,6 +266,8 @@
 sv::uninitialized_copy(other.begin(), other.end(), this->begin()); // may throw
 }

+ //! Requires: other.size() <= Capacity.
+ //!
 //! Effects: Constructs a copy of other static_vector.
 //!
 //! Throws: If Value's copy constructor throws.
@@ -288,6 +296,8 @@
 return *this;
 }

+ //! Requires: other.size() <= Capacity.
+ //!
 //! Effects: Copy assigns Values stored in the other static_vector to this one.
 //!
 //! Throws: If Value's copy constructor or copy assignment throws,
@@ -324,6 +334,8 @@
 this->move_ctor_dispatch(other, use_memop_in_swap_and_move());
 }

+ //! Requires: other.size() <= Capacity.
+ //!
 //! Effects: Move constructor. Moves Values stored in the other static_vector to this one.
 //!
 //! Throws: If boost::has_nothrow_move<Value>::value is true and Value's move constructor throws
@@ -368,6 +380,8 @@
 return *this;
 }

+ //! Requires: other.size() <= Capacity.
+ //!
 //! Effects: Move assignment. Moves Values stored in the other static_vector to this one.
 //!
 //! Throws: If boost::has_nothrow_move<Value>::value is true and Value's move constructor or move assignment throws,
@@ -419,6 +433,8 @@
 this->swap_dispatch(other, use_optimized_swap());
 }

+ //! Requires: other.size() <= Capacity && size() <= other.capacity().
+ //!
 //! Effects: Swaps contents of the other static_vector and this one.
 //!
 //! Throws: If boost::has_nothrow_move<Value>::value is true and Value's move constructor or move assignment throws,
@@ -441,6 +457,8 @@
 this->swap_dispatch(other, use_optimized_swap());
 }

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: Inserts or erases elements at the end such that
 //! the size becomes count. New elements are default constructed.
 //!
@@ -465,6 +483,8 @@
 m_size = count; // update end
 }

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: Inserts or erases elements at the end such that
 //! the size becomes count. New elements are copy constructed from value.
 //!
@@ -488,6 +508,8 @@
 m_size = count; // update end
 }

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: This call has no effect because the Capacity of this container is constant.
 //!
 //! Throws: If the error handler throws in capacity check (nothing by default).
@@ -498,6 +520,8 @@
 errh::check_capacity(*this, count); // may throw
 }

+ //! Requires: size() < Capacity.
+ //!
 //! Effects: Adds a copy of value at the end.
 //!
 //! Throws: If Value's copy constructor throws.
@@ -513,6 +537,8 @@
 ++m_size; // update end
 }

+ //! Requires: size() < Capacity.
+ //!
 //! Effects: Moves value to the end.
 //!
 //! Throws: If Value's move constructor throws.
@@ -558,7 +584,8 @@
 return this->priv_insert(position, value);
 }

- //! Requires: position must be a valid iterator of *this in range [begin(), end()].
+ //! Requires: position must be a valid iterator of *this in range [begin(), end()]
+ //! and size() < Capacity.
 //!
 //! Effects: Inserts a move-constructed element at position.
 //!
@@ -571,7 +598,8 @@
 return this->priv_insert(position, value);
 }

- //! Requires: position must be a valid iterator of *this in range [begin(), end()].
+ //! Requires: position must be a valid iterator of *this in range [begin(), end()]
+ //! and size() + count <= Capacity.
 //!
 //! Effects: Inserts a count copies of value at position.
 //!
@@ -618,7 +646,8 @@
 return position;
 }

- //! Requires: position must be a valid iterator of *this in range [begin(), end()].
+ //! Requires: position must be a valid iterator of *this in range [begin(), end()]
+ //! and distance(first, last) <= Capacity.
 //!
 //! Effects: Inserts a copy of a range [first, last) at position.
 //!
@@ -689,6 +718,8 @@
 return first;
 }

+ //! Requires: distance(first, last) <= Capacity.
+ //!
 //! Effects: Assigns a range [first, last) of Values to this container.
 //!
 //! Throws: If Value's copy constructor or copy assignment throws,
@@ -703,6 +734,8 @@
 this->assign_dispatch(first, last, traversal()); // may throw
 }

+ //! Requires: count <= Capacity.
+ //!
 //! Effects: Assigns a count copies of value to this container.
 //!
 //! Throws: If Value's copy constructor or copy assignment throws.
@@ -729,6 +762,8 @@

#if !defined(BOOST_CONTAINER_STATIC_VECTOR_DISABLE_EMPLACE)
#if defined(BOOST_CONTAINER_PERFECT_FORWARDING) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+ //! Requires: size() < Capacity.
+ //!
 //! Effects: Inserts a Value constructed with
 //! std::forward<Args>(args)... in the end of the container.
 //!
@@ -746,6 +781,9 @@
 ++m_size; // update end
 }

+ //! Requires: position must be a valid iterator of *this in range [begin(), end()]
+ //! and size() < Capacity.
+ //!
 //! Effects: Inserts a Value constructed with
 //! std::forward<Args>(args)... before position
 //!
@@ -967,7 +1005,7 @@
 return *(this->end() - 1);
 }

- //! Returns: Pointer such that [data(), data() + size()) is a valid range.
+ //! Effects: Pointer such that [data(), data() + size()) is a valid range.
 //! For a non-empty vector, data() == &front().
 //!
 //! Throws: Nothing.
@@ -978,7 +1016,7 @@
 return boost::addressof(*(this->ptr()));
 }

- //! Returns: Const pointer such that [data(), data() + size()) is a valid range.
+ //! Effects: Const pointer such that [data(), data() + size()) is a valid range.
 //! For a non-empty vector, data() == &front().
 //!
 //! Throws: Nothing.
@@ -989,57 +1027,129 @@
 return boost::addressof(*(this->ptr()));
 }

+ //! Effects: Returns an iterator to the first element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 iterator begin() { return this->ptr(); }
+
+ //! Effects: Returns a const_iterator to the first element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_iterator begin() const { return this->ptr(); }
+
+ //! Effects: Returns a const_iterator to the first element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_iterator cbegin() const { return this->ptr(); }
+
+ //! Effects: Returns an iterator pointing to the one after the last element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 iterator end() { return this->begin() + m_size; }
+
+ //! Effects: Returns a const_iterator pointing to the one after the last element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_iterator end() const { return this->begin() + m_size; }
+
+ //! Effects: Returns a const_iterator pointing to the one after the last element contained in the vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_iterator cend() const { return this->cbegin() + m_size; }

+ //! Effects: Returns a reverse_iterator pointing to the beginning
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 reverse_iterator rbegin() { return reverse_iterator(this->end()); }
+
+ //! Effects: Returns a const_reverse_iterator pointing to the beginning
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_reverse_iterator rbegin() const { return reverse_iterator(this->end()); }
+
+ //! Effects: Returns a const_reverse_iterator pointing to the beginning
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_reverse_iterator crbegin() const { return reverse_iterator(this->end()); }
+
+ //! Effects: Returns a reverse_iterator pointing to the one after the last element
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 reverse_iterator rend() { return reverse_iterator(this->begin()); }
+
+ //! Effects: Returns a const_reverse_iterator pointing to the one after the last element
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_reverse_iterator rend() const { return reverse_iterator(this->begin()); }
+
+ //! Effects: Returns a const_reverse_iterator pointing to the one after the last element
+ //! of the reversed static_vector.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 const_reverse_iterator crend() const { return reverse_iterator(this->begin()); }

+ //! Effects: Returns container's capacity.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 static size_type capacity() { return Capacity; }
+
+ //! Effects: Returns container's capacity.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 static size_type max_size() { return Capacity; }
+
+ //! Effects: Returns the number of elements contained in the container.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 size_type size() const { return m_size; }
+
+ //! Effects: Returns true if the number of elements contained in the
+ //! container is equal to 0.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 bool empty() const { return 0 == m_size; }
+
+ //! Effects: The call has no effects.
+ //!
 //! Throws: Nothing.
+ //!
 //! Complexity: Constant.
 void shrink_to_fit() {}

@@ -1188,6 +1298,9 @@

 // insert

+ //! Throws: If Value's move constructor or move assignment throws
+ //! or if Value's copy assignment throws.
+ //! Complexity: Linear.
 template <typename V>
 iterator priv_insert(iterator position, V & value)
 {

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk