1 // <forward_list.h> -*- C++ -*-
3 // Copyright (C) 2008-2013 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file bits/forward_list.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{forward_list}
30 #ifndef _FORWARD_LIST_H
31 #define _FORWARD_LIST_H 1
33 #pragma GCC system_header
35 #include <initializer_list>
36 #include <bits/stl_iterator_base_types.h>
37 #include <bits/stl_iterator.h>
38 #include <bits/stl_algobase.h>
39 #include <bits/stl_function.h>
40 #include <bits/allocator.h>
41 #include <ext/alloc_traits.h>
42 #include <ext/aligned_buffer.h>
44 namespace std
_GLIBCXX_VISIBILITY(default)
46 _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
49 * @brief A helper basic node class for %forward_list.
50 * This is just a linked list with nothing inside it.
51 * There are purely list shuffling utility methods here.
53 struct _Fwd_list_node_base
55 _Fwd_list_node_base() = default;
57 _Fwd_list_node_base
* _M_next
= nullptr;
60 _M_transfer_after(_Fwd_list_node_base
* __begin
,
61 _Fwd_list_node_base
* __end
)
63 _Fwd_list_node_base
* __keep
= __begin
->_M_next
;
66 __begin
->_M_next
= __end
->_M_next
;
67 __end
->_M_next
= _M_next
;
76 _M_reverse_after() noexcept
78 _Fwd_list_node_base
* __tail
= _M_next
;
81 while (_Fwd_list_node_base
* __temp
= __tail
->_M_next
)
83 _Fwd_list_node_base
* __keep
= _M_next
;
85 __tail
->_M_next
= __temp
->_M_next
;
86 _M_next
->_M_next
= __keep
;
92 * @brief A helper node class for %forward_list.
93 * This is just a linked list with uninitialized storage for a
94 * data value in each node.
95 * There is a sorting utility method.
97 template<typename _Tp
>
99 : public _Fwd_list_node_base
101 _Fwd_list_node() = default;
103 __gnu_cxx::__aligned_buffer
<_Tp
> _M_storage
;
107 { return _M_storage
._M_ptr(); }
110 _M_valptr() const noexcept
111 { return _M_storage
._M_ptr(); }
115 * @brief A forward_list::iterator.
117 * All the functions are op overloads.
119 template<typename _Tp
>
120 struct _Fwd_list_iterator
122 typedef _Fwd_list_iterator
<_Tp
> _Self
;
123 typedef _Fwd_list_node
<_Tp
> _Node
;
125 typedef _Tp value_type
;
126 typedef _Tp
* pointer
;
127 typedef _Tp
& reference
;
128 typedef ptrdiff_t difference_type
;
129 typedef std::forward_iterator_tag iterator_category
;
135 _Fwd_list_iterator(_Fwd_list_node_base
* __n
)
140 { return *static_cast<_Node
*>(this->_M_node
)->_M_valptr(); }
144 { return static_cast<_Node
*>(this->_M_node
)->_M_valptr(); }
149 _M_node
= _M_node
->_M_next
;
157 _M_node
= _M_node
->_M_next
;
162 operator==(const _Self
& __x
) const
163 { return _M_node
== __x
._M_node
; }
166 operator!=(const _Self
& __x
) const
167 { return _M_node
!= __x
._M_node
; }
173 return _Fwd_list_iterator(_M_node
->_M_next
);
175 return _Fwd_list_iterator(0);
178 _Fwd_list_node_base
* _M_node
;
182 * @brief A forward_list::const_iterator.
184 * All the functions are op overloads.
186 template<typename _Tp
>
187 struct _Fwd_list_const_iterator
189 typedef _Fwd_list_const_iterator
<_Tp
> _Self
;
190 typedef const _Fwd_list_node
<_Tp
> _Node
;
191 typedef _Fwd_list_iterator
<_Tp
> iterator
;
193 typedef _Tp value_type
;
194 typedef const _Tp
* pointer
;
195 typedef const _Tp
& reference
;
196 typedef ptrdiff_t difference_type
;
197 typedef std::forward_iterator_tag iterator_category
;
199 _Fwd_list_const_iterator()
203 _Fwd_list_const_iterator(const _Fwd_list_node_base
* __n
)
206 _Fwd_list_const_iterator(const iterator
& __iter
)
207 : _M_node(__iter
._M_node
) { }
211 { return *static_cast<_Node
*>(this->_M_node
)->_M_valptr(); }
215 { return static_cast<_Node
*>(this->_M_node
)->_M_valptr(); }
220 _M_node
= _M_node
->_M_next
;
228 _M_node
= _M_node
->_M_next
;
233 operator==(const _Self
& __x
) const
234 { return _M_node
== __x
._M_node
; }
237 operator!=(const _Self
& __x
) const
238 { return _M_node
!= __x
._M_node
; }
244 return _Fwd_list_const_iterator(_M_node
->_M_next
);
246 return _Fwd_list_const_iterator(0);
249 const _Fwd_list_node_base
* _M_node
;
253 * @brief Forward list iterator equality comparison.
255 template<typename _Tp
>
257 operator==(const _Fwd_list_iterator
<_Tp
>& __x
,
258 const _Fwd_list_const_iterator
<_Tp
>& __y
)
259 { return __x
._M_node
== __y
._M_node
; }
262 * @brief Forward list iterator inequality comparison.
264 template<typename _Tp
>
266 operator!=(const _Fwd_list_iterator
<_Tp
>& __x
,
267 const _Fwd_list_const_iterator
<_Tp
>& __y
)
268 { return __x
._M_node
!= __y
._M_node
; }
271 * @brief Base class for %forward_list.
273 template<typename _Tp
, typename _Alloc
>
274 struct _Fwd_list_base
277 typedef typename
__gnu_cxx::__alloc_traits
<_Alloc
> _Alloc_traits
;
278 typedef typename
_Alloc_traits::template rebind
<_Tp
>::other
281 typedef typename
_Alloc_traits::template
282 rebind
<_Fwd_list_node
<_Tp
>>::other _Node_alloc_type
;
284 typedef __gnu_cxx::__alloc_traits
<_Node_alloc_type
> _Node_alloc_traits
;
286 struct _Fwd_list_impl
287 : public _Node_alloc_type
289 _Fwd_list_node_base _M_head
;
292 : _Node_alloc_type(), _M_head()
295 _Fwd_list_impl(const _Node_alloc_type
& __a
)
296 : _Node_alloc_type(__a
), _M_head()
299 _Fwd_list_impl(_Node_alloc_type
&& __a
)
300 : _Node_alloc_type(std::move(__a
)), _M_head()
304 _Fwd_list_impl _M_impl
;
307 typedef _Fwd_list_iterator
<_Tp
> iterator
;
308 typedef _Fwd_list_const_iterator
<_Tp
> const_iterator
;
309 typedef _Fwd_list_node
<_Tp
> _Node
;
312 _M_get_Node_allocator() noexcept
313 { return *static_cast<_Node_alloc_type
*>(&this->_M_impl
); }
315 const _Node_alloc_type
&
316 _M_get_Node_allocator() const noexcept
317 { return *static_cast<const _Node_alloc_type
*>(&this->_M_impl
); }
322 _Fwd_list_base(const _Node_alloc_type
& __a
)
325 _Fwd_list_base(_Fwd_list_base
&& __lst
, const _Node_alloc_type
& __a
);
327 _Fwd_list_base(_Fwd_list_base
&& __lst
)
328 : _M_impl(std::move(__lst
._M_get_Node_allocator()))
330 this->_M_impl
._M_head
._M_next
= __lst
._M_impl
._M_head
._M_next
;
331 __lst
._M_impl
._M_head
._M_next
= 0;
335 { _M_erase_after(&_M_impl
._M_head
, 0); }
342 auto __ptr
= _Node_alloc_traits::allocate(_M_get_Node_allocator(), 1);
343 return std::__addressof(*__ptr
);
346 template<typename
... _Args
>
348 _M_create_node(_Args
&&... __args
)
350 _Node
* __node
= this->_M_get_node();
353 _Tp_alloc_type
__a(_M_get_Node_allocator());
354 typedef allocator_traits
<_Tp_alloc_type
> _Alloc_traits
;
355 ::new ((void*)__node
) _Node();
356 _Alloc_traits::construct(__a
, __node
->_M_valptr(),
357 std::forward
<_Args
>(__args
)...);
361 this->_M_put_node(__node
);
362 __throw_exception_again
;
367 template<typename
... _Args
>
369 _M_insert_after(const_iterator __pos
, _Args
&&... __args
);
372 _M_put_node(_Node
* __p
)
374 typedef typename
_Node_alloc_traits::pointer _Ptr
;
375 auto __ptr
= std::pointer_traits
<_Ptr
>::pointer_to(*__p
);
376 _Node_alloc_traits::deallocate(_M_get_Node_allocator(), __ptr
, 1);
380 _M_erase_after(_Fwd_list_node_base
* __pos
);
383 _M_erase_after(_Fwd_list_node_base
* __pos
,
384 _Fwd_list_node_base
* __last
);
388 * @brief A standard container with linear time access to elements,
389 * and fixed time insertion/deletion at any point in the sequence.
393 * @tparam _Tp Type of element.
394 * @tparam _Alloc Allocator type, defaults to allocator<_Tp>.
396 * Meets the requirements of a <a href="tables.html#65">container</a>, a
397 * <a href="tables.html#67">sequence</a>, including the
398 * <a href="tables.html#68">optional sequence requirements</a> with the
399 * %exception of @c at and @c operator[].
401 * This is a @e singly @e linked %list. Traversal up the
402 * %list requires linear time, but adding and removing elements (or
403 * @e nodes) is done in constant time, regardless of where the
404 * change takes place. Unlike std::vector and std::deque,
405 * random-access iterators are not provided, so subscripting ( @c
406 * [] ) access is not allowed. For algorithms which only need
407 * sequential access, this lack makes no difference.
409 * Also unlike the other standard containers, std::forward_list provides
410 * specialized algorithms %unique to linked lists, such as
411 * splicing, sorting, and in-place reversal.
413 template<typename _Tp
, typename _Alloc
= allocator
<_Tp
> >
414 class forward_list
: private _Fwd_list_base
<_Tp
, _Alloc
>
417 typedef _Fwd_list_base
<_Tp
, _Alloc
> _Base
;
418 typedef _Fwd_list_node
<_Tp
> _Node
;
419 typedef _Fwd_list_node_base _Node_base
;
420 typedef typename
_Base::_Tp_alloc_type _Tp_alloc_type
;
421 typedef typename
_Base::_Node_alloc_type _Node_alloc_type
;
422 typedef typename
_Base::_Node_alloc_traits _Node_alloc_traits
;
423 typedef __gnu_cxx::__alloc_traits
<_Tp_alloc_type
> _Alloc_traits
;
427 typedef _Tp value_type
;
428 typedef typename
_Alloc_traits::pointer pointer
;
429 typedef typename
_Alloc_traits::const_pointer const_pointer
;
430 typedef value_type
& reference
;
431 typedef const value_type
& const_reference
;
433 typedef _Fwd_list_iterator
<_Tp
> iterator
;
434 typedef _Fwd_list_const_iterator
<_Tp
> const_iterator
;
435 typedef std::size_t size_type
;
436 typedef std::ptrdiff_t difference_type
;
437 typedef _Alloc allocator_type
;
439 // 23.3.4.2 construct/copy/destroy:
442 * @brief Creates a %forward_list with no elements.
443 * @param __al An allocator object.
446 forward_list(const _Alloc
& __al
= _Alloc())
447 : _Base(_Node_alloc_type(__al
))
451 * @brief Copy constructor with allocator argument.
452 * @param __list Input list to copy.
453 * @param __al An allocator object.
455 forward_list(const forward_list
& __list
, const _Alloc
& __al
)
456 : _Base(_Node_alloc_type(__al
))
457 { _M_range_initialize(__list
.begin(), __list
.end()); }
460 * @brief Move constructor with allocator argument.
461 * @param __list Input list to move.
462 * @param __al An allocator object.
464 forward_list(forward_list
&& __list
, const _Alloc
& __al
)
465 noexcept(_Node_alloc_traits::_S_always_equal())
466 : _Base(std::move(__list
), _Node_alloc_type(__al
))
470 * @brief Creates a %forward_list with default constructed elements.
471 * @param __n The number of elements to initially create.
473 * This constructor creates the %forward_list with @a __n default
474 * constructed elements.
477 forward_list(size_type __n
, const _Alloc
& __al
= _Alloc())
478 : _Base(_Node_alloc_type(__al
))
479 { _M_default_initialize(__n
); }
482 * @brief Creates a %forward_list with copies of an exemplar element.
483 * @param __n The number of elements to initially create.
484 * @param __value An element to copy.
485 * @param __al An allocator object.
487 * This constructor fills the %forward_list with @a __n copies of
490 forward_list(size_type __n
, const _Tp
& __value
,
491 const _Alloc
& __al
= _Alloc())
492 : _Base(_Node_alloc_type(__al
))
493 { _M_fill_initialize(__n
, __value
); }
496 * @brief Builds a %forward_list from a range.
497 * @param __first An input iterator.
498 * @param __last An input iterator.
499 * @param __al An allocator object.
501 * Create a %forward_list consisting of copies of the elements from
502 * [@a __first,@a __last). This is linear in N (where N is
503 * distance(@a __first,@a __last)).
505 template<typename _InputIterator
,
506 typename
= std::_RequireInputIter
<_InputIterator
>>
507 forward_list(_InputIterator __first
, _InputIterator __last
,
508 const _Alloc
& __al
= _Alloc())
509 : _Base(_Node_alloc_type(__al
))
510 { _M_range_initialize(__first
, __last
); }
513 * @brief The %forward_list copy constructor.
514 * @param __list A %forward_list of identical element and allocator
517 forward_list(const forward_list
& __list
)
518 : _Base(_Node_alloc_traits::_S_select_on_copy(
519 __list
._M_get_Node_allocator()))
520 { _M_range_initialize(__list
.begin(), __list
.end()); }
523 * @brief The %forward_list move constructor.
524 * @param __list A %forward_list of identical element and allocator
527 * The newly-created %forward_list contains the exact contents of @a
528 * __list. The contents of @a __list are a valid, but unspecified
531 forward_list(forward_list
&& __list
) noexcept
532 : _Base(std::move(__list
)) { }
535 * @brief Builds a %forward_list from an initializer_list
536 * @param __il An initializer_list of value_type.
537 * @param __al An allocator object.
539 * Create a %forward_list consisting of copies of the elements
540 * in the initializer_list @a __il. This is linear in __il.size().
542 forward_list(std::initializer_list
<_Tp
> __il
,
543 const _Alloc
& __al
= _Alloc())
544 : _Base(_Node_alloc_type(__al
))
545 { _M_range_initialize(__il
.begin(), __il
.end()); }
548 * @brief The forward_list dtor.
550 ~forward_list() noexcept
554 * @brief The %forward_list assignment operator.
555 * @param __list A %forward_list of identical element and allocator
558 * All the elements of @a __list are copied, but unlike the copy
559 * constructor, the allocator object is not copied.
562 operator=(const forward_list
& __list
);
565 * @brief The %forward_list move assignment operator.
566 * @param __list A %forward_list of identical element and allocator
569 * The contents of @a __list are moved into this %forward_list
570 * (without copying, if the allocators permit it).
571 * @a __list is a valid, but unspecified %forward_list
574 operator=(forward_list
&& __list
)
575 noexcept(_Node_alloc_traits::_S_nothrow_move())
577 constexpr bool __move_storage
=
578 _Node_alloc_traits::_S_propagate_on_move_assign()
579 || _Node_alloc_traits::_S_always_equal();
580 _M_move_assign(std::move(__list
),
581 integral_constant
<bool, __move_storage
>());
586 * @brief The %forward_list initializer list assignment operator.
587 * @param __il An initializer_list of value_type.
589 * Replace the contents of the %forward_list with copies of the
590 * elements in the initializer_list @a __il. This is linear in
594 operator=(std::initializer_list
<_Tp
> __il
)
601 * @brief Assigns a range to a %forward_list.
602 * @param __first An input iterator.
603 * @param __last An input iterator.
605 * This function fills a %forward_list with copies of the elements
606 * in the range [@a __first,@a __last).
608 * Note that the assignment completely changes the %forward_list and
609 * that the number of elements of the resulting %forward_list is the
610 * same as the number of elements assigned. Old data is lost.
612 template<typename _InputIterator
,
613 typename
= std::_RequireInputIter
<_InputIterator
>>
615 assign(_InputIterator __first
, _InputIterator __last
)
617 typedef is_assignable
<_Tp
, decltype(*__first
)> __assignable
;
618 _M_assign(__first
, __last
, __assignable());
622 * @brief Assigns a given value to a %forward_list.
623 * @param __n Number of elements to be assigned.
624 * @param __val Value to be assigned.
626 * This function fills a %forward_list with @a __n copies of the
627 * given value. Note that the assignment completely changes the
628 * %forward_list, and that the resulting %forward_list has __n
629 * elements. Old data is lost.
632 assign(size_type __n
, const _Tp
& __val
)
633 { _M_assign_n(__n
, __val
, is_copy_assignable
<_Tp
>()); }
636 * @brief Assigns an initializer_list to a %forward_list.
637 * @param __il An initializer_list of value_type.
639 * Replace the contents of the %forward_list with copies of the
640 * elements in the initializer_list @a __il. This is linear in
644 assign(std::initializer_list
<_Tp
> __il
)
645 { assign(__il
.begin(), __il
.end()); }
647 /// Get a copy of the memory allocation object.
649 get_allocator() const noexcept
650 { return allocator_type(this->_M_get_Node_allocator()); }
652 // 23.3.4.3 iterators:
655 * Returns a read/write iterator that points before the first element
656 * in the %forward_list. Iteration is done in ordinary element order.
659 before_begin() noexcept
660 { return iterator(&this->_M_impl
._M_head
); }
663 * Returns a read-only (constant) iterator that points before the
664 * first element in the %forward_list. Iteration is done in ordinary
668 before_begin() const noexcept
669 { return const_iterator(&this->_M_impl
._M_head
); }
672 * Returns a read/write iterator that points to the first element
673 * in the %forward_list. Iteration is done in ordinary element order.
677 { return iterator(this->_M_impl
._M_head
._M_next
); }
680 * Returns a read-only (constant) iterator that points to the first
681 * element in the %forward_list. Iteration is done in ordinary
685 begin() const noexcept
686 { return const_iterator(this->_M_impl
._M_head
._M_next
); }
689 * Returns a read/write iterator that points one past the last
690 * element in the %forward_list. Iteration is done in ordinary
695 { return iterator(0); }
698 * Returns a read-only iterator that points one past the last
699 * element in the %forward_list. Iteration is done in ordinary
704 { return const_iterator(0); }
707 * Returns a read-only (constant) iterator that points to the
708 * first element in the %forward_list. Iteration is done in ordinary
712 cbegin() const noexcept
713 { return const_iterator(this->_M_impl
._M_head
._M_next
); }
716 * Returns a read-only (constant) iterator that points before the
717 * first element in the %forward_list. Iteration is done in ordinary
721 cbefore_begin() const noexcept
722 { return const_iterator(&this->_M_impl
._M_head
); }
725 * Returns a read-only (constant) iterator that points one past
726 * the last element in the %forward_list. Iteration is done in
727 * ordinary element order.
730 cend() const noexcept
731 { return const_iterator(0); }
734 * Returns true if the %forward_list is empty. (Thus begin() would
738 empty() const noexcept
739 { return this->_M_impl
._M_head
._M_next
== 0; }
742 * Returns the largest possible number of elements of %forward_list.
745 max_size() const noexcept
746 { return _Node_alloc_traits::max_size(this->_M_get_Node_allocator()); }
748 // 23.3.4.4 element access:
751 * Returns a read/write reference to the data at the first
752 * element of the %forward_list.
757 _Node
* __front
= static_cast<_Node
*>(this->_M_impl
._M_head
._M_next
);
758 return *__front
->_M_valptr();
762 * Returns a read-only (constant) reference to the data at the first
763 * element of the %forward_list.
768 _Node
* __front
= static_cast<_Node
*>(this->_M_impl
._M_head
._M_next
);
769 return *__front
->_M_valptr();
772 // 23.3.4.5 modifiers:
775 * @brief Constructs object in %forward_list at the front of the
777 * @param __args Arguments.
779 * This function will insert an object of type Tp constructed
780 * with Tp(std::forward<Args>(args)...) at the front of the list
781 * Due to the nature of a %forward_list this operation can
782 * be done in constant time, and does not invalidate iterators
785 template<typename
... _Args
>
787 emplace_front(_Args
&&... __args
)
788 { this->_M_insert_after(cbefore_begin(),
789 std::forward
<_Args
>(__args
)...); }
792 * @brief Add data to the front of the %forward_list.
793 * @param __val Data to be added.
795 * This is a typical stack operation. The function creates an
796 * element at the front of the %forward_list and assigns the given
797 * data to it. Due to the nature of a %forward_list this operation
798 * can be done in constant time, and does not invalidate iterators
802 push_front(const _Tp
& __val
)
803 { this->_M_insert_after(cbefore_begin(), __val
); }
809 push_front(_Tp
&& __val
)
810 { this->_M_insert_after(cbefore_begin(), std::move(__val
)); }
813 * @brief Removes first element.
815 * This is a typical stack operation. It shrinks the %forward_list
816 * by one. Due to the nature of a %forward_list this operation can
817 * be done in constant time, and only invalidates iterators/references
818 * to the element being removed.
820 * Note that no data is returned, and if the first element's data
821 * is needed, it should be retrieved before pop_front() is
826 { this->_M_erase_after(&this->_M_impl
._M_head
); }
829 * @brief Constructs object in %forward_list after the specified
831 * @param __pos A const_iterator into the %forward_list.
832 * @param __args Arguments.
833 * @return An iterator that points to the inserted data.
835 * This function will insert an object of type T constructed
836 * with T(std::forward<Args>(args)...) after the specified
837 * location. Due to the nature of a %forward_list this operation can
838 * be done in constant time, and does not invalidate iterators
841 template<typename
... _Args
>
843 emplace_after(const_iterator __pos
, _Args
&&... __args
)
844 { return iterator(this->_M_insert_after(__pos
,
845 std::forward
<_Args
>(__args
)...)); }
848 * @brief Inserts given value into %forward_list after specified
850 * @param __pos An iterator into the %forward_list.
851 * @param __val Data to be inserted.
852 * @return An iterator that points to the inserted data.
854 * This function will insert a copy of the given value after
855 * the specified location. Due to the nature of a %forward_list this
856 * operation can be done in constant time, and does not
857 * invalidate iterators and references.
860 insert_after(const_iterator __pos
, const _Tp
& __val
)
861 { return iterator(this->_M_insert_after(__pos
, __val
)); }
867 insert_after(const_iterator __pos
, _Tp
&& __val
)
868 { return iterator(this->_M_insert_after(__pos
, std::move(__val
))); }
871 * @brief Inserts a number of copies of given data into the
873 * @param __pos An iterator into the %forward_list.
874 * @param __n Number of elements to be inserted.
875 * @param __val Data to be inserted.
876 * @return An iterator pointing to the last inserted copy of
877 * @a val or @a pos if @a n == 0.
879 * This function will insert a specified number of copies of the
880 * given data after the location specified by @a pos.
882 * This operation is linear in the number of elements inserted and
883 * does not invalidate iterators and references.
886 insert_after(const_iterator __pos
, size_type __n
, const _Tp
& __val
);
889 * @brief Inserts a range into the %forward_list.
890 * @param __pos An iterator into the %forward_list.
891 * @param __first An input iterator.
892 * @param __last An input iterator.
893 * @return An iterator pointing to the last inserted element or
894 * @a __pos if @a __first == @a __last.
896 * This function will insert copies of the data in the range
897 * [@a __first,@a __last) into the %forward_list after the
898 * location specified by @a __pos.
900 * This operation is linear in the number of elements inserted and
901 * does not invalidate iterators and references.
903 template<typename _InputIterator
,
904 typename
= std::_RequireInputIter
<_InputIterator
>>
906 insert_after(const_iterator __pos
,
907 _InputIterator __first
, _InputIterator __last
);
910 * @brief Inserts the contents of an initializer_list into
911 * %forward_list after the specified iterator.
912 * @param __pos An iterator into the %forward_list.
913 * @param __il An initializer_list of value_type.
914 * @return An iterator pointing to the last inserted element
915 * or @a __pos if @a __il is empty.
917 * This function will insert copies of the data in the
918 * initializer_list @a __il into the %forward_list before the location
919 * specified by @a __pos.
921 * This operation is linear in the number of elements inserted and
922 * does not invalidate iterators and references.
925 insert_after(const_iterator __pos
, std::initializer_list
<_Tp
> __il
)
926 { return insert_after(__pos
, __il
.begin(), __il
.end()); }
929 * @brief Removes the element pointed to by the iterator following
931 * @param __pos Iterator pointing before element to be erased.
932 * @return An iterator pointing to the element following the one
933 * that was erased, or end() if no such element exists.
935 * This function will erase the element at the given position and
936 * thus shorten the %forward_list by one.
938 * Due to the nature of a %forward_list this operation can be done
939 * in constant time, and only invalidates iterators/references to
940 * the element being removed. The user is also cautioned that
941 * this function only erases the element, and that if the element
942 * is itself a pointer, the pointed-to memory is not touched in
943 * any way. Managing the pointer is the user's responsibility.
946 erase_after(const_iterator __pos
)
947 { return iterator(this->_M_erase_after(const_cast<_Node_base
*>
951 * @brief Remove a range of elements.
952 * @param __pos Iterator pointing before the first element to be
954 * @param __last Iterator pointing to one past the last element to be
958 * This function will erase the elements in the range
959 * @a (__pos,__last) and shorten the %forward_list accordingly.
961 * This operation is linear time in the size of the range and only
962 * invalidates iterators/references to the element being removed.
963 * The user is also cautioned that this function only erases the
964 * elements, and that if the elements themselves are pointers, the
965 * pointed-to memory is not touched in any way. Managing the pointer
966 * is the user's responsibility.
969 erase_after(const_iterator __pos
, const_iterator __last
)
970 { return iterator(this->_M_erase_after(const_cast<_Node_base
*>
972 const_cast<_Node_base
*>
973 (__last
._M_node
))); }
976 * @brief Swaps data with another %forward_list.
977 * @param __list A %forward_list of the same element and allocator
980 * This exchanges the elements between two lists in constant
981 * time. Note that the global std::swap() function is
982 * specialized such that std::swap(l1,l2) will feed to this
986 swap(forward_list
& __list
)
987 noexcept(_Node_alloc_traits::_S_nothrow_swap())
989 std::swap(this->_M_impl
._M_head
._M_next
,
990 __list
._M_impl
._M_head
._M_next
);
991 _Node_alloc_traits::_S_on_swap(this->_M_get_Node_allocator(),
992 __list
._M_get_Node_allocator());
996 * @brief Resizes the %forward_list to the specified number of
998 * @param __sz Number of elements the %forward_list should contain.
1000 * This function will %resize the %forward_list to the specified
1001 * number of elements. If the number is smaller than the
1002 * %forward_list's current number of elements the %forward_list
1003 * is truncated, otherwise the %forward_list is extended and the
1004 * new elements are default constructed.
1007 resize(size_type __sz
);
1010 * @brief Resizes the %forward_list to the specified number of
1012 * @param __sz Number of elements the %forward_list should contain.
1013 * @param __val Data with which new elements should be populated.
1015 * This function will %resize the %forward_list to the specified
1016 * number of elements. If the number is smaller than the
1017 * %forward_list's current number of elements the %forward_list
1018 * is truncated, otherwise the %forward_list is extended and new
1019 * elements are populated with given data.
1022 resize(size_type __sz
, const value_type
& __val
);
1025 * @brief Erases all the elements.
1027 * Note that this function only erases
1028 * the elements, and that if the elements themselves are
1029 * pointers, the pointed-to memory is not touched in any way.
1030 * Managing the pointer is the user's responsibility.
1034 { this->_M_erase_after(&this->_M_impl
._M_head
, 0); }
1036 // 23.3.4.6 forward_list operations:
1039 * @brief Insert contents of another %forward_list.
1040 * @param __pos Iterator referencing the element to insert after.
1041 * @param __list Source list.
1043 * The elements of @a list are inserted in constant time after
1044 * the element referenced by @a pos. @a list becomes an empty
1047 * Requires this != @a x.
1050 splice_after(const_iterator __pos
, forward_list
&& __list
)
1052 if (!__list
.empty())
1053 _M_splice_after(__pos
, __list
.before_begin(), __list
.end());
1057 splice_after(const_iterator __pos
, forward_list
& __list
)
1058 { splice_after(__pos
, std::move(__list
)); }
1061 * @brief Insert element from another %forward_list.
1062 * @param __pos Iterator referencing the element to insert after.
1063 * @param __list Source list.
1064 * @param __i Iterator referencing the element before the element
1067 * Removes the element in list @a list referenced by @a i and
1068 * inserts it into the current list after @a pos.
1071 splice_after(const_iterator __pos
, forward_list
&& __list
,
1072 const_iterator __i
);
1075 splice_after(const_iterator __pos
, forward_list
& __list
,
1077 { splice_after(__pos
, std::move(__list
), __i
); }
1080 * @brief Insert range from another %forward_list.
1081 * @param __pos Iterator referencing the element to insert after.
1082 * @param __list Source list.
1083 * @param __before Iterator referencing before the start of range
1085 * @param __last Iterator referencing the end of range in list.
1087 * Removes elements in the range (__before,__last) and inserts them
1088 * after @a __pos in constant time.
1090 * Undefined if @a __pos is in (__before,__last).
1093 splice_after(const_iterator __pos
, forward_list
&&,
1094 const_iterator __before
, const_iterator __last
)
1095 { _M_splice_after(__pos
, __before
, __last
); }
1098 splice_after(const_iterator __pos
, forward_list
&,
1099 const_iterator __before
, const_iterator __last
)
1100 { _M_splice_after(__pos
, __before
, __last
); }
1103 * @brief Remove all elements equal to value.
1104 * @param __val The value to remove.
1106 * Removes every element in the list equal to @a __val.
1107 * Remaining elements stay in list order. Note that this
1108 * function only erases the elements, and that if the elements
1109 * themselves are pointers, the pointed-to memory is not
1110 * touched in any way. Managing the pointer is the user's
1114 remove(const _Tp
& __val
);
1117 * @brief Remove all elements satisfying a predicate.
1118 * @param __pred Unary predicate function or object.
1120 * Removes every element in the list for which the predicate
1121 * returns true. Remaining elements stay in list order. Note
1122 * that this function only erases the elements, and that if the
1123 * elements themselves are pointers, the pointed-to memory is
1124 * not touched in any way. Managing the pointer is the user's
1127 template<typename _Pred
>
1129 remove_if(_Pred __pred
);
1132 * @brief Remove consecutive duplicate elements.
1134 * For each consecutive set of elements with the same value,
1135 * remove all but the first one. Remaining elements stay in
1136 * list order. Note that this function only erases the
1137 * elements, and that if the elements themselves are pointers,
1138 * the pointed-to memory is not touched in any way. Managing
1139 * the pointer is the user's responsibility.
1143 { unique(std::equal_to
<_Tp
>()); }
1146 * @brief Remove consecutive elements satisfying a predicate.
1147 * @param __binary_pred Binary predicate function or object.
1149 * For each consecutive set of elements [first,last) that
1150 * satisfy predicate(first,i) where i is an iterator in
1151 * [first,last), remove all but the first one. Remaining
1152 * elements stay in list order. Note that this function only
1153 * erases the elements, and that if the elements themselves are
1154 * pointers, the pointed-to memory is not touched in any way.
1155 * Managing the pointer is the user's responsibility.
1157 template<typename _BinPred
>
1159 unique(_BinPred __binary_pred
);
1162 * @brief Merge sorted lists.
1163 * @param __list Sorted list to merge.
1165 * Assumes that both @a list and this list are sorted according to
1166 * operator<(). Merges elements of @a __list into this list in
1167 * sorted order, leaving @a __list empty when complete. Elements in
1168 * this list precede elements in @a __list that are equal.
1171 merge(forward_list
&& __list
)
1172 { merge(std::move(__list
), std::less
<_Tp
>()); }
1175 merge(forward_list
& __list
)
1176 { merge(std::move(__list
)); }
1179 * @brief Merge sorted lists according to comparison function.
1180 * @param __list Sorted list to merge.
1181 * @param __comp Comparison function defining sort order.
1183 * Assumes that both @a __list and this list are sorted according to
1184 * comp. Merges elements of @a __list into this list
1185 * in sorted order, leaving @a __list empty when complete. Elements
1186 * in this list precede elements in @a __list that are equivalent
1187 * according to comp().
1189 template<typename _Comp
>
1191 merge(forward_list
&& __list
, _Comp __comp
);
1193 template<typename _Comp
>
1195 merge(forward_list
& __list
, _Comp __comp
)
1196 { merge(std::move(__list
), __comp
); }
1199 * @brief Sort the elements of the list.
1201 * Sorts the elements of this list in NlogN time. Equivalent
1202 * elements remain in list order.
1206 { sort(std::less
<_Tp
>()); }
1209 * @brief Sort the forward_list using a comparison function.
1211 * Sorts the elements of this list in NlogN time. Equivalent
1212 * elements remain in list order.
1214 template<typename _Comp
>
1219 * @brief Reverse the elements in list.
1221 * Reverse the order of elements in the list in linear time.
1225 { this->_M_impl
._M_head
._M_reverse_after(); }
1228 // Called by the range constructor to implement [23.3.4.2]/9
1229 template<typename _InputIterator
>
1231 _M_range_initialize(_InputIterator __first
, _InputIterator __last
);
1233 // Called by forward_list(n,v,a), and the range constructor when it
1234 // turns out to be the same thing.
1236 _M_fill_initialize(size_type __n
, const value_type
& __value
);
1238 // Called by splice_after and insert_after.
1240 _M_splice_after(const_iterator __pos
, const_iterator __before
,
1241 const_iterator __last
);
1243 // Called by forward_list(n).
1245 _M_default_initialize(size_type __n
);
1247 // Called by resize(sz).
1249 _M_default_insert_after(const_iterator __pos
, size_type __n
);
1251 // Called by operator=(forward_list&&)
1253 _M_move_assign(forward_list
&& __list
, std::true_type
) noexcept
1256 std::swap(this->_M_impl
._M_head
._M_next
,
1257 __list
._M_impl
._M_head
._M_next
);
1258 std::__alloc_on_move(this->_M_get_Node_allocator(),
1259 __list
._M_get_Node_allocator());
1262 // Called by operator=(forward_list&&)
1264 _M_move_assign(forward_list
&& __list
, std::false_type
)
1266 if (__list
._M_get_Node_allocator() == this->_M_get_Node_allocator())
1267 _M_move_assign(std::move(__list
), std::true_type());
1269 // The rvalue's allocator cannot be moved, or is not equal,
1270 // so we need to individually move each element.
1271 this->assign(std::__make_move_if_noexcept_iterator(__list
.begin()),
1272 std::__make_move_if_noexcept_iterator(__list
.end()));
1275 // Called by assign(_InputIterator, _InputIterator) if _Tp is
1277 template<typename _InputIterator
>
1279 _M_assign(_InputIterator __first
, _InputIterator __last
, true_type
)
1281 auto __prev
= before_begin();
1282 auto __curr
= begin();
1284 while (__curr
!= __end
&& __first
!= __last
)
1291 if (__first
!= __last
)
1292 insert_after(__prev
, __first
, __last
);
1293 else if (__curr
!= __end
)
1294 erase_after(__prev
, __end
);
1297 // Called by assign(_InputIterator, _InputIterator) if _Tp is not
1299 template<typename _InputIterator
>
1301 _M_assign(_InputIterator __first
, _InputIterator __last
, false_type
)
1304 insert_after(cbefore_begin(), __first
, __last
);
1307 // Called by assign(size_type, const _Tp&) if Tp is CopyAssignable
1309 _M_assign_n(size_type __n
, const _Tp
& __val
, true_type
)
1311 auto __prev
= before_begin();
1312 auto __curr
= begin();
1314 while (__curr
!= __end
&& __n
> 0)
1322 insert_after(__prev
, __n
, __val
);
1323 else if (__curr
!= __end
)
1324 erase_after(__prev
, __end
);
1327 // Called by assign(size_type, const _Tp&) if Tp is non-CopyAssignable
1329 _M_assign_n(size_type __n
, const _Tp
& __val
, false_type
)
1332 insert_after(cbefore_begin(), __n
, __val
);
1337 * @brief Forward list equality comparison.
1338 * @param __lx A %forward_list
1339 * @param __ly A %forward_list of the same type as @a __lx.
1340 * @return True iff the elements of the forward lists are equal.
1342 * This is an equivalence relation. It is linear in the number of
1343 * elements of the forward lists. Deques are considered equivalent
1344 * if corresponding elements compare equal.
1346 template<typename _Tp
, typename _Alloc
>
1348 operator==(const forward_list
<_Tp
, _Alloc
>& __lx
,
1349 const forward_list
<_Tp
, _Alloc
>& __ly
);
1352 * @brief Forward list ordering relation.
1353 * @param __lx A %forward_list.
1354 * @param __ly A %forward_list of the same type as @a __lx.
1355 * @return True iff @a __lx is lexicographically less than @a __ly.
1357 * This is a total ordering relation. It is linear in the number of
1358 * elements of the forward lists. The elements must be comparable
1361 * See std::lexicographical_compare() for how the determination is made.
1363 template<typename _Tp
, typename _Alloc
>
1365 operator<(const forward_list
<_Tp
, _Alloc
>& __lx
,
1366 const forward_list
<_Tp
, _Alloc
>& __ly
)
1367 { return std::lexicographical_compare(__lx
.cbegin(), __lx
.cend(),
1368 __ly
.cbegin(), __ly
.cend()); }
1370 /// Based on operator==
1371 template<typename _Tp
, typename _Alloc
>
1373 operator!=(const forward_list
<_Tp
, _Alloc
>& __lx
,
1374 const forward_list
<_Tp
, _Alloc
>& __ly
)
1375 { return !(__lx
== __ly
); }
1377 /// Based on operator<
1378 template<typename _Tp
, typename _Alloc
>
1380 operator>(const forward_list
<_Tp
, _Alloc
>& __lx
,
1381 const forward_list
<_Tp
, _Alloc
>& __ly
)
1382 { return (__ly
< __lx
); }
1384 /// Based on operator<
1385 template<typename _Tp
, typename _Alloc
>
1387 operator>=(const forward_list
<_Tp
, _Alloc
>& __lx
,
1388 const forward_list
<_Tp
, _Alloc
>& __ly
)
1389 { return !(__lx
< __ly
); }
1391 /// Based on operator<
1392 template<typename _Tp
, typename _Alloc
>
1394 operator<=(const forward_list
<_Tp
, _Alloc
>& __lx
,
1395 const forward_list
<_Tp
, _Alloc
>& __ly
)
1396 { return !(__ly
< __lx
); }
1398 /// See std::forward_list::swap().
1399 template<typename _Tp
, typename _Alloc
>
1401 swap(forward_list
<_Tp
, _Alloc
>& __lx
,
1402 forward_list
<_Tp
, _Alloc
>& __ly
)
1403 { __lx
.swap(__ly
); }
1405 _GLIBCXX_END_NAMESPACE_CONTAINER
1408 #endif // _FORWARD_LIST_H