1 // List implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
34 * Hewlett-Packard Company
36 * Permission to use, copy, modify, distribute and sell this software
37 * and its documentation for any purpose is hereby granted without fee,
38 * provided that the above copyright notice appear in all copies and
39 * that both that copyright notice and this permission notice appear
40 * in supporting documentation. Hewlett-Packard Company makes no
41 * representations about the suitability of this software for any
42 * purpose. It is provided "as is" without express or implied warranty.
45 * Copyright (c) 1996,1997
46 * Silicon Graphics Computer Systems, Inc.
48 * Permission to use, copy, modify, distribute and sell this software
49 * and its documentation for any purpose is hereby granted without fee,
50 * provided that the above copyright notice appear in all copies and
51 * that both that copyright notice and this permission notice appear
52 * in supporting documentation. Silicon Graphics makes no
53 * representations about the suitability of this software for any
54 * purpose. It is provided "as is" without express or implied warranty.
58 * This is an internal header file, included by other library headers.
59 * You should not attempt to use it directly.
65 #include <bits/concept_check.h>
67 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD_D
)
69 // Supporting structures are split into common and templated types; the
70 // latter publicly inherits from the former in an effort to reduce code
71 // duplication. This results in some "needless" static_cast'ing later on,
72 // but it's all safe downcasting.
74 /// @if maint Common part of a node in the %list. @endif
75 struct _List_node_base
77 _List_node_base
* _M_next
; ///< Self-explanatory
78 _List_node_base
* _M_prev
; ///< Self-explanatory
81 swap(_List_node_base
& __x
, _List_node_base
& __y
);
84 transfer(_List_node_base
* const __first
,
85 _List_node_base
* const __last
);
91 hook(_List_node_base
* const __position
);
97 /// @if maint An actual node in the %list. @endif
98 template<typename _Tp
>
99 struct _List_node
: public _List_node_base
101 _Tp _M_data
; ///< User's data.
105 * @brief A list::iterator.
108 * All the functions are op overloads.
111 template<typename _Tp
>
112 struct _List_iterator
114 typedef _List_iterator
<_Tp
> _Self
;
115 typedef _List_node
<_Tp
> _Node
;
117 typedef ptrdiff_t difference_type
;
118 typedef std::bidirectional_iterator_tag iterator_category
;
119 typedef _Tp value_type
;
120 typedef _Tp
* pointer
;
121 typedef _Tp
& reference
;
127 _List_iterator(_List_node_base
* __x
)
130 // Must downcast from List_node_base to _List_node to get to _M_data.
133 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
137 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
142 _M_node
= _M_node
->_M_next
;
150 _M_node
= _M_node
->_M_next
;
157 _M_node
= _M_node
->_M_prev
;
165 _M_node
= _M_node
->_M_prev
;
170 operator==(const _Self
& __x
) const
171 { return _M_node
== __x
._M_node
; }
174 operator!=(const _Self
& __x
) const
175 { return _M_node
!= __x
._M_node
; }
177 // The only member points to the %list element.
178 _List_node_base
* _M_node
;
182 * @brief A list::const_iterator.
185 * All the functions are op overloads.
188 template<typename _Tp
>
189 struct _List_const_iterator
191 typedef _List_const_iterator
<_Tp
> _Self
;
192 typedef const _List_node
<_Tp
> _Node
;
193 typedef _List_iterator
<_Tp
> iterator
;
195 typedef ptrdiff_t difference_type
;
196 typedef std::bidirectional_iterator_tag iterator_category
;
197 typedef _Tp value_type
;
198 typedef const _Tp
* pointer
;
199 typedef const _Tp
& reference
;
201 _List_const_iterator()
205 _List_const_iterator(const _List_node_base
* __x
)
208 _List_const_iterator(const iterator
& __x
)
209 : _M_node(__x
._M_node
) { }
211 // Must downcast from List_node_base to _List_node to get to
215 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
219 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
224 _M_node
= _M_node
->_M_next
;
232 _M_node
= _M_node
->_M_next
;
239 _M_node
= _M_node
->_M_prev
;
247 _M_node
= _M_node
->_M_prev
;
252 operator==(const _Self
& __x
) const
253 { return _M_node
== __x
._M_node
; }
256 operator!=(const _Self
& __x
) const
257 { return _M_node
!= __x
._M_node
; }
259 // The only member points to the %list element.
260 const _List_node_base
* _M_node
;
263 template<typename _Val
>
265 operator==(const _List_iterator
<_Val
>& __x
,
266 const _List_const_iterator
<_Val
>& __y
)
267 { return __x
._M_node
== __y
._M_node
; }
269 template<typename _Val
>
271 operator!=(const _List_iterator
<_Val
>& __x
,
272 const _List_const_iterator
<_Val
>& __y
)
273 { return __x
._M_node
!= __y
._M_node
; }
278 * See bits/stl_deque.h's _Deque_base for an explanation.
281 template<typename _Tp
, typename _Alloc
>
286 // The stored instance is not actually of "allocator_type"'s
287 // type. Instead we rebind the type to
288 // Allocator<List_node<Tp>>, which according to [20.1.5]/4
289 // should probably be the same. List_node<Tp> is not the same
290 // size as Tp (it's two pointers larger), and specializations on
291 // Tp may go unused because List_node<Tp> is being bound
294 // We put this to the test in the constructors and in
295 // get_allocator, where we use conversions between
296 // allocator_type and _Node_alloc_type. The conversion is
297 // required by table 32 in [20.1.5].
298 typedef typename
_Alloc::template rebind
<_List_node
<_Tp
> >::other
301 typedef typename
_Alloc::template rebind
<_Tp
>::other _Tp_alloc_type
;
304 : public _Node_alloc_type
306 _List_node_base _M_node
;
309 : _Node_alloc_type(), _M_node()
312 _List_impl(const _Node_alloc_type
& __a
)
313 : _Node_alloc_type(__a
), _M_node()
321 { return _M_impl
._Node_alloc_type::allocate(1); }
324 _M_put_node(_List_node
<_Tp
>* __p
)
325 { _M_impl
._Node_alloc_type::deallocate(__p
, 1); }
328 typedef _Alloc allocator_type
;
331 _M_get_Node_allocator()
332 { return *static_cast<_Node_alloc_type
*>(&this->_M_impl
); }
334 const _Node_alloc_type
&
335 _M_get_Node_allocator() const
336 { return *static_cast<const _Node_alloc_type
*>(&this->_M_impl
); }
339 _M_get_Tp_allocator() const
340 { return _Tp_alloc_type(_M_get_Node_allocator()); }
343 get_allocator() const
344 { return allocator_type(_M_get_Node_allocator()); }
350 _List_base(const allocator_type
& __a
)
354 #ifdef __GXX_EXPERIMENTAL_CXX0X__
355 _List_base(_List_base
&& __x
)
356 : _M_impl(__x
._M_get_Node_allocator())
359 _List_node_base::swap(this->_M_impl
._M_node
, __x
._M_impl
._M_node
);
363 // This is what actually destroys the list.
373 this->_M_impl
._M_node
._M_next
= &this->_M_impl
._M_node
;
374 this->_M_impl
._M_node
._M_prev
= &this->_M_impl
._M_node
;
379 * @brief A standard container with linear time access to elements,
380 * and fixed time insertion/deletion at any point in the sequence.
382 * @ingroup Containers
385 * Meets the requirements of a <a href="tables.html#65">container</a>, a
386 * <a href="tables.html#66">reversible container</a>, and a
387 * <a href="tables.html#67">sequence</a>, including the
388 * <a href="tables.html#68">optional sequence requirements</a> with the
389 * %exception of @c at and @c operator[].
391 * This is a @e doubly @e linked %list. Traversal up and down the
392 * %list requires linear time, but adding and removing elements (or
393 * @e nodes) is done in constant time, regardless of where the
394 * change takes place. Unlike std::vector and std::deque,
395 * random-access iterators are not provided, so subscripting ( @c
396 * [] ) access is not allowed. For algorithms which only need
397 * sequential access, this lack makes no difference.
399 * Also unlike the other standard containers, std::list provides
400 * specialized algorithms %unique to linked lists, such as
401 * splicing, sorting, and in-place reversal.
404 * A couple points on memory allocation for list<Tp>:
406 * First, we never actually allocate a Tp, we allocate
407 * List_node<Tp>'s and trust [20.1.5]/4 to DTRT. This is to ensure
408 * that after elements from %list<X,Alloc1> are spliced into
409 * %list<X,Alloc2>, destroying the memory of the second %list is a
410 * valid operation, i.e., Alloc1 giveth and Alloc2 taketh away.
412 * Second, a %list conceptually represented as
414 * A <---> B <---> C <---> D
416 * is actually circular; a link exists between A and D. The %list
417 * class holds (as its only data member) a private list::iterator
418 * pointing to @e D, not to @e A! To get to the head of the %list,
419 * we start at the tail and move forward by one. When this member
420 * iterator's next/previous pointers refer to itself, the %list is
423 template<typename _Tp
, typename _Alloc
= std::allocator
<_Tp
> >
424 class list
: protected _List_base
<_Tp
, _Alloc
>
426 // concept requirements
427 typedef typename
_Alloc::value_type _Alloc_value_type
;
428 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
429 __glibcxx_class_requires2(_Tp
, _Alloc_value_type
, _SameTypeConcept
)
431 typedef _List_base
<_Tp
, _Alloc
> _Base
;
432 typedef typename
_Base::_Tp_alloc_type _Tp_alloc_type
;
435 typedef _Tp value_type
;
436 typedef typename
_Tp_alloc_type::pointer pointer
;
437 typedef typename
_Tp_alloc_type::const_pointer const_pointer
;
438 typedef typename
_Tp_alloc_type::reference reference
;
439 typedef typename
_Tp_alloc_type::const_reference const_reference
;
440 typedef _List_iterator
<_Tp
> iterator
;
441 typedef _List_const_iterator
<_Tp
> const_iterator
;
442 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
443 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
444 typedef size_t size_type
;
445 typedef ptrdiff_t difference_type
;
446 typedef _Alloc allocator_type
;
449 // Note that pointers-to-_Node's can be ctor-converted to
451 typedef _List_node
<_Tp
> _Node
;
453 using _Base::_M_impl
;
454 using _Base::_M_put_node
;
455 using _Base::_M_get_node
;
456 using _Base::_M_get_Tp_allocator
;
457 using _Base::_M_get_Node_allocator
;
461 * @param x An instance of user data.
463 * Allocates space for a new node and constructs a copy of @a x in it.
467 _M_create_node(const value_type
& __x
)
469 _Node
* __p
= this->_M_get_node();
472 _M_get_Tp_allocator().construct(&__p
->_M_data
, __x
);
477 __throw_exception_again
;
483 // [23.2.2.1] construct/copy/destroy
484 // (assign() and get_allocator() are also listed in this section)
486 * @brief Default constructor creates no elements.
492 * @brief Creates a %list with no elements.
493 * @param a An allocator object.
496 list(const allocator_type
& __a
)
500 * @brief Creates a %list with copies of an exemplar element.
501 * @param n The number of elements to initially create.
502 * @param value An element to copy.
503 * @param a An allocator object.
505 * This constructor fills the %list with @a n copies of @a value.
508 list(size_type __n
, const value_type
& __value
= value_type(),
509 const allocator_type
& __a
= allocator_type())
511 { _M_fill_initialize(__n
, __value
); }
514 * @brief %List copy constructor.
515 * @param x A %list of identical element and allocator types.
517 * The newly-created %list uses a copy of the allocation object used
520 list(const list
& __x
)
521 : _Base(__x
._M_get_Node_allocator())
522 { _M_initialize_dispatch(__x
.begin(), __x
.end(), __false_type()); }
524 #ifdef __GXX_EXPERIMENTAL_CXX0X__
526 * @brief %List move constructor.
527 * @param x A %list of identical element and allocator types.
529 * The newly-created %list contains the exact contents of @a x.
530 * The contents of @a x are a valid, but unspecified %list.
533 : _Base(std::forward
<_Base
>(__x
)) { }
537 * @brief Builds a %list from a range.
538 * @param first An input iterator.
539 * @param last An input iterator.
540 * @param a An allocator object.
542 * Create a %list consisting of copies of the elements from
543 * [@a first,@a last). This is linear in N (where N is
544 * distance(@a first,@a last)).
546 template<typename _InputIterator
>
547 list(_InputIterator __first
, _InputIterator __last
,
548 const allocator_type
& __a
= allocator_type())
551 // Check whether it's an integral type. If so, it's not an iterator.
552 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
553 _M_initialize_dispatch(__first
, __last
, _Integral());
557 * No explicit dtor needed as the _Base dtor takes care of
558 * things. The _Base dtor only erases the elements, and note
559 * that if the elements themselves are pointers, the pointed-to
560 * memory is not touched in any way. Managing the pointer is
561 * the user's responsibilty.
565 * @brief %List assignment operator.
566 * @param x A %list of identical element and allocator types.
568 * All the elements of @a x are copied, but unlike the copy
569 * constructor, the allocator object is not copied.
572 operator=(const list
& __x
);
574 #ifdef __GXX_EXPERIMENTAL_CXX0X__
576 * @brief %List move assignment operator.
577 * @param x A %list of identical element and allocator types.
579 * The contents of @a x are moved into this %list (without copying).
580 * @a x is a valid, but unspecified %list
583 operator=(list
&& __x
)
593 * @brief Assigns a given value to a %list.
594 * @param n Number of elements to be assigned.
595 * @param val Value to be assigned.
597 * This function fills a %list with @a n copies of the given
598 * value. Note that the assignment completely changes the %list
599 * and that the resulting %list's size is the same as the number
600 * of elements assigned. Old data may be lost.
603 assign(size_type __n
, const value_type
& __val
)
604 { _M_fill_assign(__n
, __val
); }
607 * @brief Assigns a range to a %list.
608 * @param first An input iterator.
609 * @param last An input iterator.
611 * This function fills a %list with copies of the elements in the
612 * range [@a first,@a last).
614 * Note that the assignment completely changes the %list and
615 * that the resulting %list's size is the same as the number of
616 * elements assigned. Old data may be lost.
618 template<typename _InputIterator
>
620 assign(_InputIterator __first
, _InputIterator __last
)
622 // Check whether it's an integral type. If so, it's not an iterator.
623 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
624 _M_assign_dispatch(__first
, __last
, _Integral());
627 /// Get a copy of the memory allocation object.
629 get_allocator() const
630 { return _Base::get_allocator(); }
634 * Returns a read/write iterator that points to the first element in the
635 * %list. Iteration is done in ordinary element order.
639 { return iterator(this->_M_impl
._M_node
._M_next
); }
642 * Returns a read-only (constant) iterator that points to the
643 * first element in the %list. Iteration is done in ordinary
648 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
651 * Returns a read/write iterator that points one past the last
652 * element in the %list. Iteration is done in ordinary element
657 { return iterator(&this->_M_impl
._M_node
); }
660 * Returns a read-only (constant) iterator that points one past
661 * the last element in the %list. Iteration is done in ordinary
666 { return const_iterator(&this->_M_impl
._M_node
); }
669 * Returns a read/write reverse iterator that points to the last
670 * element in the %list. Iteration is done in reverse element
675 { return reverse_iterator(end()); }
678 * Returns a read-only (constant) reverse iterator that points to
679 * the last element in the %list. Iteration is done in reverse
682 const_reverse_iterator
684 { return const_reverse_iterator(end()); }
687 * Returns a read/write reverse iterator that points to one
688 * before the first element in the %list. Iteration is done in
689 * reverse element order.
693 { return reverse_iterator(begin()); }
696 * Returns a read-only (constant) reverse iterator that points to one
697 * before the first element in the %list. Iteration is done in reverse
700 const_reverse_iterator
702 { return const_reverse_iterator(begin()); }
704 #ifdef __GXX_EXPERIMENTAL_CXX0X__
706 * Returns a read-only (constant) iterator that points to the
707 * first element in the %list. Iteration is done in ordinary
712 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
715 * Returns a read-only (constant) iterator that points one past
716 * the last element in the %list. Iteration is done in ordinary
721 { return const_iterator(&this->_M_impl
._M_node
); }
724 * Returns a read-only (constant) reverse iterator that points to
725 * the last element in the %list. Iteration is done in reverse
728 const_reverse_iterator
730 { return const_reverse_iterator(end()); }
733 * Returns a read-only (constant) reverse iterator that points to one
734 * before the first element in the %list. Iteration is done in reverse
737 const_reverse_iterator
739 { return const_reverse_iterator(begin()); }
742 // [23.2.2.2] capacity
744 * Returns true if the %list is empty. (Thus begin() would equal
749 { return this->_M_impl
._M_node
._M_next
== &this->_M_impl
._M_node
; }
751 /** Returns the number of elements in the %list. */
754 { return std::distance(begin(), end()); }
756 /** Returns the size() of the largest possible %list. */
759 { return _M_get_Tp_allocator().max_size(); }
762 * @brief Resizes the %list to the specified number of elements.
763 * @param new_size Number of elements the %list should contain.
764 * @param x Data with which new elements should be populated.
766 * This function will %resize the %list to the specified number
767 * of elements. If the number is smaller than the %list's
768 * current size the %list is truncated, otherwise the %list is
769 * extended and new elements are populated with given data.
772 resize(size_type __new_size
, value_type __x
= value_type());
776 * Returns a read/write reference to the data at the first
777 * element of the %list.
784 * Returns a read-only (constant) reference to the data at the first
785 * element of the %list.
792 * Returns a read/write reference to the data at the last element
798 iterator __tmp
= end();
804 * Returns a read-only (constant) reference to the data at the last
805 * element of the %list.
810 const_iterator __tmp
= end();
815 // [23.2.2.3] modifiers
817 * @brief Add data to the front of the %list.
818 * @param x Data to be added.
820 * This is a typical stack operation. The function creates an
821 * element at the front of the %list and assigns the given data
822 * to it. Due to the nature of a %list this operation can be
823 * done in constant time, and does not invalidate iterators and
827 push_front(const value_type
& __x
)
828 { this->_M_insert(begin(), __x
); }
831 * @brief Removes first element.
833 * This is a typical stack operation. It shrinks the %list by
834 * one. Due to the nature of a %list this operation can be done
835 * in constant time, and only invalidates iterators/references to
836 * the element being removed.
838 * Note that no data is returned, and if the first element's data
839 * is needed, it should be retrieved before pop_front() is
844 { this->_M_erase(begin()); }
847 * @brief Add data to the end of the %list.
848 * @param x Data to be added.
850 * This is a typical stack operation. The function creates an
851 * element at the end of the %list and assigns the given data to
852 * it. Due to the nature of a %list this operation can be done
853 * in constant time, and does not invalidate iterators and
857 push_back(const value_type
& __x
)
858 { this->_M_insert(end(), __x
); }
861 * @brief Removes last element.
863 * This is a typical stack operation. It shrinks the %list by
864 * one. Due to the nature of a %list this operation can be done
865 * in constant time, and only invalidates iterators/references to
866 * the element being removed.
868 * Note that no data is returned, and if the last element's data
869 * is needed, it should be retrieved before pop_back() is called.
873 { this->_M_erase(iterator(this->_M_impl
._M_node
._M_prev
)); }
876 * @brief Inserts given value into %list before specified iterator.
877 * @param position An iterator into the %list.
878 * @param x Data to be inserted.
879 * @return An iterator that points to the inserted data.
881 * This function will insert a copy of the given value before
882 * the specified location. Due to the nature of a %list this
883 * operation can be done in constant time, and does not
884 * invalidate iterators and references.
887 insert(iterator __position
, const value_type
& __x
);
890 * @brief Inserts a number of copies of given data into the %list.
891 * @param position An iterator into the %list.
892 * @param n Number of elements to be inserted.
893 * @param x Data to be inserted.
895 * This function will insert a specified number of copies of the
896 * given data before the location specified by @a position.
898 * This operation is linear in the number of elements inserted and
899 * does not invalidate iterators and references.
902 insert(iterator __position
, size_type __n
, const value_type
& __x
)
904 list
__tmp(__n
, __x
, _M_get_Node_allocator());
905 splice(__position
, __tmp
);
909 * @brief Inserts a range into the %list.
910 * @param position An iterator into the %list.
911 * @param first An input iterator.
912 * @param last An input iterator.
914 * This function will insert copies of the data in the range [@a
915 * first,@a last) into the %list before the location specified by
918 * This operation is linear in the number of elements inserted and
919 * does not invalidate iterators and references.
921 template<typename _InputIterator
>
923 insert(iterator __position
, _InputIterator __first
,
924 _InputIterator __last
)
926 list
__tmp(__first
, __last
, _M_get_Node_allocator());
927 splice(__position
, __tmp
);
931 * @brief Remove element at given position.
932 * @param position Iterator pointing to element to be erased.
933 * @return An iterator pointing to the next element (or end()).
935 * This function will erase the element at the given position and thus
936 * shorten the %list by one.
938 * Due to the nature of a %list this operation can be done in
939 * constant time, and only invalidates iterators/references to
940 * the element being removed. The user is also cautioned that
941 * this function only erases the element, and that if the element
942 * is itself a pointer, the pointed-to memory is not touched in
943 * any way. Managing the pointer is the user's responsibilty.
946 erase(iterator __position
);
949 * @brief Remove a range of elements.
950 * @param first Iterator pointing to the first element to be erased.
951 * @param last Iterator pointing to one past the last element to be
953 * @return An iterator pointing to the element pointed to by @a last
954 * prior to erasing (or end()).
956 * This function will erase the elements in the range @a
957 * [first,last) and shorten the %list accordingly.
959 * This operation is linear time in the size of the range and only
960 * invalidates iterators/references to the element being removed.
961 * The user is also cautioned that this function only erases the
962 * elements, and that if the elements themselves are pointers, the
963 * pointed-to memory is not touched in any way. Managing the pointer
964 * is the user's responsibilty.
967 erase(iterator __first
, iterator __last
)
969 while (__first
!= __last
)
970 __first
= erase(__first
);
975 * @brief Swaps data with another %list.
976 * @param x A %list of the same element and allocator types.
978 * This exchanges the elements between two lists in constant
979 * time. Note that the global std::swap() function is
980 * specialized such that std::swap(l1,l2) will feed to this
984 #ifdef __GXX_EXPERIMENTAL_CXX0X__
990 _List_node_base::swap(this->_M_impl
._M_node
, __x
._M_impl
._M_node
);
992 // _GLIBCXX_RESOLVE_LIB_DEFECTS
993 // 431. Swapping containers with unequal allocators.
994 std::__alloc_swap
<typename
_Base::_Node_alloc_type
>::
995 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator());
999 * Erases all the elements. Note that this function only erases
1000 * the elements, and that if the elements themselves are
1001 * pointers, the pointed-to memory is not touched in any way.
1002 * Managing the pointer is the user's responsibilty.
1011 // [23.2.2.4] list operations
1013 * @brief Insert contents of another %list.
1014 * @param position Iterator referencing the element to insert before.
1015 * @param x Source list.
1017 * The elements of @a x are inserted in constant time in front of
1018 * the element referenced by @a position. @a x becomes an empty
1021 * Requires this != @a x.
1024 splice(iterator __position
, list
& __x
)
1028 _M_check_equal_allocators(__x
);
1030 this->_M_transfer(__position
, __x
.begin(), __x
.end());
1035 * @brief Insert element from another %list.
1036 * @param position Iterator referencing the element to insert before.
1037 * @param x Source list.
1038 * @param i Iterator referencing the element to move.
1040 * Removes the element in list @a x referenced by @a i and
1041 * inserts it into the current list before @a position.
1044 splice(iterator __position
, list
& __x
, iterator __i
)
1048 if (__position
== __i
|| __position
== __j
)
1052 _M_check_equal_allocators(__x
);
1054 this->_M_transfer(__position
, __i
, __j
);
1058 * @brief Insert range from another %list.
1059 * @param position Iterator referencing the element to insert before.
1060 * @param x Source list.
1061 * @param first Iterator referencing the start of range in x.
1062 * @param last Iterator referencing the end of range in x.
1064 * Removes elements in the range [first,last) and inserts them
1065 * before @a position in constant time.
1067 * Undefined if @a position is in [first,last).
1070 splice(iterator __position
, list
& __x
, iterator __first
, iterator __last
)
1072 if (__first
!= __last
)
1075 _M_check_equal_allocators(__x
);
1077 this->_M_transfer(__position
, __first
, __last
);
1082 * @brief Remove all elements equal to value.
1083 * @param value The value to remove.
1085 * Removes every element in the list equal to @a value.
1086 * Remaining elements stay in list order. Note that this
1087 * function only erases the elements, and that if the elements
1088 * themselves are pointers, the pointed-to memory is not
1089 * touched in any way. Managing the pointer is the user's
1093 remove(const _Tp
& __value
);
1096 * @brief Remove all elements satisfying a predicate.
1097 * @param Predicate Unary predicate function or object.
1099 * Removes every element in the list for which the predicate
1100 * returns true. Remaining elements stay in list order. Note
1101 * that this function only erases the elements, and that if the
1102 * elements themselves are pointers, the pointed-to memory is
1103 * not touched in any way. Managing the pointer is the user's
1106 template<typename _Predicate
>
1108 remove_if(_Predicate
);
1111 * @brief Remove consecutive duplicate elements.
1113 * For each consecutive set of elements with the same value,
1114 * remove all but the first one. Remaining elements stay in
1115 * list order. Note that this function only erases the
1116 * elements, and that if the elements themselves are pointers,
1117 * the pointed-to memory is not touched in any way. Managing
1118 * the pointer is the user's responsibilty.
1124 * @brief Remove consecutive elements satisfying a predicate.
1125 * @param BinaryPredicate Binary predicate function or object.
1127 * For each consecutive set of elements [first,last) that
1128 * satisfy predicate(first,i) where i is an iterator in
1129 * [first,last), remove all but the first one. Remaining
1130 * elements stay in list order. Note that this function only
1131 * erases the elements, and that if the elements themselves are
1132 * pointers, the pointed-to memory is not touched in any way.
1133 * Managing the pointer is the user's responsibilty.
1135 template<typename _BinaryPredicate
>
1137 unique(_BinaryPredicate
);
1140 * @brief Merge sorted lists.
1141 * @param x Sorted list to merge.
1143 * Assumes that both @a x and this list are sorted according to
1144 * operator<(). Merges elements of @a x into this list in
1145 * sorted order, leaving @a x empty when complete. Elements in
1146 * this list precede elements in @a x that are equal.
1152 * @brief Merge sorted lists according to comparison function.
1153 * @param x Sorted list to merge.
1154 * @param StrictWeakOrdering Comparison function definining
1157 * Assumes that both @a x and this list are sorted according to
1158 * StrictWeakOrdering. Merges elements of @a x into this list
1159 * in sorted order, leaving @a x empty when complete. Elements
1160 * in this list precede elements in @a x that are equivalent
1161 * according to StrictWeakOrdering().
1163 template<typename _StrictWeakOrdering
>
1165 merge(list
&, _StrictWeakOrdering
);
1168 * @brief Reverse the elements in list.
1170 * Reverse the order of elements in the list in linear time.
1174 { this->_M_impl
._M_node
.reverse(); }
1177 * @brief Sort the elements.
1179 * Sorts the elements of this list in NlogN time. Equivalent
1180 * elements remain in list order.
1186 * @brief Sort the elements according to comparison function.
1188 * Sorts the elements of this list in NlogN time. Equivalent
1189 * elements remain in list order.
1191 template<typename _StrictWeakOrdering
>
1193 sort(_StrictWeakOrdering
);
1196 // Internal constructor functions follow.
1198 // Called by the range constructor to implement [23.1.1]/9
1200 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1201 // 438. Ambiguity in the "do the right thing" clause
1202 template<typename _Integer
>
1204 _M_initialize_dispatch(_Integer __n
, _Integer __x
, __true_type
)
1205 { _M_fill_initialize(static_cast<size_type
>(__n
), __x
); }
1207 // Called by the range constructor to implement [23.1.1]/9
1208 template<typename _InputIterator
>
1210 _M_initialize_dispatch(_InputIterator __first
, _InputIterator __last
,
1213 for (; __first
!= __last
; ++__first
)
1214 push_back(*__first
);
1217 // Called by list(n,v,a), and the range constructor when it turns out
1218 // to be the same thing.
1220 _M_fill_initialize(size_type __n
, const value_type
& __x
)
1222 for (; __n
> 0; --__n
)
1227 // Internal assign functions follow.
1229 // Called by the range assign to implement [23.1.1]/9
1231 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1232 // 438. Ambiguity in the "do the right thing" clause
1233 template<typename _Integer
>
1235 _M_assign_dispatch(_Integer __n
, _Integer __val
, __true_type
)
1236 { _M_fill_assign(__n
, __val
); }
1238 // Called by the range assign to implement [23.1.1]/9
1239 template<typename _InputIterator
>
1241 _M_assign_dispatch(_InputIterator __first
, _InputIterator __last
,
1244 // Called by assign(n,t), and the range assign when it turns out
1245 // to be the same thing.
1247 _M_fill_assign(size_type __n
, const value_type
& __val
);
1250 // Moves the elements from [first,last) before position.
1252 _M_transfer(iterator __position
, iterator __first
, iterator __last
)
1253 { __position
._M_node
->transfer(__first
._M_node
, __last
._M_node
); }
1255 // Inserts new element at position given and with value given.
1257 _M_insert(iterator __position
, const value_type
& __x
)
1259 _Node
* __tmp
= _M_create_node(__x
);
1260 __tmp
->hook(__position
._M_node
);
1263 // Erases element at position given.
1265 _M_erase(iterator __position
)
1267 __position
._M_node
->unhook();
1268 _Node
* __n
= static_cast<_Node
*>(__position
._M_node
);
1269 _M_get_Tp_allocator().destroy(&__n
->_M_data
);
1273 // To implement the splice (and merge) bits of N1599.
1275 _M_check_equal_allocators(list
& __x
)
1277 if (std::__alloc_neq
<typename
_Base::_Node_alloc_type
>::
1278 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator()))
1279 __throw_runtime_error(__N("list::_M_check_equal_allocators"));
1284 * @brief List equality comparison.
1286 * @param y A %list of the same type as @a x.
1287 * @return True iff the size and elements of the lists are equal.
1289 * This is an equivalence relation. It is linear in the size of
1290 * the lists. Lists are considered equivalent if their sizes are
1291 * equal, and if corresponding elements compare equal.
1293 template<typename _Tp
, typename _Alloc
>
1295 operator==(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1297 typedef typename list
<_Tp
, _Alloc
>::const_iterator const_iterator
;
1298 const_iterator __end1
= __x
.end();
1299 const_iterator __end2
= __y
.end();
1301 const_iterator __i1
= __x
.begin();
1302 const_iterator __i2
= __y
.begin();
1303 while (__i1
!= __end1
&& __i2
!= __end2
&& *__i1
== *__i2
)
1308 return __i1
== __end1
&& __i2
== __end2
;
1312 * @brief List ordering relation.
1314 * @param y A %list of the same type as @a x.
1315 * @return True iff @a x is lexicographically less than @a y.
1317 * This is a total ordering relation. It is linear in the size of the
1318 * lists. The elements must be comparable with @c <.
1320 * See std::lexicographical_compare() for how the determination is made.
1322 template<typename _Tp
, typename _Alloc
>
1324 operator<(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1325 { return std::lexicographical_compare(__x
.begin(), __x
.end(),
1326 __y
.begin(), __y
.end()); }
1328 /// Based on operator==
1329 template<typename _Tp
, typename _Alloc
>
1331 operator!=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1332 { return !(__x
== __y
); }
1334 /// Based on operator<
1335 template<typename _Tp
, typename _Alloc
>
1337 operator>(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1338 { return __y
< __x
; }
1340 /// Based on operator<
1341 template<typename _Tp
, typename _Alloc
>
1343 operator<=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1344 { return !(__y
< __x
); }
1346 /// Based on operator<
1347 template<typename _Tp
, typename _Alloc
>
1349 operator>=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1350 { return !(__x
< __y
); }
1352 /// See std::list::swap().
1353 template<typename _Tp
, typename _Alloc
>
1355 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>& __y
)
1358 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1359 template<typename _Tp
, typename _Alloc
>
1361 swap(list
<_Tp
, _Alloc
>&& __x
, list
<_Tp
, _Alloc
>& __y
)
1364 template<typename _Tp
, typename _Alloc
>
1366 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>&& __y
)
1370 _GLIBCXX_END_NESTED_NAMESPACE
1372 #endif /* _STL_LIST_H */