libstdc++: Utilities (original) (raw)

Basic function and class templates used with the rest of the library. Includes pair, swap, forward/move helpers, declval, integer_sequence.

◆ pair() [1/2]

template<typename _T1 , typename _T2 >

Two pairs are equal iff their members are equal.

◆ pair() [2/2]

template<class _T1 , class _T2 >

template<typename... _Args1, typename... _Args2>

"piecewise construction" using a tuple of arguments for each member.

Parameters

The elements of each tuple will be used as the constructor arguments for the data members of the pair.

Definition at line 2867 of file tuple.

◆ __addressof()

template<typename _Tp >

Same as C++11 std::addressof.

Definition at line 51 of file move.h.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), std::addressof(), std::begin(), std::begin(), std::basic_ios< _CharT, _Traits >::copyfmt(), std::end(), std::end(), std::forward_list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::merge(), std::list< _Tp, _Alloc >::merge(), std::sub_match< _BiIter >::operator(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator=(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator=(), std::deque< _Tp, _Alloc >::operator=(), std::forward_list< _Tp, _Alloc >::operator=(), std::list< _Tp, _Alloc >::operator=(), std::sub_match< _BiIter >::operator==(), std::list< _Tp, _Alloc >::splice(), and std::list< _Tp, _Alloc >::splice().

◆ __exchange()

template<typename _Tp , typename _Up = _Tp>

Definition at line 175 of file move.h.

◆ __get_helper() [1/2]

template<size_t __i, typename _Head , typename... _Tail>

Definition at line 2424 of file tuple.

◆ __get_helper() [2/2]

template<size_t __i, typename _Head , typename... _Tail>

Definition at line 2429 of file tuple.

◆ __invfwd()

template<typename _Tp , typename _Up = typename __inv_unwrap<_Tp>::type>

◆ __invoke()

template<typename _Callable , typename... _Args>

Invoke a callable object.

Definition at line 90 of file invoke.h.

◆ __invoke_impl() [1/5]

template<typename _Res , typename _MemFun , typename _Tp , typename... _Args>

◆ __invoke_impl() [2/5]

template<typename _Res , typename _MemFun , typename _Tp , typename... _Args>

◆ __invoke_impl() [3/5]

template<typename _Res , typename _MemPtr , typename _Tp >

◆ __invoke_impl() [4/5]

template<typename _Res , typename _MemPtr , typename _Tp >

◆ __invoke_impl() [5/5]

template<typename _Res , typename _Fn , typename... _Args>

◆ __invoke_r()

template<typename _Res , typename _Callable , typename... _Args>

◆ __tuple_cmp()

template<typename _Cat , typename _Tp , typename _Up , typename _IndexSeq >

Definition at line 2540 of file tuple.

◆ addressof()

template<typename _Tp >

Returns the actual address of the object or function referenced by r, even in the presence of an overloaded operator&.

Parameters

Returns

The actual address.

Definition at line 163 of file move.h.

References std::__addressof().

◆ declval()

template<typename _Tp >

Utility to simplify expressions used in unevaluated operands

Since

C++11

Definition at line 2555 of file type_traits.

◆ forward() [1/2]

Forward an rvalue.

Returns

The parameter cast to the specified type.

This function is used to implement "perfect forwarding".

Definition at line 82 of file move.h.

◆ forward() [2/2]

Forward an lvalue.

Returns

The parameter cast to the specified type.

This function is used to implement "perfect forwarding".

Definition at line 70 of file move.h.

◆ forward_as_tuple()

template<typename... _Elements>

Create a tuple of lvalue or rvalue references to the arguments.

Definition at line 2676 of file tuple.

Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::insert_or_assign(), std::map< _Key, _Tp, _Compare, _Alloc >::insert_or_assign(), std::map< _Key, _Tp, _Compare, _Alloc >::try_emplace(), and std::map< _Key, _Tp, _Compare, _Alloc >::try_emplace().

◆ get() [1/4]

template<size_t __i, typename... _Elements>

Return a const rvalue reference to the ith element of a const tuple rvalue.

Definition at line 2461 of file tuple.

◆ get() [2/4]

template<size_t __i, typename... _Elements>

Return a const reference to the ith element of a const tuple.

Definition at line 2446 of file tuple.

◆ get() [3/4]

template<size_t __i, typename... _Elements>

Return an rvalue reference to the ith element of a tuple rvalue.

Definition at line 2452 of file tuple.

◆ get() [4/4]

template<size_t __i, typename... _Elements>

Return a reference to the ith element of a tuple.

Definition at line 2440 of file tuple.

◆ make_pair()

template<typename _T1 , typename _T2 >

A convenience wrapper for creating a pair from two objects.

Parameters

Returns

A newly-constructed pair<> object of the appropriate type.

The C++98 standard says the objects are passed by reference-to-const, but C++03 says they are passed by value (this was LWG issue #181).

Since C++11 they have been passed by forwarding reference and then forwarded to the new members of the pair. To create a pair with a member of reference type, pass a reference_wrapper to this function.

Definition at line 1146 of file stl_pair.h.

◆ make_tuple()

template<typename... _Elements>

Create a tuple containing copies of the arguments.

Definition at line 2664 of file tuple.

◆ move()

Convert a value to an rvalue.

Parameters

Returns

The parameter cast to an rvalue-reference to allow moving it.

Definition at line 127 of file move.h.

Referenced by std::unique_ptr< _Tp, _Dp >::~unique_ptr(), std::experimental::any_cast(), std::basic_regex< _Ch_type, _Rx_traits >::assign(), std::async(), std::atomic_compare_exchange_strong(), std::atomic_compare_exchange_strong(), std::atomic_compare_exchange_strong_explicit(), std::atomic_compare_exchange_strong_explicit(), std::atomic_compare_exchange_weak(), std::atomic_compare_exchange_weak(), std::atomic_compare_exchange_weak_explicit(), std::atomic_compare_exchange_weak_explicit(), std::atomic_exchange(), std::atomic_exchange(), std::atomic_store(), std::atomic_store(), std::shared_ptr< _Tp >::const_pointer_cast(), std::shared_ptr< _Tp >::dynamic_pointer_cast(), std::exclusive_scan(), std::exclusive_scan(), std::for_each_n(), std::future< _Res >::get(), std::get(), std::get(), std::get(), std::get(), std::get(), std::get(), std::inclusive_scan(), std::map< _Key, _Tp, _Compare, _Alloc >::insert(), std::multimap< _Key, _Tp, _Compare, _Alloc >::insert(), std::multiset< _Key, _Compare, _Alloc >::insert(), std::set< _Key, _Compare, _Alloc >::insert(), std::unordered_multimap< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_multiset< _Value, _Hash, _Pred, _Alloc >::insert(), std::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_multimap< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_set< _Value, _Hash, _Pred, _Alloc >::insert(), std::unordered_multiset< _Value, _Hash, _Pred, _Alloc >::insert(), std::vector< _Tp, _Alloc >::insert(), std::deque< _Tp, _Alloc >::insert(), std::list< _Tp, _Alloc >::insert(), std::map< _Key, _Tp, _Compare, _Alloc >::insert(), std::multimap< _Key, _Tp, _Compare, _Alloc >::insert(), std::vector< _Tp, _Alloc >::insert(), std::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_set< _Value, _Hash, _Pred, _Alloc >::insert(), std::map< _Key, _Tp, _Compare, _Alloc >::insert(), std::multimap< _Key, _Tp, _Compare, _Alloc >::insert(), std::multiset< _Key, _Compare, _Alloc >::insert(), std::set< _Key, _Compare, _Alloc >::insert(), std::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_multimap< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_set< _Value, _Hash, _Pred, _Alloc >::insert(), std::unordered_multiset< _Value, _Hash, _Pred, _Alloc >::insert(), std::map< _Key, _Tp, _Compare, _Alloc >::insert(), std::multimap< _Key, _Tp, _Compare, _Alloc >::insert(), std::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_multimap< _Key, _Tp, _Hash, _Pred, _Alloc >::insert(), std::unordered_set< _Value, _Hash, _Pred, _Alloc >::insert(), std::unordered_multiset< _Value, _Hash, _Pred, _Alloc >::insert(), std::experimental::make_boyer_moore_horspool_searcher(), std::experimental::make_boyer_moore_searcher(), std::forward_list< _Tp, _Alloc >::merge(), std::forward_list< _Tp, _Alloc >::merge(), std::move_if_noexcept(), std::tr2::dynamic_bitset< _WordT, _Alloc >::operator&=(), std::chrono::operator<<(), std::deque< _Tp, _Alloc >::operator=(), std::forward_list< _Tp, _Alloc >::operator=(), std::function< _Res(_ArgTypes...)>::operator=(), std::list< _Tp, _Alloc >::operator=(), std::vector< _Tp, _Alloc >::operator=(), std::operator>>(), std::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::operator, std::reduce(), std::shared_ptr< _Tp >::reinterpret_pointer_cast(), std::unique_ptr< _Tp[], _Dp >::reset(), std::unique_ptr< _Tp, _Dp >::reset(), std::list< _Tp, _Alloc >::splice(), std::list< _Tp, _Alloc >::splice(), std::shared_ptr< _Tp >::static_pointer_cast(), std::transform_exclusive_scan(), std::transform_inclusive_scan(), and std::transform_reduce().

◆ move_if_noexcept()

template<typename _Tp >

Conditionally convert a value to an rvalue.

Parameters

Returns

The parameter, possibly cast to an rvalue-reference.

Same as std::move unless the type's move constructor could throw and the type is copyable, in which case an lvalue-reference is returned instead.

Definition at line 148 of file move.h.

References std::move().

◆ operator()

template<typename _T1 , typename _T2 , typename _U1 , typename _U2 >

Defines a lexicographical order for pairs.

For two pairs of comparable types, P is ordered before Q if P.first is less than Q.first, or if P.first and Q.first are equivalent (neither is less than the other) and P.second is less than Q.second.

Definition at line 1029 of file stl_pair.h.

References std::pair< _T1, _T2 >::first, and std::pair< _T1, _T2 >::second.

◆ operator<=>()

template<typename... _Tps, typename... _Ups>
requires (sizeof...(_Tps) == sizeof...(_Ups)) && (requires { typename __detail::__synth3way_t<_Tps, _Ups>; } && ...)

Definition at line 2562 of file tuple.

◆ operator==() [1/2]

template<typename _T1 , typename _T2 , typename _U1 , typename _U2 >

◆ operator==() [2/2]

template<typename... _Tps, typename... _Ups>
requires (sizeof...(_Tps) == sizeof...(_Ups)) && (requires (const _Tps& __t, const _Ups& __u) { { __t == __u } -> __detail::__boolean_testable; } && ...)

Definition at line 2528 of file tuple.

◆ swap() [1/4]

Swaps two values.

Parameters

Returns

Nothing.

Definition at line 214 of file move.h.

◆ swap() [2/4]

template<typename _Tp , size_t _Nm>

Swap the contents of two arrays.

Definition at line 238 of file move.h.

◆ swap() [3/4]

template<typename _T1 , typename _T2 >

Swap overload for pairs. Calls std::pair::swap().

Note

This std::swap overload is not declared in C++03 mode, which has performance implications, e.g. see https://gcc.gnu.org/PR38466

Definition at line 1103 of file stl_pair.h.

◆ swap() [4/4]

template<typename... _Elements>

Exchange the values of two tuples.

Exchange the values of two const tuples (if const elements can be swapped)

Definition at line 2829 of file tuple.

◆ tie()

template<typename... _Elements>

◆ tuple_cat()

template<typename... _Tpls, typename = typename enable_if<__and_<__is_tuple_like<_Tpls>...>::value>::type>

Create a tuple containing all elements from multiple tuple-like objects.

Definition at line 2801 of file tuple.

◆ piecewise_construct

Tag for piecewise construction of std::pair objects.

Definition at line 82 of file stl_pair.h.

Referenced by std::map< _Key, _Tp, _Compare, _Alloc >::insert_or_assign(), std::map< _Key, _Tp, _Compare, _Alloc >::insert_or_assign(), std::map< _Key, _Tp, _Compare, _Alloc >::operator, std::map< _Key, _Tp, _Compare, _Alloc >::try_emplace(), and std::map< _Key, _Tp, _Compare, _Alloc >::try_emplace().

◆ tuple_size_v< const tuple< _Types... > >

template<typename... _Types>

Definition at line 2409 of file tuple.

◆ tuple_size_v< tuple< _Types... > >

template<typename... _Types>

Definition at line 2405 of file tuple.