1 // List implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
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 3, 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 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
29 * Hewlett-Packard Company
31 * Permission to use, copy, modify, distribute and sell this software
32 * and its documentation for any purpose is hereby granted without fee,
33 * provided that the above copyright notice appear in all copies and
34 * that both that copyright notice and this permission notice appear
35 * in supporting documentation. Hewlett-Packard Company makes no
36 * representations about the suitability of this software for any
37 * purpose. It is provided "as is" without express or implied warranty.
40 * Copyright (c) 1996,1997
41 * Silicon Graphics Computer Systems, Inc.
43 * Permission to use, copy, modify, distribute and sell this software
44 * and its documentation for any purpose is hereby granted without fee,
45 * provided that the above copyright notice appear in all copies and
46 * that both that copyright notice and this permission notice appear
47 * in supporting documentation. Silicon Graphics makes no
48 * representations about the suitability of this software for any
49 * purpose. It is provided "as is" without express or implied warranty.
53 * This is an internal header file, included by other library headers.
54 * You should not attempt to use it directly.
60 #include <bits/concept_check.h>
61 #include <initializer_list>
63 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD_D
)
65 // Supporting structures are split into common and templated types; the
66 // latter publicly inherits from the former in an effort to reduce code
67 // duplication. This results in some "needless" static_cast'ing later on,
68 // but it's all safe downcasting.
70 /// Common part of a node in the %list.
71 struct _List_node_base
73 _List_node_base
* _M_next
;
74 _List_node_base
* _M_prev
;
77 swap(_List_node_base
& __x
, _List_node_base
& __y
) throw ();
80 transfer(_List_node_base
* const __first
,
81 _List_node_base
* const __last
) throw ();
87 hook(_List_node_base
* const __position
) throw ();
93 /// An actual node in the %list.
94 template<typename _Tp
>
95 struct _List_node
: public _List_node_base
100 #ifdef __GXX_EXPERIMENTAL_CXX0X__
101 template<typename
... _Args
>
102 _List_node(_Args
&&... __args
)
103 : _List_node_base(), _M_data(std::forward
<_Args
>(__args
)...) { }
108 * @brief A list::iterator.
110 * All the functions are op overloads.
112 template<typename _Tp
>
113 struct _List_iterator
115 typedef _List_iterator
<_Tp
> _Self
;
116 typedef _List_node
<_Tp
> _Node
;
118 typedef ptrdiff_t difference_type
;
119 typedef std::bidirectional_iterator_tag iterator_category
;
120 typedef _Tp value_type
;
121 typedef _Tp
* pointer
;
122 typedef _Tp
& reference
;
128 _List_iterator(_List_node_base
* __x
)
131 // Must downcast from List_node_base to _List_node to get to _M_data.
134 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
138 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
143 _M_node
= _M_node
->_M_next
;
151 _M_node
= _M_node
->_M_next
;
158 _M_node
= _M_node
->_M_prev
;
166 _M_node
= _M_node
->_M_prev
;
171 operator==(const _Self
& __x
) const
172 { return _M_node
== __x
._M_node
; }
175 operator!=(const _Self
& __x
) const
176 { return _M_node
!= __x
._M_node
; }
178 // The only member points to the %list element.
179 _List_node_base
* _M_node
;
183 * @brief A list::const_iterator.
185 * All the functions are op overloads.
187 template<typename _Tp
>
188 struct _List_const_iterator
190 typedef _List_const_iterator
<_Tp
> _Self
;
191 typedef const _List_node
<_Tp
> _Node
;
192 typedef _List_iterator
<_Tp
> iterator
;
194 typedef ptrdiff_t difference_type
;
195 typedef std::bidirectional_iterator_tag iterator_category
;
196 typedef _Tp value_type
;
197 typedef const _Tp
* pointer
;
198 typedef const _Tp
& reference
;
200 _List_const_iterator()
204 _List_const_iterator(const _List_node_base
* __x
)
207 _List_const_iterator(const iterator
& __x
)
208 : _M_node(__x
._M_node
) { }
210 // Must downcast from List_node_base to _List_node to get to
214 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
218 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
223 _M_node
= _M_node
->_M_next
;
231 _M_node
= _M_node
->_M_next
;
238 _M_node
= _M_node
->_M_prev
;
246 _M_node
= _M_node
->_M_prev
;
251 operator==(const _Self
& __x
) const
252 { return _M_node
== __x
._M_node
; }
255 operator!=(const _Self
& __x
) const
256 { return _M_node
!= __x
._M_node
; }
258 // The only member points to the %list element.
259 const _List_node_base
* _M_node
;
262 template<typename _Val
>
264 operator==(const _List_iterator
<_Val
>& __x
,
265 const _List_const_iterator
<_Val
>& __y
)
266 { return __x
._M_node
== __y
._M_node
; }
268 template<typename _Val
>
270 operator!=(const _List_iterator
<_Val
>& __x
,
271 const _List_const_iterator
<_Val
>& __y
)
272 { return __x
._M_node
!= __y
._M_node
; }
275 /// See bits/stl_deque.h's _Deque_base for an explanation.
276 template<typename _Tp
, typename _Alloc
>
281 // The stored instance is not actually of "allocator_type"'s
282 // type. Instead we rebind the type to
283 // Allocator<List_node<Tp>>, which according to [20.1.5]/4
284 // should probably be the same. List_node<Tp> is not the same
285 // size as Tp (it's two pointers larger), and specializations on
286 // Tp may go unused because List_node<Tp> is being bound
289 // We put this to the test in the constructors and in
290 // get_allocator, where we use conversions between
291 // allocator_type and _Node_alloc_type. The conversion is
292 // required by table 32 in [20.1.5].
293 typedef typename
_Alloc::template rebind
<_List_node
<_Tp
> >::other
296 typedef typename
_Alloc::template rebind
<_Tp
>::other _Tp_alloc_type
;
299 : public _Node_alloc_type
301 _List_node_base _M_node
;
304 : _Node_alloc_type(), _M_node()
307 _List_impl(const _Node_alloc_type
& __a
)
308 : _Node_alloc_type(__a
), _M_node()
316 { return _M_impl
._Node_alloc_type::allocate(1); }
319 _M_put_node(_List_node
<_Tp
>* __p
)
320 { _M_impl
._Node_alloc_type::deallocate(__p
, 1); }
323 typedef _Alloc allocator_type
;
326 _M_get_Node_allocator()
327 { return *static_cast<_Node_alloc_type
*>(&this->_M_impl
); }
329 const _Node_alloc_type
&
330 _M_get_Node_allocator() const
331 { return *static_cast<const _Node_alloc_type
*>(&this->_M_impl
); }
334 _M_get_Tp_allocator() const
335 { return _Tp_alloc_type(_M_get_Node_allocator()); }
338 get_allocator() const
339 { return allocator_type(_M_get_Node_allocator()); }
345 _List_base(const allocator_type
& __a
)
349 #ifdef __GXX_EXPERIMENTAL_CXX0X__
350 _List_base(_List_base
&& __x
)
351 : _M_impl(__x
._M_get_Node_allocator())
354 _List_node_base::swap(this->_M_impl
._M_node
, __x
._M_impl
._M_node
);
358 // This is what actually destroys the list.
368 this->_M_impl
._M_node
._M_next
= &this->_M_impl
._M_node
;
369 this->_M_impl
._M_node
._M_prev
= &this->_M_impl
._M_node
;
374 * @brief A standard container with linear time access to elements,
375 * and fixed time insertion/deletion at any point in the sequence.
379 * Meets the requirements of a <a href="tables.html#65">container</a>, a
380 * <a href="tables.html#66">reversible container</a>, and a
381 * <a href="tables.html#67">sequence</a>, including the
382 * <a href="tables.html#68">optional sequence requirements</a> with the
383 * %exception of @c at and @c operator[].
385 * This is a @e doubly @e linked %list. Traversal up and down the
386 * %list requires linear time, but adding and removing elements (or
387 * @e nodes) is done in constant time, regardless of where the
388 * change takes place. Unlike std::vector and std::deque,
389 * random-access iterators are not provided, so subscripting ( @c
390 * [] ) access is not allowed. For algorithms which only need
391 * sequential access, this lack makes no difference.
393 * Also unlike the other standard containers, std::list provides
394 * specialized algorithms %unique to linked lists, such as
395 * splicing, sorting, and in-place reversal.
397 * A couple points on memory allocation for list<Tp>:
399 * First, we never actually allocate a Tp, we allocate
400 * List_node<Tp>'s and trust [20.1.5]/4 to DTRT. This is to ensure
401 * that after elements from %list<X,Alloc1> are spliced into
402 * %list<X,Alloc2>, destroying the memory of the second %list is a
403 * valid operation, i.e., Alloc1 giveth and Alloc2 taketh away.
405 * Second, a %list conceptually represented as
407 * A <---> B <---> C <---> D
409 * is actually circular; a link exists between A and D. The %list
410 * class holds (as its only data member) a private list::iterator
411 * pointing to @e D, not to @e A! To get to the head of the %list,
412 * we start at the tail and move forward by one. When this member
413 * iterator's next/previous pointers refer to itself, the %list is
416 template<typename _Tp
, typename _Alloc
= std::allocator
<_Tp
> >
417 class list
: protected _List_base
<_Tp
, _Alloc
>
419 // concept requirements
420 typedef typename
_Alloc::value_type _Alloc_value_type
;
421 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
422 __glibcxx_class_requires2(_Tp
, _Alloc_value_type
, _SameTypeConcept
)
424 typedef _List_base
<_Tp
, _Alloc
> _Base
;
425 typedef typename
_Base::_Tp_alloc_type _Tp_alloc_type
;
428 typedef _Tp value_type
;
429 typedef typename
_Tp_alloc_type::pointer pointer
;
430 typedef typename
_Tp_alloc_type::const_pointer const_pointer
;
431 typedef typename
_Tp_alloc_type::reference reference
;
432 typedef typename
_Tp_alloc_type::const_reference const_reference
;
433 typedef _List_iterator
<_Tp
> iterator
;
434 typedef _List_const_iterator
<_Tp
> const_iterator
;
435 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
436 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
437 typedef size_t size_type
;
438 typedef ptrdiff_t difference_type
;
439 typedef _Alloc allocator_type
;
442 // Note that pointers-to-_Node's can be ctor-converted to
444 typedef _List_node
<_Tp
> _Node
;
446 using _Base::_M_impl
;
447 using _Base::_M_put_node
;
448 using _Base::_M_get_node
;
449 using _Base::_M_get_Tp_allocator
;
450 using _Base::_M_get_Node_allocator
;
453 * @param x An instance of user data.
455 * Allocates space for a new node and constructs a copy of @a x in it.
457 #ifndef __GXX_EXPERIMENTAL_CXX0X__
459 _M_create_node(const value_type
& __x
)
461 _Node
* __p
= this->_M_get_node();
464 _M_get_Tp_allocator().construct(&__p
->_M_data
, __x
);
469 __throw_exception_again
;
474 template<typename
... _Args
>
476 _M_create_node(_Args
&&... __args
)
478 _Node
* __p
= this->_M_get_node();
481 _M_get_Node_allocator().construct(__p
,
482 std::forward
<_Args
>(__args
)...);
487 __throw_exception_again
;
494 // [23.2.2.1] construct/copy/destroy
495 // (assign() and get_allocator() are also listed in this section)
497 * @brief Default constructor creates no elements.
503 * @brief Creates a %list with no elements.
504 * @param a An allocator object.
507 list(const allocator_type
& __a
)
511 * @brief Creates a %list with copies of an exemplar element.
512 * @param n The number of elements to initially create.
513 * @param value An element to copy.
514 * @param a An allocator object.
516 * This constructor fills the %list with @a n copies of @a value.
519 list(size_type __n
, const value_type
& __value
= value_type(),
520 const allocator_type
& __a
= allocator_type())
522 { _M_fill_initialize(__n
, __value
); }
525 * @brief %List copy constructor.
526 * @param x A %list of identical element and allocator types.
528 * The newly-created %list uses a copy of the allocation object used
531 list(const list
& __x
)
532 : _Base(__x
._M_get_Node_allocator())
533 { _M_initialize_dispatch(__x
.begin(), __x
.end(), __false_type()); }
535 #ifdef __GXX_EXPERIMENTAL_CXX0X__
537 * @brief %List move constructor.
538 * @param x A %list of identical element and allocator types.
540 * The newly-created %list contains the exact contents of @a x.
541 * The contents of @a x are a valid, but unspecified %list.
544 : _Base(std::forward
<_Base
>(__x
)) { }
547 * @brief Builds a %list from an initializer_list
548 * @param l An initializer_list of value_type.
549 * @param a An allocator object.
551 * Create a %list consisting of copies of the elements in the
552 * initializer_list @a l. This is linear in l.size().
554 list(initializer_list
<value_type
> __l
,
555 const allocator_type
& __a
= allocator_type())
557 { _M_initialize_dispatch(__l
.begin(), __l
.end(), __false_type()); }
561 * @brief Builds a %list from a range.
562 * @param first An input iterator.
563 * @param last An input iterator.
564 * @param a An allocator object.
566 * Create a %list consisting of copies of the elements from
567 * [@a first,@a last). This is linear in N (where N is
568 * distance(@a first,@a last)).
570 template<typename _InputIterator
>
571 list(_InputIterator __first
, _InputIterator __last
,
572 const allocator_type
& __a
= allocator_type())
575 // Check whether it's an integral type. If so, it's not an iterator.
576 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
577 _M_initialize_dispatch(__first
, __last
, _Integral());
581 * No explicit dtor needed as the _Base dtor takes care of
582 * things. The _Base dtor only erases the elements, and note
583 * that if the elements themselves are pointers, the pointed-to
584 * memory is not touched in any way. Managing the pointer is
585 * the user's responsibility.
589 * @brief %List assignment operator.
590 * @param x A %list of identical element and allocator types.
592 * All the elements of @a x are copied, but unlike the copy
593 * constructor, the allocator object is not copied.
596 operator=(const list
& __x
);
598 #ifdef __GXX_EXPERIMENTAL_CXX0X__
600 * @brief %List move assignment operator.
601 * @param x A %list of identical element and allocator types.
603 * The contents of @a x are moved into this %list (without copying).
604 * @a x is a valid, but unspecified %list
607 operator=(list
&& __x
)
616 * @brief %List initializer list assignment operator.
617 * @param l An initializer_list of value_type.
619 * Replace the contents of the %list with copies of the elements
620 * in the initializer_list @a l. This is linear in l.size().
623 operator=(initializer_list
<value_type
> __l
)
625 this->assign(__l
.begin(), __l
.end());
631 * @brief Assigns a given value to a %list.
632 * @param n Number of elements to be assigned.
633 * @param val Value to be assigned.
635 * This function fills a %list with @a n copies of the given
636 * value. Note that the assignment completely changes the %list
637 * and that the resulting %list's size is the same as the number
638 * of elements assigned. Old data may be lost.
641 assign(size_type __n
, const value_type
& __val
)
642 { _M_fill_assign(__n
, __val
); }
645 * @brief Assigns a range to a %list.
646 * @param first An input iterator.
647 * @param last An input iterator.
649 * This function fills a %list with copies of the elements in the
650 * range [@a first,@a last).
652 * Note that the assignment completely changes the %list and
653 * that the resulting %list's size is the same as the number of
654 * elements assigned. Old data may be lost.
656 template<typename _InputIterator
>
658 assign(_InputIterator __first
, _InputIterator __last
)
660 // Check whether it's an integral type. If so, it's not an iterator.
661 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
662 _M_assign_dispatch(__first
, __last
, _Integral());
665 #ifdef __GXX_EXPERIMENTAL_CXX0X__
667 * @brief Assigns an initializer_list to a %list.
668 * @param l An initializer_list of value_type.
670 * Replace the contents of the %list with copies of the elements
671 * in the initializer_list @a l. This is linear in l.size().
674 assign(initializer_list
<value_type
> __l
)
675 { this->assign(__l
.begin(), __l
.end()); }
678 /// Get a copy of the memory allocation object.
680 get_allocator() const
681 { return _Base::get_allocator(); }
685 * Returns a read/write iterator that points to the first element in the
686 * %list. Iteration is done in ordinary element order.
690 { return iterator(this->_M_impl
._M_node
._M_next
); }
693 * Returns a read-only (constant) iterator that points to the
694 * first element in the %list. Iteration is done in ordinary
699 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
702 * Returns a read/write iterator that points one past the last
703 * element in the %list. Iteration is done in ordinary element
708 { return iterator(&this->_M_impl
._M_node
); }
711 * Returns a read-only (constant) iterator that points one past
712 * the last element in the %list. Iteration is done in ordinary
717 { return const_iterator(&this->_M_impl
._M_node
); }
720 * Returns a read/write reverse iterator that points to the last
721 * element in the %list. Iteration is done in reverse element
726 { return reverse_iterator(end()); }
729 * Returns a read-only (constant) reverse iterator that points to
730 * the last element in the %list. Iteration is done in reverse
733 const_reverse_iterator
735 { return const_reverse_iterator(end()); }
738 * Returns a read/write reverse iterator that points to one
739 * before the first element in the %list. Iteration is done in
740 * reverse element order.
744 { return reverse_iterator(begin()); }
747 * Returns a read-only (constant) reverse iterator that points to one
748 * before the first element in the %list. Iteration is done in reverse
751 const_reverse_iterator
753 { return const_reverse_iterator(begin()); }
755 #ifdef __GXX_EXPERIMENTAL_CXX0X__
757 * Returns a read-only (constant) iterator that points to the
758 * first element in the %list. Iteration is done in ordinary
763 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
766 * Returns a read-only (constant) iterator that points one past
767 * the last element in the %list. Iteration is done in ordinary
772 { return const_iterator(&this->_M_impl
._M_node
); }
775 * Returns a read-only (constant) reverse iterator that points to
776 * the last element in the %list. Iteration is done in reverse
779 const_reverse_iterator
781 { return const_reverse_iterator(end()); }
784 * Returns a read-only (constant) reverse iterator that points to one
785 * before the first element in the %list. Iteration is done in reverse
788 const_reverse_iterator
790 { return const_reverse_iterator(begin()); }
793 // [23.2.2.2] capacity
795 * Returns true if the %list is empty. (Thus begin() would equal
800 { return this->_M_impl
._M_node
._M_next
== &this->_M_impl
._M_node
; }
802 /** Returns the number of elements in the %list. */
805 { return std::distance(begin(), end()); }
807 /** Returns the size() of the largest possible %list. */
810 { return _M_get_Node_allocator().max_size(); }
813 * @brief Resizes the %list to the specified number of elements.
814 * @param new_size Number of elements the %list should contain.
815 * @param x Data with which new elements should be populated.
817 * This function will %resize the %list to the specified number
818 * of elements. If the number is smaller than the %list's
819 * current size the %list is truncated, otherwise the %list is
820 * extended and new elements are populated with given data.
823 resize(size_type __new_size
, value_type __x
= value_type());
827 * Returns a read/write reference to the data at the first
828 * element of the %list.
835 * Returns a read-only (constant) reference to the data at the first
836 * element of the %list.
843 * Returns a read/write reference to the data at the last element
849 iterator __tmp
= end();
855 * Returns a read-only (constant) reference to the data at the last
856 * element of the %list.
861 const_iterator __tmp
= end();
866 // [23.2.2.3] modifiers
868 * @brief Add data to the front of the %list.
869 * @param x Data to be added.
871 * This is a typical stack operation. The function creates an
872 * element at the front of the %list and assigns the given data
873 * to it. Due to the nature of a %list this operation can be
874 * done in constant time, and does not invalidate iterators and
878 push_front(const value_type
& __x
)
879 { this->_M_insert(begin(), __x
); }
881 #ifdef __GXX_EXPERIMENTAL_CXX0X__
883 push_front(value_type
&& __x
)
884 { this->_M_insert(begin(), std::move(__x
)); }
886 template<typename
... _Args
>
888 emplace_front(_Args
&&... __args
)
889 { this->_M_insert(begin(), std::forward
<_Args
>(__args
)...); }
893 * @brief Removes first element.
895 * This is a typical stack operation. It shrinks the %list by
896 * one. Due to the nature of a %list this operation can be done
897 * in constant time, and only invalidates iterators/references to
898 * the element being removed.
900 * Note that no data is returned, and if the first element's data
901 * is needed, it should be retrieved before pop_front() is
906 { this->_M_erase(begin()); }
909 * @brief Add data to the end of the %list.
910 * @param x Data to be added.
912 * This is a typical stack operation. The function creates an
913 * element at the end of the %list and assigns the given data to
914 * it. Due to the nature of a %list this operation can be done
915 * in constant time, and does not invalidate iterators and
919 push_back(const value_type
& __x
)
920 { this->_M_insert(end(), __x
); }
922 #ifdef __GXX_EXPERIMENTAL_CXX0X__
924 push_back(value_type
&& __x
)
925 { this->_M_insert(end(), std::move(__x
)); }
927 template<typename
... _Args
>
929 emplace_back(_Args
&&... __args
)
930 { this->_M_insert(end(), std::forward
<_Args
>(__args
)...); }
934 * @brief Removes last element.
936 * This is a typical stack operation. It shrinks the %list by
937 * one. Due to the nature of a %list this operation can be done
938 * in constant time, and only invalidates iterators/references to
939 * the element being removed.
941 * Note that no data is returned, and if the last element's data
942 * is needed, it should be retrieved before pop_back() is called.
946 { this->_M_erase(iterator(this->_M_impl
._M_node
._M_prev
)); }
948 #ifdef __GXX_EXPERIMENTAL_CXX0X__
950 * @brief Constructs object in %list before specified iterator.
951 * @param position A const_iterator into the %list.
952 * @param args Arguments.
953 * @return An iterator that points to the inserted data.
955 * This function will insert an object of type T constructed
956 * with T(std::forward<Args>(args)...) before the specified
957 * location. Due to the nature of a %list this operation can
958 * be done in constant time, and does not invalidate iterators
961 template<typename
... _Args
>
963 emplace(iterator __position
, _Args
&&... __args
);
967 * @brief Inserts given value into %list before specified iterator.
968 * @param position An iterator into the %list.
969 * @param x Data to be inserted.
970 * @return An iterator that points to the inserted data.
972 * This function will insert a copy of the given value before
973 * the specified location. Due to the nature of a %list this
974 * operation can be done in constant time, and does not
975 * invalidate iterators and references.
978 insert(iterator __position
, const value_type
& __x
);
980 #ifdef __GXX_EXPERIMENTAL_CXX0X__
982 * @brief Inserts given rvalue into %list before specified iterator.
983 * @param position An iterator into the %list.
984 * @param x Data to be inserted.
985 * @return An iterator that points to the inserted data.
987 * This function will insert a copy of the given rvalue before
988 * the specified location. Due to the nature of a %list this
989 * operation can be done in constant time, and does not
990 * invalidate iterators and references.
993 insert(iterator __position
, value_type
&& __x
)
994 { return emplace(__position
, std::move(__x
)); }
997 * @brief Inserts the contents of an initializer_list into %list
998 * before specified iterator.
999 * @param p An iterator into the %list.
1000 * @param l An initializer_list of value_type.
1002 * This function will insert copies of the data in the
1003 * initializer_list @a l into the %list before the location
1004 * specified by @a p.
1006 * This operation is linear in the number of elements inserted and
1007 * does not invalidate iterators and references.
1010 insert(iterator __p
, initializer_list
<value_type
> __l
)
1011 { this->insert(__p
, __l
.begin(), __l
.end()); }
1015 * @brief Inserts a number of copies of given data into the %list.
1016 * @param position An iterator into the %list.
1017 * @param n Number of elements to be inserted.
1018 * @param x Data to be inserted.
1020 * This function will insert a specified number of copies of the
1021 * given data before the location specified by @a position.
1023 * This operation is linear in the number of elements inserted and
1024 * does not invalidate iterators and references.
1027 insert(iterator __position
, size_type __n
, const value_type
& __x
)
1029 list
__tmp(__n
, __x
, _M_get_Node_allocator());
1030 splice(__position
, __tmp
);
1034 * @brief Inserts a range into the %list.
1035 * @param position An iterator into the %list.
1036 * @param first An input iterator.
1037 * @param last An input iterator.
1039 * This function will insert copies of the data in the range [@a
1040 * first,@a last) into the %list before the location specified by
1043 * This operation is linear in the number of elements inserted and
1044 * does not invalidate iterators and references.
1046 template<typename _InputIterator
>
1048 insert(iterator __position
, _InputIterator __first
,
1049 _InputIterator __last
)
1051 list
__tmp(__first
, __last
, _M_get_Node_allocator());
1052 splice(__position
, __tmp
);
1056 * @brief Remove element at given position.
1057 * @param position Iterator pointing to element to be erased.
1058 * @return An iterator pointing to the next element (or end()).
1060 * This function will erase the element at the given position and thus
1061 * shorten the %list by one.
1063 * Due to the nature of a %list this operation can be done in
1064 * constant time, and only invalidates iterators/references to
1065 * the element being removed. The user is also cautioned that
1066 * this function only erases the element, and that if the element
1067 * is itself a pointer, the pointed-to memory is not touched in
1068 * any way. Managing the pointer is the user's responsibility.
1071 erase(iterator __position
);
1074 * @brief Remove a range of elements.
1075 * @param first Iterator pointing to the first element to be erased.
1076 * @param last Iterator pointing to one past the last element to be
1078 * @return An iterator pointing to the element pointed to by @a last
1079 * prior to erasing (or end()).
1081 * This function will erase the elements in the range @a
1082 * [first,last) and shorten the %list accordingly.
1084 * This operation is linear time in the size of the range and only
1085 * invalidates iterators/references to the element being removed.
1086 * The user is also cautioned that this function only erases the
1087 * elements, and that if the elements themselves are pointers, the
1088 * pointed-to memory is not touched in any way. Managing the pointer
1089 * is the user's responsibility.
1092 erase(iterator __first
, iterator __last
)
1094 while (__first
!= __last
)
1095 __first
= erase(__first
);
1100 * @brief Swaps data with another %list.
1101 * @param x A %list of the same element and allocator types.
1103 * This exchanges the elements between two lists in constant
1104 * time. Note that the global std::swap() function is
1105 * specialized such that std::swap(l1,l2) will feed to this
1111 _List_node_base::swap(this->_M_impl
._M_node
, __x
._M_impl
._M_node
);
1113 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1114 // 431. Swapping containers with unequal allocators.
1115 std::__alloc_swap
<typename
_Base::_Node_alloc_type
>::
1116 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator());
1120 * Erases all the elements. Note that this function only erases
1121 * the elements, and that if the elements themselves are
1122 * pointers, the pointed-to memory is not touched in any way.
1123 * Managing the pointer is the user's responsibility.
1132 // [23.2.2.4] list operations
1134 * @brief Insert contents of another %list.
1135 * @param position Iterator referencing the element to insert before.
1136 * @param x Source list.
1138 * The elements of @a x are inserted in constant time in front of
1139 * the element referenced by @a position. @a x becomes an empty
1142 * Requires this != @a x.
1145 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1146 splice(iterator __position
, list
&& __x
)
1148 splice(iterator __position
, list
& __x
)
1153 _M_check_equal_allocators(__x
);
1155 this->_M_transfer(__position
, __x
.begin(), __x
.end());
1160 * @brief Insert element from another %list.
1161 * @param position Iterator referencing the element to insert before.
1162 * @param x Source list.
1163 * @param i Iterator referencing the element to move.
1165 * Removes the element in list @a x referenced by @a i and
1166 * inserts it into the current list before @a position.
1169 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1170 splice(iterator __position
, list
&& __x
, iterator __i
)
1172 splice(iterator __position
, list
& __x
, iterator __i
)
1177 if (__position
== __i
|| __position
== __j
)
1181 _M_check_equal_allocators(__x
);
1183 this->_M_transfer(__position
, __i
, __j
);
1187 * @brief Insert range from another %list.
1188 * @param position Iterator referencing the element to insert before.
1189 * @param x Source list.
1190 * @param first Iterator referencing the start of range in x.
1191 * @param last Iterator referencing the end of range in x.
1193 * Removes elements in the range [first,last) and inserts them
1194 * before @a position in constant time.
1196 * Undefined if @a position is in [first,last).
1199 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1200 splice(iterator __position
, list
&& __x
, iterator __first
,
1203 splice(iterator __position
, list
& __x
, iterator __first
,
1207 if (__first
!= __last
)
1210 _M_check_equal_allocators(__x
);
1212 this->_M_transfer(__position
, __first
, __last
);
1217 * @brief Remove all elements equal to value.
1218 * @param value The value to remove.
1220 * Removes every element in the list equal to @a value.
1221 * Remaining elements stay in list order. Note that this
1222 * function only erases the elements, and that if the elements
1223 * themselves are pointers, the pointed-to memory is not
1224 * touched in any way. Managing the pointer is the user's
1228 remove(const _Tp
& __value
);
1231 * @brief Remove all elements satisfying a predicate.
1232 * @param Predicate Unary predicate function or object.
1234 * Removes every element in the list for which the predicate
1235 * returns true. Remaining elements stay in list order. Note
1236 * that this function only erases the elements, and that if the
1237 * elements themselves are pointers, the pointed-to memory is
1238 * not touched in any way. Managing the pointer is the user's
1241 template<typename _Predicate
>
1243 remove_if(_Predicate
);
1246 * @brief Remove consecutive duplicate elements.
1248 * For each consecutive set of elements with the same value,
1249 * remove all but the first one. Remaining elements stay in
1250 * list order. Note that this function only erases the
1251 * elements, and that if the elements themselves are pointers,
1252 * the pointed-to memory is not touched in any way. Managing
1253 * the pointer is the user's responsibility.
1259 * @brief Remove consecutive elements satisfying a predicate.
1260 * @param BinaryPredicate Binary predicate function or object.
1262 * For each consecutive set of elements [first,last) that
1263 * satisfy predicate(first,i) where i is an iterator in
1264 * [first,last), remove all but the first one. Remaining
1265 * elements stay in list order. Note that this function only
1266 * erases the elements, and that if the elements themselves are
1267 * pointers, the pointed-to memory is not touched in any way.
1268 * Managing the pointer is the user's responsibility.
1270 template<typename _BinaryPredicate
>
1272 unique(_BinaryPredicate
);
1275 * @brief Merge sorted lists.
1276 * @param x Sorted list to merge.
1278 * Assumes that both @a x and this list are sorted according to
1279 * operator<(). Merges elements of @a x into this list in
1280 * sorted order, leaving @a x empty when complete. Elements in
1281 * this list precede elements in @a x that are equal.
1284 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1291 * @brief Merge sorted lists according to comparison function.
1292 * @param x Sorted list to merge.
1293 * @param StrictWeakOrdering Comparison function defining
1296 * Assumes that both @a x and this list are sorted according to
1297 * StrictWeakOrdering. Merges elements of @a x into this list
1298 * in sorted order, leaving @a x empty when complete. Elements
1299 * in this list precede elements in @a x that are equivalent
1300 * according to StrictWeakOrdering().
1302 template<typename _StrictWeakOrdering
>
1304 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1305 merge(list
&&, _StrictWeakOrdering
);
1307 merge(list
&, _StrictWeakOrdering
);
1311 * @brief Reverse the elements in list.
1313 * Reverse the order of elements in the list in linear time.
1317 { this->_M_impl
._M_node
.reverse(); }
1320 * @brief Sort the elements.
1322 * Sorts the elements of this list in NlogN time. Equivalent
1323 * elements remain in list order.
1329 * @brief Sort the elements according to comparison function.
1331 * Sorts the elements of this list in NlogN time. Equivalent
1332 * elements remain in list order.
1334 template<typename _StrictWeakOrdering
>
1336 sort(_StrictWeakOrdering
);
1339 // Internal constructor functions follow.
1341 // Called by the range constructor to implement [23.1.1]/9
1343 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1344 // 438. Ambiguity in the "do the right thing" clause
1345 template<typename _Integer
>
1347 _M_initialize_dispatch(_Integer __n
, _Integer __x
, __true_type
)
1348 { _M_fill_initialize(static_cast<size_type
>(__n
), __x
); }
1350 // Called by the range constructor to implement [23.1.1]/9
1351 template<typename _InputIterator
>
1353 _M_initialize_dispatch(_InputIterator __first
, _InputIterator __last
,
1356 for (; __first
!= __last
; ++__first
)
1357 push_back(*__first
);
1360 // Called by list(n,v,a), and the range constructor when it turns out
1361 // to be the same thing.
1363 _M_fill_initialize(size_type __n
, const value_type
& __x
)
1365 for (; __n
> 0; --__n
)
1370 // Internal assign functions follow.
1372 // Called by the range assign to implement [23.1.1]/9
1374 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1375 // 438. Ambiguity in the "do the right thing" clause
1376 template<typename _Integer
>
1378 _M_assign_dispatch(_Integer __n
, _Integer __val
, __true_type
)
1379 { _M_fill_assign(__n
, __val
); }
1381 // Called by the range assign to implement [23.1.1]/9
1382 template<typename _InputIterator
>
1384 _M_assign_dispatch(_InputIterator __first
, _InputIterator __last
,
1387 // Called by assign(n,t), and the range assign when it turns out
1388 // to be the same thing.
1390 _M_fill_assign(size_type __n
, const value_type
& __val
);
1393 // Moves the elements from [first,last) before position.
1395 _M_transfer(iterator __position
, iterator __first
, iterator __last
)
1396 { __position
._M_node
->transfer(__first
._M_node
, __last
._M_node
); }
1398 // Inserts new element at position given and with value given.
1399 #ifndef __GXX_EXPERIMENTAL_CXX0X__
1401 _M_insert(iterator __position
, const value_type
& __x
)
1403 _Node
* __tmp
= _M_create_node(__x
);
1404 __tmp
->hook(__position
._M_node
);
1407 template<typename
... _Args
>
1409 _M_insert(iterator __position
, _Args
&&... __args
)
1411 _Node
* __tmp
= _M_create_node(std::forward
<_Args
>(__args
)...);
1412 __tmp
->hook(__position
._M_node
);
1416 // Erases element at position given.
1418 _M_erase(iterator __position
)
1420 __position
._M_node
->unhook();
1421 _Node
* __n
= static_cast<_Node
*>(__position
._M_node
);
1422 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1423 _M_get_Node_allocator().destroy(__n
);
1425 _M_get_Tp_allocator().destroy(&__n
->_M_data
);
1430 // To implement the splice (and merge) bits of N1599.
1432 _M_check_equal_allocators(list
& __x
)
1434 if (std::__alloc_neq
<typename
_Base::_Node_alloc_type
>::
1435 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator()))
1436 __throw_runtime_error(__N("list::_M_check_equal_allocators"));
1441 * @brief List equality comparison.
1443 * @param y A %list of the same type as @a x.
1444 * @return True iff the size and elements of the lists are equal.
1446 * This is an equivalence relation. It is linear in the size of
1447 * the lists. Lists are considered equivalent if their sizes are
1448 * equal, and if corresponding elements compare equal.
1450 template<typename _Tp
, typename _Alloc
>
1452 operator==(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1454 typedef typename list
<_Tp
, _Alloc
>::const_iterator const_iterator
;
1455 const_iterator __end1
= __x
.end();
1456 const_iterator __end2
= __y
.end();
1458 const_iterator __i1
= __x
.begin();
1459 const_iterator __i2
= __y
.begin();
1460 while (__i1
!= __end1
&& __i2
!= __end2
&& *__i1
== *__i2
)
1465 return __i1
== __end1
&& __i2
== __end2
;
1469 * @brief List ordering relation.
1471 * @param y A %list of the same type as @a x.
1472 * @return True iff @a x is lexicographically less than @a y.
1474 * This is a total ordering relation. It is linear in the size of the
1475 * lists. The elements must be comparable with @c <.
1477 * See std::lexicographical_compare() for how the determination is made.
1479 template<typename _Tp
, typename _Alloc
>
1481 operator<(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1482 { return std::lexicographical_compare(__x
.begin(), __x
.end(),
1483 __y
.begin(), __y
.end()); }
1485 /// Based on operator==
1486 template<typename _Tp
, typename _Alloc
>
1488 operator!=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1489 { return !(__x
== __y
); }
1491 /// Based on operator<
1492 template<typename _Tp
, typename _Alloc
>
1494 operator>(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1495 { return __y
< __x
; }
1497 /// Based on operator<
1498 template<typename _Tp
, typename _Alloc
>
1500 operator<=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1501 { return !(__y
< __x
); }
1503 /// Based on operator<
1504 template<typename _Tp
, typename _Alloc
>
1506 operator>=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1507 { return !(__x
< __y
); }
1509 /// See std::list::swap().
1510 template<typename _Tp
, typename _Alloc
>
1512 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>& __y
)
1515 _GLIBCXX_END_NESTED_NAMESPACE
1517 #endif /* _STL_LIST_H */