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 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>
66 #include <initializer_list>
68 _GLIBCXX_BEGIN_NESTED_NAMESPACE(std
, _GLIBCXX_STD_D
)
70 // Supporting structures are split into common and templated types; the
71 // latter publicly inherits from the former in an effort to reduce code
72 // duplication. This results in some "needless" static_cast'ing later on,
73 // but it's all safe downcasting.
75 /// Common part of a node in the %list.
76 struct _List_node_base
78 _List_node_base
* _M_next
;
79 _List_node_base
* _M_prev
;
82 swap(_List_node_base
& __x
, _List_node_base
& __y
);
85 transfer(_List_node_base
* const __first
,
86 _List_node_base
* const __last
);
92 hook(_List_node_base
* const __position
);
98 /// An actual node in the %list.
99 template<typename _Tp
>
100 struct _List_node
: public _List_node_base
105 #ifdef __GXX_EXPERIMENTAL_CXX0X__
106 template<typename
... _Args
>
107 _List_node(_Args
&&... __args
)
108 : _List_node_base(), _M_data(std::forward
<_Args
>(__args
)...) { }
113 * @brief A list::iterator.
115 * All the functions are op overloads.
117 template<typename _Tp
>
118 struct _List_iterator
120 typedef _List_iterator
<_Tp
> _Self
;
121 typedef _List_node
<_Tp
> _Node
;
123 typedef ptrdiff_t difference_type
;
124 typedef std::bidirectional_iterator_tag iterator_category
;
125 typedef _Tp value_type
;
126 typedef _Tp
* pointer
;
127 typedef _Tp
& reference
;
133 _List_iterator(_List_node_base
* __x
)
136 // Must downcast from List_node_base to _List_node to get to _M_data.
139 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
143 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
148 _M_node
= _M_node
->_M_next
;
156 _M_node
= _M_node
->_M_next
;
163 _M_node
= _M_node
->_M_prev
;
171 _M_node
= _M_node
->_M_prev
;
176 operator==(const _Self
& __x
) const
177 { return _M_node
== __x
._M_node
; }
180 operator!=(const _Self
& __x
) const
181 { return _M_node
!= __x
._M_node
; }
183 // The only member points to the %list element.
184 _List_node_base
* _M_node
;
188 * @brief A list::const_iterator.
190 * All the functions are op overloads.
192 template<typename _Tp
>
193 struct _List_const_iterator
195 typedef _List_const_iterator
<_Tp
> _Self
;
196 typedef const _List_node
<_Tp
> _Node
;
197 typedef _List_iterator
<_Tp
> iterator
;
199 typedef ptrdiff_t difference_type
;
200 typedef std::bidirectional_iterator_tag iterator_category
;
201 typedef _Tp value_type
;
202 typedef const _Tp
* pointer
;
203 typedef const _Tp
& reference
;
205 _List_const_iterator()
209 _List_const_iterator(const _List_node_base
* __x
)
212 _List_const_iterator(const iterator
& __x
)
213 : _M_node(__x
._M_node
) { }
215 // Must downcast from List_node_base to _List_node to get to
219 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
223 { return &static_cast<_Node
*>(_M_node
)->_M_data
; }
228 _M_node
= _M_node
->_M_next
;
236 _M_node
= _M_node
->_M_next
;
243 _M_node
= _M_node
->_M_prev
;
251 _M_node
= _M_node
->_M_prev
;
256 operator==(const _Self
& __x
) const
257 { return _M_node
== __x
._M_node
; }
260 operator!=(const _Self
& __x
) const
261 { return _M_node
!= __x
._M_node
; }
263 // The only member points to the %list element.
264 const _List_node_base
* _M_node
;
267 template<typename _Val
>
269 operator==(const _List_iterator
<_Val
>& __x
,
270 const _List_const_iterator
<_Val
>& __y
)
271 { return __x
._M_node
== __y
._M_node
; }
273 template<typename _Val
>
275 operator!=(const _List_iterator
<_Val
>& __x
,
276 const _List_const_iterator
<_Val
>& __y
)
277 { return __x
._M_node
!= __y
._M_node
; }
280 /// 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.
403 * A couple points on memory allocation for list<Tp>:
405 * First, we never actually allocate a Tp, we allocate
406 * List_node<Tp>'s and trust [20.1.5]/4 to DTRT. This is to ensure
407 * that after elements from %list<X,Alloc1> are spliced into
408 * %list<X,Alloc2>, destroying the memory of the second %list is a
409 * valid operation, i.e., Alloc1 giveth and Alloc2 taketh away.
411 * Second, a %list conceptually represented as
413 * A <---> B <---> C <---> D
415 * is actually circular; a link exists between A and D. The %list
416 * class holds (as its only data member) a private list::iterator
417 * pointing to @e D, not to @e A! To get to the head of the %list,
418 * we start at the tail and move forward by one. When this member
419 * iterator's next/previous pointers refer to itself, the %list is
422 template<typename _Tp
, typename _Alloc
= std::allocator
<_Tp
> >
423 class list
: protected _List_base
<_Tp
, _Alloc
>
425 // concept requirements
426 typedef typename
_Alloc::value_type _Alloc_value_type
;
427 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
428 __glibcxx_class_requires2(_Tp
, _Alloc_value_type
, _SameTypeConcept
)
430 typedef _List_base
<_Tp
, _Alloc
> _Base
;
431 typedef typename
_Base::_Tp_alloc_type _Tp_alloc_type
;
434 typedef _Tp value_type
;
435 typedef typename
_Tp_alloc_type::pointer pointer
;
436 typedef typename
_Tp_alloc_type::const_pointer const_pointer
;
437 typedef typename
_Tp_alloc_type::reference reference
;
438 typedef typename
_Tp_alloc_type::const_reference const_reference
;
439 typedef _List_iterator
<_Tp
> iterator
;
440 typedef _List_const_iterator
<_Tp
> const_iterator
;
441 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
442 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
443 typedef size_t size_type
;
444 typedef ptrdiff_t difference_type
;
445 typedef _Alloc allocator_type
;
448 // Note that pointers-to-_Node's can be ctor-converted to
450 typedef _List_node
<_Tp
> _Node
;
452 using _Base::_M_impl
;
453 using _Base::_M_put_node
;
454 using _Base::_M_get_node
;
455 using _Base::_M_get_Tp_allocator
;
456 using _Base::_M_get_Node_allocator
;
459 * @param x An instance of user data.
461 * Allocates space for a new node and constructs a copy of @a x in it.
463 #ifndef __GXX_EXPERIMENTAL_CXX0X__
465 _M_create_node(const value_type
& __x
)
467 _Node
* __p
= this->_M_get_node();
470 _M_get_Tp_allocator().construct(&__p
->_M_data
, __x
);
475 __throw_exception_again
;
480 template<typename
... _Args
>
482 _M_create_node(_Args
&&... __args
)
484 _Node
* __p
= this->_M_get_node();
487 _M_get_Node_allocator().construct(__p
,
488 std::forward
<_Args
>(__args
)...);
493 __throw_exception_again
;
500 // [23.2.2.1] construct/copy/destroy
501 // (assign() and get_allocator() are also listed in this section)
503 * @brief Default constructor creates no elements.
509 * @brief Creates a %list with no elements.
510 * @param a An allocator object.
513 list(const allocator_type
& __a
)
517 * @brief Creates a %list with copies of an exemplar element.
518 * @param n The number of elements to initially create.
519 * @param value An element to copy.
520 * @param a An allocator object.
522 * This constructor fills the %list with @a n copies of @a value.
525 list(size_type __n
, const value_type
& __value
= value_type(),
526 const allocator_type
& __a
= allocator_type())
528 { _M_fill_initialize(__n
, __value
); }
531 * @brief %List copy constructor.
532 * @param x A %list of identical element and allocator types.
534 * The newly-created %list uses a copy of the allocation object used
537 list(const list
& __x
)
538 : _Base(__x
._M_get_Node_allocator())
539 { _M_initialize_dispatch(__x
.begin(), __x
.end(), __false_type()); }
541 #ifdef __GXX_EXPERIMENTAL_CXX0X__
543 * @brief %List move constructor.
544 * @param x A %list of identical element and allocator types.
546 * The newly-created %list contains the exact contents of @a x.
547 * The contents of @a x are a valid, but unspecified %list.
550 : _Base(std::forward
<_Base
>(__x
)) { }
553 * @brief Builds a %list from an initializer_list
554 * @param l An initializer_list of value_type.
555 * @param a An allocator object.
557 * Create a %list consisting of copies of the elements in the
558 * initializer_list @a l. This is linear in l.size().
560 list(initializer_list
<value_type
> __l
,
561 const allocator_type
& __a
= allocator_type())
563 { _M_initialize_dispatch(__l
.begin(), __l
.end(), __false_type()); }
567 * @brief Builds a %list from a range.
568 * @param first An input iterator.
569 * @param last An input iterator.
570 * @param a An allocator object.
572 * Create a %list consisting of copies of the elements from
573 * [@a first,@a last). This is linear in N (where N is
574 * distance(@a first,@a last)).
576 template<typename _InputIterator
>
577 list(_InputIterator __first
, _InputIterator __last
,
578 const allocator_type
& __a
= allocator_type())
581 // Check whether it's an integral type. If so, it's not an iterator.
582 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
583 _M_initialize_dispatch(__first
, __last
, _Integral());
587 * No explicit dtor needed as the _Base dtor takes care of
588 * things. The _Base dtor only erases the elements, and note
589 * that if the elements themselves are pointers, the pointed-to
590 * memory is not touched in any way. Managing the pointer is
591 * the user's responsibility.
595 * @brief %List assignment operator.
596 * @param x A %list of identical element and allocator types.
598 * All the elements of @a x are copied, but unlike the copy
599 * constructor, the allocator object is not copied.
602 operator=(const list
& __x
);
604 #ifdef __GXX_EXPERIMENTAL_CXX0X__
606 * @brief %List move assignment operator.
607 * @param x A %list of identical element and allocator types.
609 * The contents of @a x are moved into this %list (without copying).
610 * @a x is a valid, but unspecified %list
613 operator=(list
&& __x
)
622 * @brief %List initializer list assignment operator.
623 * @param l An initializer_list of value_type.
625 * Replace the contents of the %list with copies of the elements
626 * in the initializer_list @a l. This is linear in l.size().
629 operator=(initializer_list
<value_type
> __l
)
631 this->assign(__l
.begin(), __l
.end());
637 * @brief Assigns a given value to a %list.
638 * @param n Number of elements to be assigned.
639 * @param val Value to be assigned.
641 * This function fills a %list with @a n copies of the given
642 * value. Note that the assignment completely changes the %list
643 * and that the resulting %list's size is the same as the number
644 * of elements assigned. Old data may be lost.
647 assign(size_type __n
, const value_type
& __val
)
648 { _M_fill_assign(__n
, __val
); }
651 * @brief Assigns a range to a %list.
652 * @param first An input iterator.
653 * @param last An input iterator.
655 * This function fills a %list with copies of the elements in the
656 * range [@a first,@a last).
658 * Note that the assignment completely changes the %list and
659 * that the resulting %list's size is the same as the number of
660 * elements assigned. Old data may be lost.
662 template<typename _InputIterator
>
664 assign(_InputIterator __first
, _InputIterator __last
)
666 // Check whether it's an integral type. If so, it's not an iterator.
667 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
668 _M_assign_dispatch(__first
, __last
, _Integral());
671 #ifdef __GXX_EXPERIMENTAL_CXX0X__
673 * @brief Assigns an initializer_list to a %list.
674 * @param l An initializer_list of value_type.
676 * Replace the contents of the %list with copies of the elements
677 * in the initializer_list @a l. This is linear in l.size().
680 assign(initializer_list
<value_type
> __l
)
681 { this->assign(__l
.begin(), __l
.end()); }
684 /// Get a copy of the memory allocation object.
686 get_allocator() const
687 { return _Base::get_allocator(); }
691 * Returns a read/write iterator that points to the first element in the
692 * %list. Iteration is done in ordinary element order.
696 { return iterator(this->_M_impl
._M_node
._M_next
); }
699 * Returns a read-only (constant) iterator that points to the
700 * first element in the %list. Iteration is done in ordinary
705 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
708 * Returns a read/write iterator that points one past the last
709 * element in the %list. Iteration is done in ordinary element
714 { return iterator(&this->_M_impl
._M_node
); }
717 * Returns a read-only (constant) iterator that points one past
718 * the last element in the %list. Iteration is done in ordinary
723 { return const_iterator(&this->_M_impl
._M_node
); }
726 * Returns a read/write reverse iterator that points to the last
727 * element in the %list. Iteration is done in reverse element
732 { return reverse_iterator(end()); }
735 * Returns a read-only (constant) reverse iterator that points to
736 * the last element in the %list. Iteration is done in reverse
739 const_reverse_iterator
741 { return const_reverse_iterator(end()); }
744 * Returns a read/write reverse iterator that points to one
745 * before the first element in the %list. Iteration is done in
746 * reverse element order.
750 { return reverse_iterator(begin()); }
753 * Returns a read-only (constant) reverse iterator that points to one
754 * before the first element in the %list. Iteration is done in reverse
757 const_reverse_iterator
759 { return const_reverse_iterator(begin()); }
761 #ifdef __GXX_EXPERIMENTAL_CXX0X__
763 * Returns a read-only (constant) iterator that points to the
764 * first element in the %list. Iteration is done in ordinary
769 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
772 * Returns a read-only (constant) iterator that points one past
773 * the last element in the %list. Iteration is done in ordinary
778 { return const_iterator(&this->_M_impl
._M_node
); }
781 * Returns a read-only (constant) reverse iterator that points to
782 * the last element in the %list. Iteration is done in reverse
785 const_reverse_iterator
787 { return const_reverse_iterator(end()); }
790 * Returns a read-only (constant) reverse iterator that points to one
791 * before the first element in the %list. Iteration is done in reverse
794 const_reverse_iterator
796 { return const_reverse_iterator(begin()); }
799 // [23.2.2.2] capacity
801 * Returns true if the %list is empty. (Thus begin() would equal
806 { return this->_M_impl
._M_node
._M_next
== &this->_M_impl
._M_node
; }
808 /** Returns the number of elements in the %list. */
811 { return std::distance(begin(), end()); }
813 /** Returns the size() of the largest possible %list. */
816 { return _M_get_Node_allocator().max_size(); }
819 * @brief Resizes the %list to the specified number of elements.
820 * @param new_size Number of elements the %list should contain.
821 * @param x Data with which new elements should be populated.
823 * This function will %resize the %list to the specified number
824 * of elements. If the number is smaller than the %list's
825 * current size the %list is truncated, otherwise the %list is
826 * extended and new elements are populated with given data.
829 resize(size_type __new_size
, value_type __x
= value_type());
833 * Returns a read/write reference to the data at the first
834 * element of the %list.
841 * Returns a read-only (constant) reference to the data at the first
842 * element of the %list.
849 * Returns a read/write reference to the data at the last element
855 iterator __tmp
= end();
861 * Returns a read-only (constant) reference to the data at the last
862 * element of the %list.
867 const_iterator __tmp
= end();
872 // [23.2.2.3] modifiers
874 * @brief Add data to the front of the %list.
875 * @param x Data to be added.
877 * This is a typical stack operation. The function creates an
878 * element at the front of the %list and assigns the given data
879 * to it. Due to the nature of a %list this operation can be
880 * done in constant time, and does not invalidate iterators and
884 push_front(const value_type
& __x
)
885 { this->_M_insert(begin(), __x
); }
887 #ifdef __GXX_EXPERIMENTAL_CXX0X__
889 push_front(value_type
&& __x
)
890 { this->_M_insert(begin(), std::move(__x
)); }
892 template<typename
... _Args
>
894 emplace_front(_Args
&&... __args
)
895 { this->_M_insert(begin(), std::forward
<_Args
>(__args
)...); }
899 * @brief Removes first element.
901 * This is a typical stack operation. It shrinks the %list by
902 * one. Due to the nature of a %list this operation can be done
903 * in constant time, and only invalidates iterators/references to
904 * the element being removed.
906 * Note that no data is returned, and if the first element's data
907 * is needed, it should be retrieved before pop_front() is
912 { this->_M_erase(begin()); }
915 * @brief Add data to the end of the %list.
916 * @param x Data to be added.
918 * This is a typical stack operation. The function creates an
919 * element at the end of the %list and assigns the given data to
920 * it. Due to the nature of a %list this operation can be done
921 * in constant time, and does not invalidate iterators and
925 push_back(const value_type
& __x
)
926 { this->_M_insert(end(), __x
); }
928 #ifdef __GXX_EXPERIMENTAL_CXX0X__
930 push_back(value_type
&& __x
)
931 { this->_M_insert(end(), std::move(__x
)); }
933 template<typename
... _Args
>
935 emplace_back(_Args
&&... __args
)
936 { this->_M_insert(end(), std::forward
<_Args
>(__args
)...); }
940 * @brief Removes last element.
942 * This is a typical stack operation. It shrinks the %list by
943 * one. Due to the nature of a %list this operation can be done
944 * in constant time, and only invalidates iterators/references to
945 * the element being removed.
947 * Note that no data is returned, and if the last element's data
948 * is needed, it should be retrieved before pop_back() is called.
952 { this->_M_erase(iterator(this->_M_impl
._M_node
._M_prev
)); }
954 #ifdef __GXX_EXPERIMENTAL_CXX0X__
956 * @brief Constructs object in %list before specified iterator.
957 * @param position A const_iterator into the %list.
958 * @param args Arguments.
959 * @return An iterator that points to the inserted data.
961 * This function will insert an object of type T constructed
962 * with T(std::forward<Args>(args)...) before the specified
963 * location. Due to the nature of a %list this operation can
964 * be done in constant time, and does not invalidate iterators
967 template<typename
... _Args
>
969 emplace(iterator __position
, _Args
&&... __args
);
973 * @brief Inserts given value into %list before specified iterator.
974 * @param position An iterator into the %list.
975 * @param x Data to be inserted.
976 * @return An iterator that points to the inserted data.
978 * This function will insert a copy of the given value before
979 * the specified location. Due to the nature of a %list this
980 * operation can be done in constant time, and does not
981 * invalidate iterators and references.
984 insert(iterator __position
, const value_type
& __x
);
986 #ifdef __GXX_EXPERIMENTAL_CXX0X__
988 * @brief Inserts given rvalue into %list before specified iterator.
989 * @param position An iterator into the %list.
990 * @param x Data to be inserted.
991 * @return An iterator that points to the inserted data.
993 * This function will insert a copy of the given rvalue before
994 * the specified location. Due to the nature of a %list this
995 * operation can be done in constant time, and does not
996 * invalidate iterators and references.
999 insert(iterator __position
, value_type
&& __x
)
1000 { return emplace(__position
, std::move(__x
)); }
1003 * @brief Inserts the contents of an initializer_list into %list
1004 * before specified iterator.
1005 * @param p An iterator into the %list.
1006 * @param l An initializer_list of value_type.
1008 * This function will insert copies of the data in the
1009 * initializer_list @a l into the %list before the location
1010 * specified by @a p.
1012 * This operation is linear in the number of elements inserted and
1013 * does not invalidate iterators and references.
1016 insert(iterator __p
, initializer_list
<value_type
> __l
)
1017 { this->insert(__p
, __l
.begin(), __l
.end()); }
1021 * @brief Inserts a number of copies of given data into the %list.
1022 * @param position An iterator into the %list.
1023 * @param n Number of elements to be inserted.
1024 * @param x Data to be inserted.
1026 * This function will insert a specified number of copies of the
1027 * given data before the location specified by @a position.
1029 * This operation is linear in the number of elements inserted and
1030 * does not invalidate iterators and references.
1033 insert(iterator __position
, size_type __n
, const value_type
& __x
)
1035 list
__tmp(__n
, __x
, _M_get_Node_allocator());
1036 splice(__position
, __tmp
);
1040 * @brief Inserts a range into the %list.
1041 * @param position An iterator into the %list.
1042 * @param first An input iterator.
1043 * @param last An input iterator.
1045 * This function will insert copies of the data in the range [@a
1046 * first,@a last) into the %list before the location specified by
1049 * This operation is linear in the number of elements inserted and
1050 * does not invalidate iterators and references.
1052 template<typename _InputIterator
>
1054 insert(iterator __position
, _InputIterator __first
,
1055 _InputIterator __last
)
1057 list
__tmp(__first
, __last
, _M_get_Node_allocator());
1058 splice(__position
, __tmp
);
1062 * @brief Remove element at given position.
1063 * @param position Iterator pointing to element to be erased.
1064 * @return An iterator pointing to the next element (or end()).
1066 * This function will erase the element at the given position and thus
1067 * shorten the %list by one.
1069 * Due to the nature of a %list this operation can be done in
1070 * constant time, and only invalidates iterators/references to
1071 * the element being removed. The user is also cautioned that
1072 * this function only erases the element, and that if the element
1073 * is itself a pointer, the pointed-to memory is not touched in
1074 * any way. Managing the pointer is the user's responsibility.
1077 erase(iterator __position
);
1080 * @brief Remove a range of elements.
1081 * @param first Iterator pointing to the first element to be erased.
1082 * @param last Iterator pointing to one past the last element to be
1084 * @return An iterator pointing to the element pointed to by @a last
1085 * prior to erasing (or end()).
1087 * This function will erase the elements in the range @a
1088 * [first,last) and shorten the %list accordingly.
1090 * This operation is linear time in the size of the range and only
1091 * invalidates iterators/references to the element being removed.
1092 * The user is also cautioned that this function only erases the
1093 * elements, and that if the elements themselves are pointers, the
1094 * pointed-to memory is not touched in any way. Managing the pointer
1095 * is the user's responsibility.
1098 erase(iterator __first
, iterator __last
)
1100 while (__first
!= __last
)
1101 __first
= erase(__first
);
1106 * @brief Swaps data with another %list.
1107 * @param x A %list of the same element and allocator types.
1109 * This exchanges the elements between two lists in constant
1110 * time. Note that the global std::swap() function is
1111 * specialized such that std::swap(l1,l2) will feed to this
1115 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1121 _List_node_base::swap(this->_M_impl
._M_node
, __x
._M_impl
._M_node
);
1123 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1124 // 431. Swapping containers with unequal allocators.
1125 std::__alloc_swap
<typename
_Base::_Node_alloc_type
>::
1126 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator());
1130 * Erases all the elements. Note that this function only erases
1131 * 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 responsibility.
1142 // [23.2.2.4] list operations
1144 * @brief Insert contents of another %list.
1145 * @param position Iterator referencing the element to insert before.
1146 * @param x Source list.
1148 * The elements of @a x are inserted in constant time in front of
1149 * the element referenced by @a position. @a x becomes an empty
1152 * Requires this != @a x.
1155 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1156 splice(iterator __position
, list
&& __x
)
1158 splice(iterator __position
, list
& __x
)
1163 _M_check_equal_allocators(__x
);
1165 this->_M_transfer(__position
, __x
.begin(), __x
.end());
1170 * @brief Insert element from another %list.
1171 * @param position Iterator referencing the element to insert before.
1172 * @param x Source list.
1173 * @param i Iterator referencing the element to move.
1175 * Removes the element in list @a x referenced by @a i and
1176 * inserts it into the current list before @a position.
1179 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1180 splice(iterator __position
, list
&& __x
, iterator __i
)
1182 splice(iterator __position
, list
& __x
, iterator __i
)
1187 if (__position
== __i
|| __position
== __j
)
1191 _M_check_equal_allocators(__x
);
1193 this->_M_transfer(__position
, __i
, __j
);
1197 * @brief Insert range from another %list.
1198 * @param position Iterator referencing the element to insert before.
1199 * @param x Source list.
1200 * @param first Iterator referencing the start of range in x.
1201 * @param last Iterator referencing the end of range in x.
1203 * Removes elements in the range [first,last) and inserts them
1204 * before @a position in constant time.
1206 * Undefined if @a position is in [first,last).
1209 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1210 splice(iterator __position
, list
&& __x
, iterator __first
,
1213 splice(iterator __position
, list
& __x
, iterator __first
,
1217 if (__first
!= __last
)
1220 _M_check_equal_allocators(__x
);
1222 this->_M_transfer(__position
, __first
, __last
);
1227 * @brief Remove all elements equal to value.
1228 * @param value The value to remove.
1230 * Removes every element in the list equal to @a value.
1231 * Remaining elements stay in list order. Note that this
1232 * function only erases the elements, and that if the elements
1233 * themselves are pointers, the pointed-to memory is not
1234 * touched in any way. Managing the pointer is the user's
1238 remove(const _Tp
& __value
);
1241 * @brief Remove all elements satisfying a predicate.
1242 * @param Predicate Unary predicate function or object.
1244 * Removes every element in the list for which the predicate
1245 * returns true. Remaining elements stay in list order. Note
1246 * that this function only erases the elements, and that if the
1247 * elements themselves are pointers, the pointed-to memory is
1248 * not touched in any way. Managing the pointer is the user's
1251 template<typename _Predicate
>
1253 remove_if(_Predicate
);
1256 * @brief Remove consecutive duplicate elements.
1258 * For each consecutive set of elements with the same value,
1259 * remove all but the first one. Remaining elements stay in
1260 * list order. Note that this function only erases the
1261 * elements, and that if the elements themselves are pointers,
1262 * the pointed-to memory is not touched in any way. Managing
1263 * the pointer is the user's responsibility.
1269 * @brief Remove consecutive elements satisfying a predicate.
1270 * @param BinaryPredicate Binary predicate function or object.
1272 * For each consecutive set of elements [first,last) that
1273 * satisfy predicate(first,i) where i is an iterator in
1274 * [first,last), remove all but the first one. Remaining
1275 * elements stay in list order. Note that this function only
1276 * erases the elements, and that if the elements themselves are
1277 * pointers, the pointed-to memory is not touched in any way.
1278 * Managing the pointer is the user's responsibility.
1280 template<typename _BinaryPredicate
>
1282 unique(_BinaryPredicate
);
1285 * @brief Merge sorted lists.
1286 * @param x Sorted list to merge.
1288 * Assumes that both @a x and this list are sorted according to
1289 * operator<(). Merges elements of @a x into this list in
1290 * sorted order, leaving @a x empty when complete. Elements in
1291 * this list precede elements in @a x that are equal.
1294 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1301 * @brief Merge sorted lists according to comparison function.
1302 * @param x Sorted list to merge.
1303 * @param StrictWeakOrdering Comparison function defining
1306 * Assumes that both @a x and this list are sorted according to
1307 * StrictWeakOrdering. Merges elements of @a x into this list
1308 * in sorted order, leaving @a x empty when complete. Elements
1309 * in this list precede elements in @a x that are equivalent
1310 * according to StrictWeakOrdering().
1312 template<typename _StrictWeakOrdering
>
1314 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1315 merge(list
&&, _StrictWeakOrdering
);
1317 merge(list
&, _StrictWeakOrdering
);
1321 * @brief Reverse the elements in list.
1323 * Reverse the order of elements in the list in linear time.
1327 { this->_M_impl
._M_node
.reverse(); }
1330 * @brief Sort the elements.
1332 * Sorts the elements of this list in NlogN time. Equivalent
1333 * elements remain in list order.
1339 * @brief Sort the elements according to comparison function.
1341 * Sorts the elements of this list in NlogN time. Equivalent
1342 * elements remain in list order.
1344 template<typename _StrictWeakOrdering
>
1346 sort(_StrictWeakOrdering
);
1349 // Internal constructor functions follow.
1351 // Called by the range constructor to implement [23.1.1]/9
1353 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1354 // 438. Ambiguity in the "do the right thing" clause
1355 template<typename _Integer
>
1357 _M_initialize_dispatch(_Integer __n
, _Integer __x
, __true_type
)
1358 { _M_fill_initialize(static_cast<size_type
>(__n
), __x
); }
1360 // Called by the range constructor to implement [23.1.1]/9
1361 template<typename _InputIterator
>
1363 _M_initialize_dispatch(_InputIterator __first
, _InputIterator __last
,
1366 for (; __first
!= __last
; ++__first
)
1367 push_back(*__first
);
1370 // Called by list(n,v,a), and the range constructor when it turns out
1371 // to be the same thing.
1373 _M_fill_initialize(size_type __n
, const value_type
& __x
)
1375 for (; __n
> 0; --__n
)
1380 // Internal assign functions follow.
1382 // Called by the range assign to implement [23.1.1]/9
1384 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1385 // 438. Ambiguity in the "do the right thing" clause
1386 template<typename _Integer
>
1388 _M_assign_dispatch(_Integer __n
, _Integer __val
, __true_type
)
1389 { _M_fill_assign(__n
, __val
); }
1391 // Called by the range assign to implement [23.1.1]/9
1392 template<typename _InputIterator
>
1394 _M_assign_dispatch(_InputIterator __first
, _InputIterator __last
,
1397 // Called by assign(n,t), and the range assign when it turns out
1398 // to be the same thing.
1400 _M_fill_assign(size_type __n
, const value_type
& __val
);
1403 // Moves the elements from [first,last) before position.
1405 _M_transfer(iterator __position
, iterator __first
, iterator __last
)
1406 { __position
._M_node
->transfer(__first
._M_node
, __last
._M_node
); }
1408 // Inserts new element at position given and with value given.
1409 #ifndef __GXX_EXPERIMENTAL_CXX0X__
1411 _M_insert(iterator __position
, const value_type
& __x
)
1413 _Node
* __tmp
= _M_create_node(__x
);
1414 __tmp
->hook(__position
._M_node
);
1417 template<typename
... _Args
>
1419 _M_insert(iterator __position
, _Args
&&... __args
)
1421 _Node
* __tmp
= _M_create_node(std::forward
<_Args
>(__args
)...);
1422 __tmp
->hook(__position
._M_node
);
1426 // Erases element at position given.
1428 _M_erase(iterator __position
)
1430 __position
._M_node
->unhook();
1431 _Node
* __n
= static_cast<_Node
*>(__position
._M_node
);
1432 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1433 _M_get_Node_allocator().destroy(__n
);
1435 _M_get_Tp_allocator().destroy(&__n
->_M_data
);
1440 // To implement the splice (and merge) bits of N1599.
1442 _M_check_equal_allocators(list
& __x
)
1444 if (std::__alloc_neq
<typename
_Base::_Node_alloc_type
>::
1445 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator()))
1446 __throw_runtime_error(__N("list::_M_check_equal_allocators"));
1451 * @brief List equality comparison.
1453 * @param y A %list of the same type as @a x.
1454 * @return True iff the size and elements of the lists are equal.
1456 * This is an equivalence relation. It is linear in the size of
1457 * the lists. Lists are considered equivalent if their sizes are
1458 * equal, and if corresponding elements compare equal.
1460 template<typename _Tp
, typename _Alloc
>
1462 operator==(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1464 typedef typename list
<_Tp
, _Alloc
>::const_iterator const_iterator
;
1465 const_iterator __end1
= __x
.end();
1466 const_iterator __end2
= __y
.end();
1468 const_iterator __i1
= __x
.begin();
1469 const_iterator __i2
= __y
.begin();
1470 while (__i1
!= __end1
&& __i2
!= __end2
&& *__i1
== *__i2
)
1475 return __i1
== __end1
&& __i2
== __end2
;
1479 * @brief List ordering relation.
1481 * @param y A %list of the same type as @a x.
1482 * @return True iff @a x is lexicographically less than @a y.
1484 * This is a total ordering relation. It is linear in the size of the
1485 * lists. The elements must be comparable with @c <.
1487 * See std::lexicographical_compare() for how the determination is made.
1489 template<typename _Tp
, typename _Alloc
>
1491 operator<(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1492 { return std::lexicographical_compare(__x
.begin(), __x
.end(),
1493 __y
.begin(), __y
.end()); }
1495 /// Based on operator==
1496 template<typename _Tp
, typename _Alloc
>
1498 operator!=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1499 { return !(__x
== __y
); }
1501 /// Based on operator<
1502 template<typename _Tp
, typename _Alloc
>
1504 operator>(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1505 { return __y
< __x
; }
1507 /// Based on operator<
1508 template<typename _Tp
, typename _Alloc
>
1510 operator<=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1511 { return !(__y
< __x
); }
1513 /// Based on operator<
1514 template<typename _Tp
, typename _Alloc
>
1516 operator>=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1517 { return !(__x
< __y
); }
1519 /// See std::list::swap().
1520 template<typename _Tp
, typename _Alloc
>
1522 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>& __y
)
1525 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1526 template<typename _Tp
, typename _Alloc
>
1528 swap(list
<_Tp
, _Alloc
>&& __x
, list
<_Tp
, _Alloc
>& __y
)
1531 template<typename _Tp
, typename _Alloc
>
1533 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>&& __y
)
1537 _GLIBCXX_END_NESTED_NAMESPACE
1539 #endif /* _STL_LIST_H */