1 // List implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
4 // 2011, 2012 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.
52 /** @file bits/stl_list.h
53 * This is an internal header file, included by other library headers.
54 * Do not attempt to use it directly. @headername{list}
60 #include <bits/concept_check.h>
61 #ifdef __GXX_EXPERIMENTAL_CXX0X__
62 #include <initializer_list>
65 namespace std
_GLIBCXX_VISIBILITY(default)
69 _GLIBCXX_BEGIN_NAMESPACE_VERSION
71 // Supporting structures are split into common and templated
72 // types; the latter publicly inherits from the former in an
73 // effort to reduce code duplication. This results in some
74 // "needless" static_cast'ing later on, but it's all safe
77 /// Common part of a node in the %list.
78 struct _List_node_base
80 _List_node_base
* _M_next
;
81 _List_node_base
* _M_prev
;
84 swap(_List_node_base
& __x
, _List_node_base
& __y
) _GLIBCXX_USE_NOEXCEPT
;
87 _M_transfer(_List_node_base
* const __first
,
88 _List_node_base
* const __last
) _GLIBCXX_USE_NOEXCEPT
;
91 _M_reverse() _GLIBCXX_USE_NOEXCEPT
;
94 _M_hook(_List_node_base
* const __position
) _GLIBCXX_USE_NOEXCEPT
;
97 _M_unhook() _GLIBCXX_USE_NOEXCEPT
;
100 _GLIBCXX_END_NAMESPACE_VERSION
101 } // namespace detail
103 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
105 /// An actual node in the %list.
106 template<typename _Tp
>
107 struct _List_node
: public __detail::_List_node_base
112 #ifdef __GXX_EXPERIMENTAL_CXX0X__
113 template<typename
... _Args
>
114 _List_node(_Args
&&... __args
)
115 : __detail::_List_node_base(), _M_data(std::forward
<_Args
>(__args
)...)
121 * @brief A list::iterator.
123 * All the functions are op overloads.
125 template<typename _Tp
>
126 struct _List_iterator
128 typedef _List_iterator
<_Tp
> _Self
;
129 typedef _List_node
<_Tp
> _Node
;
131 typedef ptrdiff_t difference_type
;
132 typedef std::bidirectional_iterator_tag iterator_category
;
133 typedef _Tp value_type
;
134 typedef _Tp
* pointer
;
135 typedef _Tp
& reference
;
141 _List_iterator(__detail::_List_node_base
* __x
)
144 // Must downcast from _List_node_base to _List_node to get to _M_data.
147 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
151 { return std::__addressof(static_cast<_Node
*>(_M_node
)->_M_data
); }
156 _M_node
= _M_node
->_M_next
;
164 _M_node
= _M_node
->_M_next
;
171 _M_node
= _M_node
->_M_prev
;
179 _M_node
= _M_node
->_M_prev
;
184 operator==(const _Self
& __x
) const
185 { return _M_node
== __x
._M_node
; }
188 operator!=(const _Self
& __x
) const
189 { return _M_node
!= __x
._M_node
; }
191 // The only member points to the %list element.
192 __detail::_List_node_base
* _M_node
;
196 * @brief A list::const_iterator.
198 * All the functions are op overloads.
200 template<typename _Tp
>
201 struct _List_const_iterator
203 typedef _List_const_iterator
<_Tp
> _Self
;
204 typedef const _List_node
<_Tp
> _Node
;
205 typedef _List_iterator
<_Tp
> iterator
;
207 typedef ptrdiff_t difference_type
;
208 typedef std::bidirectional_iterator_tag iterator_category
;
209 typedef _Tp value_type
;
210 typedef const _Tp
* pointer
;
211 typedef const _Tp
& reference
;
213 _List_const_iterator()
217 _List_const_iterator(const __detail::_List_node_base
* __x
)
220 _List_const_iterator(const iterator
& __x
)
221 : _M_node(__x
._M_node
) { }
223 // Must downcast from List_node_base to _List_node to get to
227 { return static_cast<_Node
*>(_M_node
)->_M_data
; }
231 { return std::__addressof(static_cast<_Node
*>(_M_node
)->_M_data
); }
236 _M_node
= _M_node
->_M_next
;
244 _M_node
= _M_node
->_M_next
;
251 _M_node
= _M_node
->_M_prev
;
259 _M_node
= _M_node
->_M_prev
;
264 operator==(const _Self
& __x
) const
265 { return _M_node
== __x
._M_node
; }
268 operator!=(const _Self
& __x
) const
269 { return _M_node
!= __x
._M_node
; }
271 // The only member points to the %list element.
272 const __detail::_List_node_base
* _M_node
;
275 template<typename _Val
>
277 operator==(const _List_iterator
<_Val
>& __x
,
278 const _List_const_iterator
<_Val
>& __y
)
279 { return __x
._M_node
== __y
._M_node
; }
281 template<typename _Val
>
283 operator!=(const _List_iterator
<_Val
>& __x
,
284 const _List_const_iterator
<_Val
>& __y
)
285 { return __x
._M_node
!= __y
._M_node
; }
288 /// See bits/stl_deque.h's _Deque_base for an explanation.
289 template<typename _Tp
, typename _Alloc
>
294 // The stored instance is not actually of "allocator_type"'s
295 // type. Instead we rebind the type to
296 // Allocator<List_node<Tp>>, which according to [20.1.5]/4
297 // should probably be the same. List_node<Tp> is not the same
298 // size as Tp (it's two pointers larger), and specializations on
299 // Tp may go unused because List_node<Tp> is being bound
302 // We put this to the test in the constructors and in
303 // get_allocator, where we use conversions between
304 // allocator_type and _Node_alloc_type. The conversion is
305 // required by table 32 in [20.1.5].
306 typedef typename
_Alloc::template rebind
<_List_node
<_Tp
> >::other
309 typedef typename
_Alloc::template rebind
<_Tp
>::other _Tp_alloc_type
;
312 : public _Node_alloc_type
314 __detail::_List_node_base _M_node
;
317 : _Node_alloc_type(), _M_node()
320 _List_impl(const _Node_alloc_type
& __a
)
321 : _Node_alloc_type(__a
), _M_node()
324 #ifdef __GXX_EXPERIMENTAL_CXX0X__
325 _List_impl(_Node_alloc_type
&& __a
)
326 : _Node_alloc_type(std::move(__a
)), _M_node()
335 { return _M_impl
._Node_alloc_type::allocate(1); }
338 _M_put_node(_List_node
<_Tp
>* __p
)
339 { _M_impl
._Node_alloc_type::deallocate(__p
, 1); }
342 typedef _Alloc allocator_type
;
345 _M_get_Node_allocator() _GLIBCXX_NOEXCEPT
346 { return *static_cast<_Node_alloc_type
*>(&_M_impl
); }
348 const _Node_alloc_type
&
349 _M_get_Node_allocator() const _GLIBCXX_NOEXCEPT
350 { return *static_cast<const _Node_alloc_type
*>(&_M_impl
); }
353 _M_get_Tp_allocator() const _GLIBCXX_NOEXCEPT
354 { return _Tp_alloc_type(_M_get_Node_allocator()); }
357 get_allocator() const _GLIBCXX_NOEXCEPT
358 { return allocator_type(_M_get_Node_allocator()); }
364 _List_base(const _Node_alloc_type
& __a
)
368 #ifdef __GXX_EXPERIMENTAL_CXX0X__
369 _List_base(_List_base
&& __x
)
370 : _M_impl(std::move(__x
._M_get_Node_allocator()))
373 __detail::_List_node_base::swap(_M_impl
._M_node
, __x
._M_impl
._M_node
);
377 // This is what actually destroys the list.
378 ~_List_base() _GLIBCXX_NOEXCEPT
387 this->_M_impl
._M_node
._M_next
= &this->_M_impl
._M_node
;
388 this->_M_impl
._M_node
._M_prev
= &this->_M_impl
._M_node
;
393 * @brief A standard container with linear time access to elements,
394 * and fixed time insertion/deletion at any point in the sequence.
398 * @tparam _Tp Type of element.
399 * @tparam _Alloc Allocator type, defaults to allocator<_Tp>.
401 * Meets the requirements of a <a href="tables.html#65">container</a>, a
402 * <a href="tables.html#66">reversible container</a>, and a
403 * <a href="tables.html#67">sequence</a>, including the
404 * <a href="tables.html#68">optional sequence requirements</a> with the
405 * %exception of @c at and @c operator[].
407 * This is a @e doubly @e linked %list. Traversal up and down the
408 * %list requires linear time, but adding and removing elements (or
409 * @e nodes) is done in constant time, regardless of where the
410 * change takes place. Unlike std::vector and std::deque,
411 * random-access iterators are not provided, so subscripting ( @c
412 * [] ) access is not allowed. For algorithms which only need
413 * sequential access, this lack makes no difference.
415 * Also unlike the other standard containers, std::list provides
416 * specialized algorithms %unique to linked lists, such as
417 * splicing, sorting, and in-place reversal.
419 * A couple points on memory allocation for list<Tp>:
421 * First, we never actually allocate a Tp, we allocate
422 * List_node<Tp>'s and trust [20.1.5]/4 to DTRT. This is to ensure
423 * that after elements from %list<X,Alloc1> are spliced into
424 * %list<X,Alloc2>, destroying the memory of the second %list is a
425 * valid operation, i.e., Alloc1 giveth and Alloc2 taketh away.
427 * Second, a %list conceptually represented as
429 * A <---> B <---> C <---> D
431 * is actually circular; a link exists between A and D. The %list
432 * class holds (as its only data member) a private list::iterator
433 * pointing to @e D, not to @e A! To get to the head of the %list,
434 * we start at the tail and move forward by one. When this member
435 * iterator's next/previous pointers refer to itself, the %list is
438 template<typename _Tp
, typename _Alloc
= std::allocator
<_Tp
> >
439 class list
: protected _List_base
<_Tp
, _Alloc
>
441 // concept requirements
442 typedef typename
_Alloc::value_type _Alloc_value_type
;
443 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
444 __glibcxx_class_requires2(_Tp
, _Alloc_value_type
, _SameTypeConcept
)
446 typedef _List_base
<_Tp
, _Alloc
> _Base
;
447 typedef typename
_Base::_Tp_alloc_type _Tp_alloc_type
;
448 typedef typename
_Base::_Node_alloc_type _Node_alloc_type
;
451 typedef _Tp value_type
;
452 typedef typename
_Tp_alloc_type::pointer pointer
;
453 typedef typename
_Tp_alloc_type::const_pointer const_pointer
;
454 typedef typename
_Tp_alloc_type::reference reference
;
455 typedef typename
_Tp_alloc_type::const_reference const_reference
;
456 typedef _List_iterator
<_Tp
> iterator
;
457 typedef _List_const_iterator
<_Tp
> const_iterator
;
458 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
459 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
460 typedef size_t size_type
;
461 typedef ptrdiff_t difference_type
;
462 typedef _Alloc allocator_type
;
465 // Note that pointers-to-_Node's can be ctor-converted to
467 typedef _List_node
<_Tp
> _Node
;
469 using _Base::_M_impl
;
470 using _Base::_M_put_node
;
471 using _Base::_M_get_node
;
472 using _Base::_M_get_Tp_allocator
;
473 using _Base::_M_get_Node_allocator
;
476 * @param __args An instance of user data.
478 * Allocates space for a new node and constructs a copy of
481 #ifndef __GXX_EXPERIMENTAL_CXX0X__
483 _M_create_node(const value_type
& __x
)
485 _Node
* __p
= this->_M_get_node();
488 _M_get_Tp_allocator().construct
489 (std::__addressof(__p
->_M_data
), __x
);
494 __throw_exception_again
;
499 template<typename
... _Args
>
501 _M_create_node(_Args
&&... __args
)
503 _Node
* __p
= this->_M_get_node();
506 _M_get_Node_allocator().construct(__p
,
507 std::forward
<_Args
>(__args
)...);
512 __throw_exception_again
;
519 // [23.2.2.1] construct/copy/destroy
520 // (assign() and get_allocator() are also listed in this section)
522 * @brief Default constructor creates no elements.
528 * @brief Creates a %list with no elements.
529 * @param __a An allocator object.
532 list(const allocator_type
& __a
)
533 : _Base(_Node_alloc_type(__a
)) { }
535 #ifdef __GXX_EXPERIMENTAL_CXX0X__
537 * @brief Creates a %list with default constructed elements.
538 * @param __n The number of elements to initially create.
540 * This constructor fills the %list with @a __n default
541 * constructed elements.
546 { _M_default_initialize(__n
); }
549 * @brief Creates a %list with copies of an exemplar element.
550 * @param __n The number of elements to initially create.
551 * @param __value An element to copy.
552 * @param __a An allocator object.
554 * This constructor fills the %list with @a __n copies of @a __value.
556 list(size_type __n
, const value_type
& __value
,
557 const allocator_type
& __a
= allocator_type())
558 : _Base(_Node_alloc_type(__a
))
559 { _M_fill_initialize(__n
, __value
); }
562 * @brief Creates a %list with copies of an exemplar element.
563 * @param __n The number of elements to initially create.
564 * @param __value An element to copy.
565 * @param __a An allocator object.
567 * This constructor fills the %list with @a __n copies of @a __value.
570 list(size_type __n
, const value_type
& __value
= value_type(),
571 const allocator_type
& __a
= allocator_type())
572 : _Base(_Node_alloc_type(__a
))
573 { _M_fill_initialize(__n
, __value
); }
577 * @brief %List copy constructor.
578 * @param __x A %list of identical element and allocator types.
580 * The newly-created %list uses a copy of the allocation object used
583 list(const list
& __x
)
584 : _Base(__x
._M_get_Node_allocator())
585 { _M_initialize_dispatch(__x
.begin(), __x
.end(), __false_type()); }
587 #ifdef __GXX_EXPERIMENTAL_CXX0X__
589 * @brief %List move constructor.
590 * @param __x A %list of identical element and allocator types.
592 * The newly-created %list contains the exact contents of @a __x.
593 * The contents of @a __x are a valid, but unspecified %list.
595 list(list
&& __x
) noexcept
596 : _Base(std::move(__x
)) { }
599 * @brief Builds a %list from an initializer_list
600 * @param __l An initializer_list of value_type.
601 * @param __a An allocator object.
603 * Create a %list consisting of copies of the elements in the
604 * initializer_list @a __l. This is linear in __l.size().
606 list(initializer_list
<value_type
> __l
,
607 const allocator_type
& __a
= allocator_type())
608 : _Base(_Node_alloc_type(__a
))
609 { _M_initialize_dispatch(__l
.begin(), __l
.end(), __false_type()); }
613 * @brief Builds a %list from a range.
614 * @param __first An input iterator.
615 * @param __last An input iterator.
616 * @param __a An allocator object.
618 * Create a %list consisting of copies of the elements from
619 * [@a __first,@a __last). This is linear in N (where N is
620 * distance(@a __first,@a __last)).
622 #ifdef __GXX_EXPERIMENTAL_CXX0X__
623 template<typename _InputIterator
,
624 typename
= std::_RequireInputIter
<_InputIterator
>>
625 list(_InputIterator __first
, _InputIterator __last
,
626 const allocator_type
& __a
= allocator_type())
627 : _Base(_Node_alloc_type(__a
))
628 { _M_initialize_dispatch(__first
, __last
, __false_type()); }
630 template<typename _InputIterator
>
631 list(_InputIterator __first
, _InputIterator __last
,
632 const allocator_type
& __a
= allocator_type())
633 : _Base(_Node_alloc_type(__a
))
635 // Check whether it's an integral type. If so, it's not an iterator.
636 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
637 _M_initialize_dispatch(__first
, __last
, _Integral());
642 * No explicit dtor needed as the _Base dtor takes care of
643 * things. The _Base dtor only erases the elements, and note
644 * that if the elements themselves are pointers, the pointed-to
645 * memory is not touched in any way. Managing the pointer is
646 * the user's responsibility.
650 * @brief %List assignment operator.
651 * @param __x A %list of identical element and allocator types.
653 * All the elements of @a __x are copied, but unlike the copy
654 * constructor, the allocator object is not copied.
657 operator=(const list
& __x
);
659 #ifdef __GXX_EXPERIMENTAL_CXX0X__
661 * @brief %List move assignment operator.
662 * @param __x A %list of identical element and allocator types.
664 * The contents of @a __x are moved into this %list (without copying).
665 * @a __x is a valid, but unspecified %list
668 operator=(list
&& __x
)
678 * @brief %List initializer list assignment operator.
679 * @param __l An initializer_list of value_type.
681 * Replace the contents of the %list with copies of the elements
682 * in the initializer_list @a __l. This is linear in l.size().
685 operator=(initializer_list
<value_type
> __l
)
687 this->assign(__l
.begin(), __l
.end());
693 * @brief Assigns a given value to a %list.
694 * @param __n Number of elements to be assigned.
695 * @param __val Value to be assigned.
697 * This function fills a %list with @a __n copies of the given
698 * value. Note that the assignment completely changes the %list
699 * and that the resulting %list's size is the same as the number
700 * of elements assigned. Old data may be lost.
703 assign(size_type __n
, const value_type
& __val
)
704 { _M_fill_assign(__n
, __val
); }
707 * @brief Assigns a range to a %list.
708 * @param __first An input iterator.
709 * @param __last An input iterator.
711 * This function fills a %list with copies of the elements in the
712 * range [@a __first,@a __last).
714 * Note that the assignment completely changes the %list and
715 * that the resulting %list's size is the same as the number of
716 * elements assigned. Old data may be lost.
718 #ifdef __GXX_EXPERIMENTAL_CXX0X__
719 template<typename _InputIterator
,
720 typename
= std::_RequireInputIter
<_InputIterator
>>
722 assign(_InputIterator __first
, _InputIterator __last
)
723 { _M_assign_dispatch(__first
, __last
, __false_type()); }
725 template<typename _InputIterator
>
727 assign(_InputIterator __first
, _InputIterator __last
)
729 // Check whether it's an integral type. If so, it's not an iterator.
730 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
731 _M_assign_dispatch(__first
, __last
, _Integral());
735 #ifdef __GXX_EXPERIMENTAL_CXX0X__
737 * @brief Assigns an initializer_list to a %list.
738 * @param __l An initializer_list of value_type.
740 * Replace the contents of the %list with copies of the elements
741 * in the initializer_list @a __l. This is linear in __l.size().
744 assign(initializer_list
<value_type
> __l
)
745 { this->assign(__l
.begin(), __l
.end()); }
748 /// Get a copy of the memory allocation object.
750 get_allocator() const _GLIBCXX_NOEXCEPT
751 { return _Base::get_allocator(); }
755 * Returns a read/write iterator that points to the first element in the
756 * %list. Iteration is done in ordinary element order.
759 begin() _GLIBCXX_NOEXCEPT
760 { return iterator(this->_M_impl
._M_node
._M_next
); }
763 * Returns a read-only (constant) iterator that points to the
764 * first element in the %list. Iteration is done in ordinary
768 begin() const _GLIBCXX_NOEXCEPT
769 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
772 * Returns a read/write iterator that points one past the last
773 * element in the %list. Iteration is done in ordinary element
777 end() _GLIBCXX_NOEXCEPT
778 { return iterator(&this->_M_impl
._M_node
); }
781 * Returns a read-only (constant) iterator that points one past
782 * the last element in the %list. Iteration is done in ordinary
786 end() const _GLIBCXX_NOEXCEPT
787 { return const_iterator(&this->_M_impl
._M_node
); }
790 * Returns a read/write reverse iterator that points to the last
791 * element in the %list. Iteration is done in reverse element
795 rbegin() _GLIBCXX_NOEXCEPT
796 { return reverse_iterator(end()); }
799 * Returns a read-only (constant) reverse iterator that points to
800 * the last element in the %list. Iteration is done in reverse
803 const_reverse_iterator
804 rbegin() const _GLIBCXX_NOEXCEPT
805 { return const_reverse_iterator(end()); }
808 * Returns a read/write reverse iterator that points to one
809 * before the first element in the %list. Iteration is done in
810 * reverse element order.
813 rend() _GLIBCXX_NOEXCEPT
814 { return reverse_iterator(begin()); }
817 * Returns a read-only (constant) reverse iterator that points to one
818 * before the first element in the %list. Iteration is done in reverse
821 const_reverse_iterator
822 rend() const _GLIBCXX_NOEXCEPT
823 { return const_reverse_iterator(begin()); }
825 #ifdef __GXX_EXPERIMENTAL_CXX0X__
827 * Returns a read-only (constant) iterator that points to the
828 * first element in the %list. Iteration is done in ordinary
832 cbegin() const noexcept
833 { return const_iterator(this->_M_impl
._M_node
._M_next
); }
836 * Returns a read-only (constant) iterator that points one past
837 * the last element in the %list. Iteration is done in ordinary
841 cend() const noexcept
842 { return const_iterator(&this->_M_impl
._M_node
); }
845 * Returns a read-only (constant) reverse iterator that points to
846 * the last element in the %list. Iteration is done in reverse
849 const_reverse_iterator
850 crbegin() const noexcept
851 { return const_reverse_iterator(end()); }
854 * Returns a read-only (constant) reverse iterator that points to one
855 * before the first element in the %list. Iteration is done in reverse
858 const_reverse_iterator
859 crend() const noexcept
860 { return const_reverse_iterator(begin()); }
863 // [23.2.2.2] capacity
865 * Returns true if the %list is empty. (Thus begin() would equal
869 empty() const _GLIBCXX_NOEXCEPT
870 { return this->_M_impl
._M_node
._M_next
== &this->_M_impl
._M_node
; }
872 /** Returns the number of elements in the %list. */
874 size() const _GLIBCXX_NOEXCEPT
875 { return std::distance(begin(), end()); }
877 /** Returns the size() of the largest possible %list. */
879 max_size() const _GLIBCXX_NOEXCEPT
880 { return _M_get_Node_allocator().max_size(); }
882 #ifdef __GXX_EXPERIMENTAL_CXX0X__
884 * @brief Resizes the %list to the specified number of elements.
885 * @param __new_size Number of elements the %list should contain.
887 * This function will %resize the %list to the specified number
888 * of elements. If the number is smaller than the %list's
889 * current size the %list is truncated, otherwise default
890 * constructed elements are appended.
893 resize(size_type __new_size
);
896 * @brief Resizes the %list to the specified number of elements.
897 * @param __new_size Number of elements the %list should contain.
898 * @param __x Data with which new elements should be populated.
900 * This function will %resize the %list to the specified number
901 * of elements. If the number is smaller than the %list's
902 * current size the %list is truncated, otherwise the %list is
903 * extended and new elements are populated with given data.
906 resize(size_type __new_size
, const value_type
& __x
);
909 * @brief Resizes the %list to the specified number of elements.
910 * @param __new_size Number of elements the %list should contain.
911 * @param __x Data with which new elements should be populated.
913 * This function will %resize the %list to the specified number
914 * of elements. If the number is smaller than the %list's
915 * current size the %list is truncated, otherwise the %list is
916 * extended and new elements are populated with given data.
919 resize(size_type __new_size
, value_type __x
= value_type());
924 * Returns a read/write reference to the data at the first
925 * element of the %list.
932 * Returns a read-only (constant) reference to the data at the first
933 * element of the %list.
940 * Returns a read/write reference to the data at the last element
946 iterator __tmp
= end();
952 * Returns a read-only (constant) reference to the data at the last
953 * element of the %list.
958 const_iterator __tmp
= end();
963 // [23.2.2.3] modifiers
965 * @brief Add data to the front of the %list.
966 * @param __x Data to be added.
968 * This is a typical stack operation. The function creates an
969 * element at the front of the %list and assigns the given data
970 * to it. Due to the nature of a %list this operation can be
971 * done in constant time, and does not invalidate iterators and
975 push_front(const value_type
& __x
)
976 { this->_M_insert(begin(), __x
); }
978 #ifdef __GXX_EXPERIMENTAL_CXX0X__
980 push_front(value_type
&& __x
)
981 { this->_M_insert(begin(), std::move(__x
)); }
983 template<typename
... _Args
>
985 emplace_front(_Args
&&... __args
)
986 { this->_M_insert(begin(), std::forward
<_Args
>(__args
)...); }
990 * @brief Removes first element.
992 * This is a typical stack operation. It shrinks the %list by
993 * one. Due to the nature of a %list this operation can be done
994 * in constant time, and only invalidates iterators/references to
995 * the element being removed.
997 * Note that no data is returned, and if the first element's data
998 * is needed, it should be retrieved before pop_front() is
1003 { this->_M_erase(begin()); }
1006 * @brief Add data to the end of the %list.
1007 * @param __x Data to be added.
1009 * This is a typical stack operation. The function creates an
1010 * element at the end of the %list and assigns the given data to
1011 * it. Due to the nature of a %list this operation can be done
1012 * in constant time, and does not invalidate iterators and
1016 push_back(const value_type
& __x
)
1017 { this->_M_insert(end(), __x
); }
1019 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1021 push_back(value_type
&& __x
)
1022 { this->_M_insert(end(), std::move(__x
)); }
1024 template<typename
... _Args
>
1026 emplace_back(_Args
&&... __args
)
1027 { this->_M_insert(end(), std::forward
<_Args
>(__args
)...); }
1031 * @brief Removes last element.
1033 * This is a typical stack operation. It shrinks the %list by
1034 * one. Due to the nature of a %list this operation can be done
1035 * in constant time, and only invalidates iterators/references to
1036 * the element being removed.
1038 * Note that no data is returned, and if the last element's data
1039 * is needed, it should be retrieved before pop_back() is called.
1043 { this->_M_erase(iterator(this->_M_impl
._M_node
._M_prev
)); }
1045 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1047 * @brief Constructs object in %list before specified iterator.
1048 * @param __position A const_iterator into the %list.
1049 * @param __args Arguments.
1050 * @return An iterator that points to the inserted data.
1052 * This function will insert an object of type T constructed
1053 * with T(std::forward<Args>(args)...) before the specified
1054 * location. Due to the nature of a %list this operation can
1055 * be done in constant time, and does not invalidate iterators
1058 template<typename
... _Args
>
1060 emplace(iterator __position
, _Args
&&... __args
);
1064 * @brief Inserts given value into %list before specified iterator.
1065 * @param __position An iterator into the %list.
1066 * @param __x Data to be inserted.
1067 * @return An iterator that points to the inserted data.
1069 * This function will insert a copy of the given value before
1070 * the specified location. Due to the nature of a %list this
1071 * operation can be done in constant time, and does not
1072 * invalidate iterators and references.
1075 insert(iterator __position
, const value_type
& __x
);
1077 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1079 * @brief Inserts given rvalue into %list before specified iterator.
1080 * @param __position An iterator into the %list.
1081 * @param __x Data to be inserted.
1082 * @return An iterator that points to the inserted data.
1084 * This function will insert a copy of the given rvalue before
1085 * the specified location. Due to the nature of a %list this
1086 * operation can be done in constant time, and does not
1087 * invalidate iterators and references.
1090 insert(iterator __position
, value_type
&& __x
)
1091 { return emplace(__position
, std::move(__x
)); }
1094 * @brief Inserts the contents of an initializer_list into %list
1095 * before specified iterator.
1096 * @param __p An iterator into the %list.
1097 * @param __l An initializer_list of value_type.
1099 * This function will insert copies of the data in the
1100 * initializer_list @a l into the %list before the location
1101 * specified by @a p.
1103 * This operation is linear in the number of elements inserted and
1104 * does not invalidate iterators and references.
1107 insert(iterator __p
, initializer_list
<value_type
> __l
)
1108 { this->insert(__p
, __l
.begin(), __l
.end()); }
1112 * @brief Inserts a number of copies of given data into the %list.
1113 * @param __position An iterator into the %list.
1114 * @param __n Number of elements to be inserted.
1115 * @param __x Data to be inserted.
1117 * This function will insert a specified number of copies of the
1118 * given data before the location specified by @a position.
1120 * This operation is linear in the number of elements inserted and
1121 * does not invalidate iterators and references.
1124 insert(iterator __position
, size_type __n
, const value_type
& __x
)
1126 list
__tmp(__n
, __x
, get_allocator());
1127 splice(__position
, __tmp
);
1131 * @brief Inserts a range into the %list.
1132 * @param __position An iterator into the %list.
1133 * @param __first An input iterator.
1134 * @param __last An input iterator.
1136 * This function will insert copies of the data in the range [@a
1137 * first,@a last) into the %list before the location specified by
1140 * This operation is linear in the number of elements inserted and
1141 * does not invalidate iterators and references.
1143 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1144 template<typename _InputIterator
,
1145 typename
= std::_RequireInputIter
<_InputIterator
>>
1147 template<typename _InputIterator
>
1150 insert(iterator __position
, _InputIterator __first
,
1151 _InputIterator __last
)
1153 list
__tmp(__first
, __last
, get_allocator());
1154 splice(__position
, __tmp
);
1158 * @brief Remove element at given position.
1159 * @param __position Iterator pointing to element to be erased.
1160 * @return An iterator pointing to the next element (or end()).
1162 * This function will erase the element at the given position and thus
1163 * shorten the %list by one.
1165 * Due to the nature of a %list this operation can be done in
1166 * constant time, and only invalidates iterators/references to
1167 * the element being removed. The user is also cautioned that
1168 * this function only erases the element, and that if the element
1169 * is itself a pointer, the pointed-to memory is not touched in
1170 * any way. Managing the pointer is the user's responsibility.
1173 erase(iterator __position
);
1176 * @brief Remove a range of elements.
1177 * @param __first Iterator pointing to the first element to be erased.
1178 * @param __last Iterator pointing to one past the last element to be
1180 * @return An iterator pointing to the element pointed to by @a last
1181 * prior to erasing (or end()).
1183 * This function will erase the elements in the range @a
1184 * [first,last) and shorten the %list accordingly.
1186 * This operation is linear time in the size of the range and only
1187 * invalidates iterators/references to the element being removed.
1188 * The user is also cautioned that this function only erases the
1189 * elements, and that if the elements themselves are pointers, the
1190 * pointed-to memory is not touched in any way. Managing the pointer
1191 * is the user's responsibility.
1194 erase(iterator __first
, iterator __last
)
1196 while (__first
!= __last
)
1197 __first
= erase(__first
);
1202 * @brief Swaps data with another %list.
1203 * @param __x A %list of the same element and allocator types.
1205 * This exchanges the elements between two lists in constant
1206 * time. Note that the global std::swap() function is
1207 * specialized such that std::swap(l1,l2) will feed to this
1213 __detail::_List_node_base::swap(this->_M_impl
._M_node
,
1214 __x
._M_impl
._M_node
);
1216 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1217 // 431. Swapping containers with unequal allocators.
1218 std::__alloc_swap
<typename
_Base::_Node_alloc_type
>::
1219 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator());
1223 * Erases all the elements. Note that this function only erases
1224 * the elements, and that if the elements themselves are
1225 * pointers, the pointed-to memory is not touched in any way.
1226 * Managing the pointer is the user's responsibility.
1229 clear() _GLIBCXX_NOEXCEPT
1235 // [23.2.2.4] list operations
1237 * @brief Insert contents of another %list.
1238 * @param __position Iterator referencing the element to insert before.
1239 * @param __x Source list.
1241 * The elements of @a __x are inserted in constant time in front of
1242 * the element referenced by @a __position. @a __x becomes an empty
1245 * Requires this != @a __x.
1248 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1249 splice(iterator __position
, list
&& __x
)
1251 splice(iterator __position
, list
& __x
)
1256 _M_check_equal_allocators(__x
);
1258 this->_M_transfer(__position
, __x
.begin(), __x
.end());
1262 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1264 splice(iterator __position
, list
& __x
)
1265 { splice(__position
, std::move(__x
)); }
1269 * @brief Insert element from another %list.
1270 * @param __position Iterator referencing the element to insert before.
1271 * @param __x Source list.
1272 * @param __i Iterator referencing the element to move.
1274 * Removes the element in list @a __x referenced by @a __i and
1275 * inserts it into the current list before @a __position.
1278 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1279 splice(iterator __position
, list
&& __x
, iterator __i
)
1281 splice(iterator __position
, list
& __x
, iterator __i
)
1286 if (__position
== __i
|| __position
== __j
)
1290 _M_check_equal_allocators(__x
);
1292 this->_M_transfer(__position
, __i
, __j
);
1295 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1297 splice(iterator __position
, list
& __x
, iterator __i
)
1298 { splice(__position
, std::move(__x
), __i
); }
1302 * @brief Insert range from another %list.
1303 * @param __position Iterator referencing the element to insert before.
1304 * @param __x Source list.
1305 * @param __first Iterator referencing the start of range in x.
1306 * @param __last Iterator referencing the end of range in x.
1308 * Removes elements in the range [__first,__last) and inserts them
1309 * before @a __position in constant time.
1311 * Undefined if @a __position is in [__first,__last).
1314 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1315 splice(iterator __position
, list
&& __x
, iterator __first
,
1318 splice(iterator __position
, list
& __x
, iterator __first
,
1322 if (__first
!= __last
)
1325 _M_check_equal_allocators(__x
);
1327 this->_M_transfer(__position
, __first
, __last
);
1331 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1333 splice(iterator __position
, list
& __x
, iterator __first
, iterator __last
)
1334 { splice(__position
, std::move(__x
), __first
, __last
); }
1338 * @brief Remove all elements equal to value.
1339 * @param __value The value to remove.
1341 * Removes every element in the list equal to @a value.
1342 * Remaining elements stay in list order. Note that this
1343 * function only erases the elements, and that if the elements
1344 * themselves are pointers, the pointed-to memory is not
1345 * touched in any way. Managing the pointer is the user's
1349 remove(const _Tp
& __value
);
1352 * @brief Remove all elements satisfying a predicate.
1353 * @tparam _Predicate Unary predicate function or object.
1355 * Removes every element in the list for which the predicate
1356 * returns true. Remaining elements stay in list order. Note
1357 * that this function only erases the elements, and that if the
1358 * elements themselves are pointers, the pointed-to memory is
1359 * not touched in any way. Managing the pointer is the user's
1362 template<typename _Predicate
>
1364 remove_if(_Predicate
);
1367 * @brief Remove consecutive duplicate elements.
1369 * For each consecutive set of elements with the same value,
1370 * remove all but the first one. Remaining elements stay in
1371 * list order. Note that this function only erases the
1372 * elements, and that if the elements themselves are pointers,
1373 * the pointed-to memory is not touched in any way. Managing
1374 * the pointer is the user's responsibility.
1380 * @brief Remove consecutive elements satisfying a predicate.
1381 * @tparam _BinaryPredicate Binary predicate function or object.
1383 * For each consecutive set of elements [first,last) that
1384 * satisfy predicate(first,i) where i is an iterator in
1385 * [first,last), remove all but the first one. Remaining
1386 * elements stay in list order. Note that this function only
1387 * erases the elements, and that if the elements themselves are
1388 * pointers, the pointed-to memory is not touched in any way.
1389 * Managing the pointer is the user's responsibility.
1391 template<typename _BinaryPredicate
>
1393 unique(_BinaryPredicate
);
1396 * @brief Merge sorted lists.
1397 * @param __x Sorted list to merge.
1399 * Assumes that both @a __x and this list are sorted according to
1400 * operator<(). Merges elements of @a __x into this list in
1401 * sorted order, leaving @a __x empty when complete. Elements in
1402 * this list precede elements in @a __x that are equal.
1404 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1410 { merge(std::move(__x
)); }
1417 * @brief Merge sorted lists according to comparison function.
1418 * @tparam _StrictWeakOrdering Comparison function defining
1420 * @param __x Sorted list to merge.
1421 * @param __comp Comparison functor.
1423 * Assumes that both @a __x and this list are sorted according to
1424 * StrictWeakOrdering. Merges elements of @a __x into this list
1425 * in sorted order, leaving @a __x empty when complete. Elements
1426 * in this list precede elements in @a __x that are equivalent
1427 * according to StrictWeakOrdering().
1429 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1430 template<typename _StrictWeakOrdering
>
1432 merge(list
&& __x
, _StrictWeakOrdering __comp
);
1434 template<typename _StrictWeakOrdering
>
1436 merge(list
& __x
, _StrictWeakOrdering __comp
)
1437 { merge(std::move(__x
), __comp
); }
1439 template<typename _StrictWeakOrdering
>
1441 merge(list
& __x
, _StrictWeakOrdering __comp
);
1445 * @brief Reverse the elements in list.
1447 * Reverse the order of elements in the list in linear time.
1450 reverse() _GLIBCXX_NOEXCEPT
1451 { this->_M_impl
._M_node
._M_reverse(); }
1454 * @brief Sort the elements.
1456 * Sorts the elements of this list in NlogN time. Equivalent
1457 * elements remain in list order.
1463 * @brief Sort the elements according to comparison function.
1465 * Sorts the elements of this list in NlogN time. Equivalent
1466 * elements remain in list order.
1468 template<typename _StrictWeakOrdering
>
1470 sort(_StrictWeakOrdering
);
1473 // Internal constructor functions follow.
1475 // Called by the range constructor to implement [23.1.1]/9
1477 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1478 // 438. Ambiguity in the "do the right thing" clause
1479 template<typename _Integer
>
1481 _M_initialize_dispatch(_Integer __n
, _Integer __x
, __true_type
)
1482 { _M_fill_initialize(static_cast<size_type
>(__n
), __x
); }
1484 // Called by the range constructor to implement [23.1.1]/9
1485 template<typename _InputIterator
>
1487 _M_initialize_dispatch(_InputIterator __first
, _InputIterator __last
,
1490 for (; __first
!= __last
; ++__first
)
1491 push_back(*__first
);
1494 // Called by list(n,v,a), and the range constructor when it turns out
1495 // to be the same thing.
1497 _M_fill_initialize(size_type __n
, const value_type
& __x
)
1503 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1504 // Called by list(n).
1506 _M_default_initialize(size_type __n
)
1512 // Called by resize(sz).
1514 _M_default_append(size_type __n
);
1517 // Internal assign functions follow.
1519 // Called by the range assign to implement [23.1.1]/9
1521 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1522 // 438. Ambiguity in the "do the right thing" clause
1523 template<typename _Integer
>
1525 _M_assign_dispatch(_Integer __n
, _Integer __val
, __true_type
)
1526 { _M_fill_assign(__n
, __val
); }
1528 // Called by the range assign to implement [23.1.1]/9
1529 template<typename _InputIterator
>
1531 _M_assign_dispatch(_InputIterator __first
, _InputIterator __last
,
1534 // Called by assign(n,t), and the range assign when it turns out
1535 // to be the same thing.
1537 _M_fill_assign(size_type __n
, const value_type
& __val
);
1540 // Moves the elements from [first,last) before position.
1542 _M_transfer(iterator __position
, iterator __first
, iterator __last
)
1543 { __position
._M_node
->_M_transfer(__first
._M_node
, __last
._M_node
); }
1545 // Inserts new element at position given and with value given.
1546 #ifndef __GXX_EXPERIMENTAL_CXX0X__
1548 _M_insert(iterator __position
, const value_type
& __x
)
1550 _Node
* __tmp
= _M_create_node(__x
);
1551 __tmp
->_M_hook(__position
._M_node
);
1554 template<typename
... _Args
>
1556 _M_insert(iterator __position
, _Args
&&... __args
)
1558 _Node
* __tmp
= _M_create_node(std::forward
<_Args
>(__args
)...);
1559 __tmp
->_M_hook(__position
._M_node
);
1563 // Erases element at position given.
1565 _M_erase(iterator __position
)
1567 __position
._M_node
->_M_unhook();
1568 _Node
* __n
= static_cast<_Node
*>(__position
._M_node
);
1569 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1570 _M_get_Node_allocator().destroy(__n
);
1572 _M_get_Tp_allocator().destroy(std::__addressof(__n
->_M_data
));
1577 // To implement the splice (and merge) bits of N1599.
1579 _M_check_equal_allocators(list
& __x
)
1581 if (std::__alloc_neq
<typename
_Base::_Node_alloc_type
>::
1582 _S_do_it(_M_get_Node_allocator(), __x
._M_get_Node_allocator()))
1583 __throw_runtime_error(__N("list::_M_check_equal_allocators"));
1588 * @brief List equality comparison.
1589 * @param __x A %list.
1590 * @param __y A %list of the same type as @a __x.
1591 * @return True iff the size and elements of the lists are equal.
1593 * This is an equivalence relation. It is linear in the size of
1594 * the lists. Lists are considered equivalent if their sizes are
1595 * equal, and if corresponding elements compare equal.
1597 template<typename _Tp
, typename _Alloc
>
1599 operator==(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1601 typedef typename list
<_Tp
, _Alloc
>::const_iterator const_iterator
;
1602 const_iterator __end1
= __x
.end();
1603 const_iterator __end2
= __y
.end();
1605 const_iterator __i1
= __x
.begin();
1606 const_iterator __i2
= __y
.begin();
1607 while (__i1
!= __end1
&& __i2
!= __end2
&& *__i1
== *__i2
)
1612 return __i1
== __end1
&& __i2
== __end2
;
1616 * @brief List ordering relation.
1617 * @param __x A %list.
1618 * @param __y A %list of the same type as @a __x.
1619 * @return True iff @a __x is lexicographically less than @a __y.
1621 * This is a total ordering relation. It is linear in the size of the
1622 * lists. The elements must be comparable with @c <.
1624 * See std::lexicographical_compare() for how the determination is made.
1626 template<typename _Tp
, typename _Alloc
>
1628 operator<(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1629 { return std::lexicographical_compare(__x
.begin(), __x
.end(),
1630 __y
.begin(), __y
.end()); }
1632 /// Based on operator==
1633 template<typename _Tp
, typename _Alloc
>
1635 operator!=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1636 { return !(__x
== __y
); }
1638 /// Based on operator<
1639 template<typename _Tp
, typename _Alloc
>
1641 operator>(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1642 { return __y
< __x
; }
1644 /// Based on operator<
1645 template<typename _Tp
, typename _Alloc
>
1647 operator<=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1648 { return !(__y
< __x
); }
1650 /// Based on operator<
1651 template<typename _Tp
, typename _Alloc
>
1653 operator>=(const list
<_Tp
, _Alloc
>& __x
, const list
<_Tp
, _Alloc
>& __y
)
1654 { return !(__x
< __y
); }
1656 /// See std::list::swap().
1657 template<typename _Tp
, typename _Alloc
>
1659 swap(list
<_Tp
, _Alloc
>& __x
, list
<_Tp
, _Alloc
>& __y
)
1662 _GLIBCXX_END_NAMESPACE_CONTAINER
1665 #endif /* _STL_LIST_H */