Utilities

Collaboration diagram for Utilities:

Modules
	Function Objects
	Memory
	Metaprogramming
	Rational Arithmetic
	Time

Classes
struct	std::_Tuple_impl< _Idx, _Elements >
class	std::tuple< _Elements >
struct	std::tuple_element< __i, tuple< _Head, _Tail... > >
struct	std::tuple_size< tuple< _Elements... > >
struct	std::uses_allocator< tuple< _Types... >, _Alloc >

Macros
#define	__cpp_lib_tuples_by_type

Typedefs
template<typename _Res , typename _Callable , typename... _Args>
using	std::__can_invoke_as_nonvoid = __enable_if_t< __and_< __not_< is_void< _Res > >, is_convertible< typename __invoke_result< _Callable, _Args... >::type, _Res > >::value, _Res >
template<typename _Res , typename _Callable , typename... _Args>
using	std::__can_invoke_as_void = __enable_if_t< __and_< is_void< _Res >, __is_invocable< _Callable, _Args... > >::value, _Res >
template<typename _Tp >
using	std::__empty_not_final = typename conditional< __is_final(_Tp), false_type, __is_empty_non_tuple< _Tp > >::type

Functions
template<typename... _Args1, typename... _Args2>
constexpr	std::pair< _T1, _T2 >::pair (piecewise_construct_t, tuple< _Args1... >, tuple< _Args2... >)
template<typename _Tp >
constexpr _Tp *	std::__addressof (_Tp &__r) noexcept
template<typename _Tp , typename _Up = _Tp>
constexpr _Tp	std::__exchange (_Tp &__obj, _Up &&__new_val)
template<std::size_t __i, typename _Head , typename... _Tail>
constexpr _Head &	std::__get_helper (_Tuple_impl< __i, _Head, _Tail... > &__t) noexcept
template<std::size_t __i, typename _Head , typename... _Tail>
constexpr const _Head &	std::__get_helper (const _Tuple_impl< __i, _Head, _Tail... > &__t) noexcept
template<typename _Head , size_t __i, typename... _Tail>
constexpr _Head &	std::__get_helper2 (_Tuple_impl< __i, _Head, _Tail... > &__t) noexcept
template<typename _Head , size_t __i, typename... _Tail>
constexpr const _Head &	std::__get_helper2 (const _Tuple_impl< __i, _Head, _Tail... > &__t) noexcept
template<typename _Tp , typename _Up = typename __inv_unwrap<_Tp>::type>
constexpr _Up &&	std::__invfwd (typename remove_reference< _Tp >::type &__t) noexcept
template<typename _Callable , typename... _Args>
constexpr __invoke_result< _Callable, _Args... >::type	std::__invoke (_Callable &&__fn, _Args &&... __args) noexcept(__is_nothrow_invocable< _Callable, _Args... >::value)
template<typename _Res , typename _MemFun , typename _Tp , typename... _Args>
constexpr _Res	std::__invoke_impl (__invoke_memfun_deref, _MemFun &&__f, _Tp &&__t, _Args &&... __args)
template<typename _Res , typename _MemFun , typename _Tp , typename... _Args>
constexpr _Res	std::__invoke_impl (__invoke_memfun_ref, _MemFun &&__f, _Tp &&__t, _Args &&... __args)
template<typename _Res , typename _MemPtr , typename _Tp >
constexpr _Res	std::__invoke_impl (__invoke_memobj_deref, _MemPtr &&__f, _Tp &&__t)
template<typename _Res , typename _MemPtr , typename _Tp >
constexpr _Res	std::__invoke_impl (__invoke_memobj_ref, _MemPtr &&__f, _Tp &&__t)
template<typename _Res , typename _Fn , typename... _Args>
constexpr _Res	std::__invoke_impl (__invoke_other, _Fn &&__f, _Args &&... __args)
template<typename _Res , typename _Callable , typename... _Args>
constexpr __can_invoke_as_nonvoid< _Res, _Callable, _Args... >	std::__invoke_r (_Callable &&__fn, _Args &&... __args)
template<typename _Tp >
constexpr _Tp *	std::addressof (_Tp &__r) noexcept
template<typename _Tp >
const _Tp *	std::addressof (const _Tp &&)=delete
template<typename _Tp >
constexpr _Tp &&	std::forward (typename std::remove_reference< _Tp >::type &&__t) noexcept
template<typename _Tp >
constexpr _Tp &&	std::forward (typename std::remove_reference< _Tp >::type &__t) noexcept
template<typename... _Elements>
constexpr tuple< _Elements &&... >	std::forward_as_tuple (_Elements &&... __args) noexcept
template<std::size_t __i, typename... _Elements>
constexpr const __tuple_element_t< __i, tuple< _Elements... > > &&	std::get (const tuple< _Elements... > &&__t) noexcept
template<std::size_t __i, typename... _Elements>
constexpr const __tuple_element_t< __i, tuple< _Elements... > > &	std::get (const tuple< _Elements... > &__t) noexcept
template<typename _Tp , typename... _Types>
constexpr const _Tp &&	std::get (const tuple< _Types... > &&__t) noexcept
template<typename _Tp , typename... _Types>
constexpr const _Tp &	std::get (const tuple< _Types... > &__t) noexcept
template<std::size_t __i, typename... _Elements>
constexpr __tuple_element_t< __i, tuple< _Elements... > > &&	std::get (tuple< _Elements... > &&__t) noexcept
template<std::size_t __i, typename... _Elements>
constexpr __tuple_element_t< __i, tuple< _Elements... > > &	std::get (tuple< _Elements... > &__t) noexcept
template<typename _Tp , typename... _Types>
constexpr _Tp &&	std::get (tuple< _Types... > &&__t) noexcept
template<typename _Tp , typename... _Types>
constexpr _Tp &	std::get (tuple< _Types... > &__t) noexcept
template<typename _T1 , typename _T2 >
constexpr pair< typename __decay_and_strip< _T1 >::__type, typename __decay_and_strip< _T2 >::__type >	make_pair (_T1 &&__x, _T2 &&__y)
template<typename... _Elements>
constexpr tuple< typename __decay_and_strip< _Elements >::__type... >	std::make_tuple (_Elements &&... __args)
template<typename _Tp >
constexpr std::remove_reference< _Tp >::type &&	std::move (_Tp &&__t) noexcept
template<typename _Tp >
constexpr conditional< __move_if_noexcept_cond< _Tp >::value, const _Tp &, _Tp && >::type	std::move_if_noexcept (_Tp &__x) noexcept
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator!= (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator< (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator<= (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator== (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator> (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename... _TElements, typename... _UElements>
constexpr bool	std::operator>= (const tuple< _TElements... > &__t, const tuple< _UElements... > &__u)
template<typename _Tp >
constexpr enable_if< __and_< __not_< __is_tuple_like< _Tp > >, is_move_constructible< _Tp >, is_move_assignable< _Tp > >::value >::type	std::swap (_Tp &__a, _Tp &__b) noexcept(/*conditional */) is_nothrow_move_assignable< _Tp >>
template<typename _Tp , size_t _Nm>
constexpr enable_if< __is_swappable< _Tp >::value >::type	std::swap (_Tp(&__a)[_Nm], _Tp(&__b)[_Nm]) noexcept(/*conditional */)
template<typename... _Elements>
constexpr enable_if< __and_< __is_swappable< _Elements >... >::value >::type	std::swap (tuple< _Elements... > &__x, tuple< _Elements... > &__y) noexcept(noexcept(__x.swap(__y)))
template<typename... _Elements>
constexpr tuple< _Elements &... >	std::tie (_Elements &... __args) noexcept
template<typename... _Tpls, typename = typename enable_if<__and_<__is_tuple_like<_Tpls>...>::value>::type>
constexpr auto	std::tuple_cat (_Tpls &&... __tpls) -> typename __tuple_cat_result< _Tpls... >::__type

Variables
constexpr _Swallow_assign	std::ignore
constexpr piecewise_construct_t	std::piecewise_construct
template<typename _T1 , typename _T2 >
constexpr bool	operator== (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr bool	operator< (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr bool	operator!= (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr bool	operator> (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr bool	operator<= (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr bool	operator>= (const pair< _T1, _T2 > &__x, const pair< _T1, _T2 > &__y)
template<typename _T1 , typename _T2 >
constexpr enable_if< __and_< __is_swappable< _T1 >, __is_swappable< _T2 > >::value >::type	swap (pair< _T1, _T2 > &__x, pair< _T1, _T2 > &__y) noexcept(noexcept(__x.swap(__y)))

Detailed Description

Components deemed generally useful. Includes pair, tuple, forward/move helpers, ratio, function object, metaprogramming and type traits, time, date, and memory functions.

Function Documentation

pair()

template<class _T1 , class _T2 >

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

constexpr std::pair< _T1, _T2 >::pair ( piecewise_construct_t  , tuple< _Args1... >  __first, tuple< _Args2... >  __second  )

inlineconstexpr

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

Parameters

__first	Arguments for the first member of the pair.
__second	Arguments for the second member of the pair.

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

Definition at line 1690 of file tuple.

__addressof()

template<typename _Tp >

constexpr _Tp* std::__addressof ( _Tp &  __r )

inlineconstexprnoexcept

Same as C++11 std::addressof.

Definition at line 49 of file move.h.

Referenced by std::_Destroy(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), std::addressof(), std::list< _Tp, _Alloc >::merge(), std::sub_match< _BiIter >::operator<(), std::forward_list< _Tp, _Alloc >::operator=(), std::list< _Tp, _Alloc >::operator=(), std::sub_match< _BiIter >::operator==(), std::list< _Tp, _Alloc >::remove(), std::rethrow_if_nested(), and std::list< _Tp, _Alloc >::splice().

__invoke()

template<typename _Callable , typename... _Args>

constexpr __invoke_result<_Callable, _Args...>::type std::__invoke ( _Callable &&  __fn, _Args &&...  __args  )

constexprnoexcept

Invoke a callable object.

Definition at line 89 of file invoke.h.

addressof()

template<typename _Tp >

constexpr _Tp* std::addressof ( _Tp &  __r )

inlineconstexprnoexcept

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

Parameters

__r	Reference to an object or function.

Returns

The actual address.

Definition at line 140 of file move.h.

References std::__addressof().

Referenced by std::pointer_traits< _Tp * >::pointer_to().

forward() [1/2]

template<typename _Tp >

constexpr _Tp&& std::forward ( typename std::remove_reference< _Tp >::type &&  __t )

constexprnoexcept

Forward an rvalue.

Returns

The parameter cast to the specified type.

This function is used to implement "perfect forwarding".

Definition at line 87 of file move.h.

forward() [2/2]

template<typename _Tp >

constexpr _Tp&& std::forward ( typename std::remove_reference< _Tp >::type &  __t )

constexprnoexcept

Forward an lvalue.

Returns

The parameter cast to the specified type.

This function is used to implement "perfect forwarding".

Definition at line 76 of file move.h.

forward_as_tuple()

template<typename... _Elements>

constexpr tuple<_Elements&&...> std::forward_as_tuple ( _Elements &&...  __args )

constexprnoexcept

std::forward_as_tuple

Definition at line 1503 of file tuple.

get() [1/8]

template<std::size_t __i, typename... _Elements>

constexpr const __tuple_element_t<__i, tuple<_Elements...> >&& std::get ( const tuple< _Elements... > &&  __t )

constexprnoexcept

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

Definition at line 1332 of file tuple.

get() [2/8]

template<std::size_t __i, typename... _Elements>

constexpr const __tuple_element_t<__i, tuple<_Elements...> >& std::get ( const tuple< _Elements... > &  __t )

constexprnoexcept

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

Definition at line 1317 of file tuple.

get() [3/8]

template<typename _Tp , typename... _Types>

constexpr const _Tp&& std::get ( const tuple< _Types... > &&  __t )

constexprnoexcept

Return a const reference to the unique element of type _Tp of a const tuple rvalue.

Definition at line 1374 of file tuple.

get() [4/8]

template<typename _Tp , typename... _Types>

constexpr const _Tp& std::get ( const tuple< _Types... > &  __t )

constexprnoexcept

Return a const reference to the unique element of type _Tp of a tuple.

Definition at line 1367 of file tuple.

get() [5/8]

template<std::size_t __i, typename... _Elements>

constexpr __tuple_element_t<__i, tuple<_Elements...> >&& std::get ( tuple< _Elements... > &&  __t )

constexprnoexcept

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

Definition at line 1323 of file tuple.

get() [6/8]

template<std::size_t __i, typename... _Elements>

constexpr __tuple_element_t<__i, tuple<_Elements...> >& std::get ( tuple< _Elements... > &  __t )

constexprnoexcept

Return a reference to the ith element of a tuple.

Definition at line 1311 of file tuple.

get() [7/8]

template<typename _Tp , typename... _Types>

constexpr _Tp&& std::get ( tuple< _Types... > &&  __t )

constexprnoexcept

Return a reference to the unique element of type _Tp of a tuple rvalue.

Definition at line 1361 of file tuple.

get() [8/8]

template<typename _Tp , typename... _Types>

constexpr _Tp& std::get ( tuple< _Types... > &  __t )

constexprnoexcept

Return a reference to the unique element of type _Tp of a tuple.

Definition at line 1355 of file tuple.

make_pair()

template<typename _T1 , typename _T2 >

constexpr pair< typename __decay_and_strip< _T1 >::__type, typename __decay_and_strip< _T2 >::__type > make_pair ( _T1 &&  __x, _T2 &&  __y  )

related

A convenience wrapper for creating a pair from two objects.

Parameters

__x	The first object.
__y	The second object.

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 567 of file stl_pair.h.

move()

template<typename _Tp >

constexpr std::remove_reference<_Tp>::type&& std::move ( _Tp &&  __t )

constexprnoexcept

Convert a value to an rvalue.

Parameters

__t	A thing of arbitrary type.

Returns

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

Definition at line 101 of file move.h.

Referenced by std::function< _Res(_ArgTypes...)>::function(), std::unique_ptr< _Tp, _Dp >::~unique_ptr(), std::basic_regex< _Ch_type, _Rx_traits >::assign(), std::shared_ptr< _Tp >::atomic_compare_exchange_strong_explicit(), std::deque< _Tp, _Alloc >::insert(), std::list< _Tp, _Alloc >::insert(), std::vector< _Tp, _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::forward_list< _Tp, _Alloc >::merge(), std::move_if_noexcept(), std::basic_regex< _Ch_type, _Rx_traits >::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::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >::operator[](), std::unique_ptr< _Tp[], _Dp >::reset(), std::unique_ptr< _Tp, _Dp >::reset(), and std::list< _Tp, _Alloc >::splice().

move_if_noexcept()

template<typename _Tp >

constexpr conditional<__move_if_noexcept_cond<_Tp>::value, const _Tp&, _Tp&&>::type std::move_if_noexcept ( _Tp &  __x )

constexprnoexcept

Conditionally convert a value to an rvalue.

Parameters

__x	A thing of arbitrary type.

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 121 of file move.h.

References std::move().

operator!=()

template<typename _T1 , typename _T2 >

constexpr bool operator!= ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Uses operator== to find the result.

Definition at line 496 of file stl_pair.h.

operator<()

template<typename _T1 , typename _T2 >

constexpr bool operator< ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Defines a lexicographical order for pairs.

For two pairs of the same type, 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 488 of file stl_pair.h.

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

operator<=()

template<typename _T1 , typename _T2 >

constexpr bool operator<= ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Uses operator< to find the result.

Definition at line 507 of file stl_pair.h.

operator==()

template<typename _T1 , typename _T2 >

constexpr bool operator== ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Two pairs of the same type are equal iff their members are equal.

Definition at line 466 of file stl_pair.h.

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

operator>()

template<typename _T1 , typename _T2 >

constexpr bool operator> ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Uses operator< to find the result.

Definition at line 502 of file stl_pair.h.

operator>=()

template<typename _T1 , typename _T2 >

constexpr bool operator>= ( const pair< _T1, _T2 > &  __x, const pair< _T1, _T2 > &  __y  )

related

Uses operator< to find the result.

Definition at line 514 of file stl_pair.h.

swap() [1/4]

template<typename _Tp >

constexpr enable_if<__and_<__not_<__is_tuple_like<_Tp> >, is_move_constructible<_Tp>, is_move_assignable<_Tp> >::value>::type std::swap ( _Tp &  __a, _Tp &  __b  )

inlineconstexprnoexcept

Swaps two values.

Parameters

__a	A thing of arbitrary type.
__b	Another thing of arbitrary type.

Returns

Nothing.

Definition at line 189 of file move.h.

swap() [2/4]

template<typename _Tp , size_t _Nm>

constexpr enable_if<__is_swappable<_Tp>::value>::type std::swap ( _Tp(&)  __a[_Nm], _Tp(&)  __b[_Nm]  )

inlineconstexprnoexcept

Swap the contents of two arrays.

Definition at line 213 of file move.h.

swap() [3/4]

template<typename _T1 , typename _T2 >

constexpr enable_if< __and_< __is_swappable< _T1 >, __is_swappable< _T2 > >::value >::type swap ( pair< _T1, _T2 > &  __x, pair< _T1, _T2 > &  __y  )

related

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 533 of file stl_pair.h.

References std::pair< _T1, _T2 >::swap().

swap() [4/4]

template<typename... _Elements>

constexpr enable_if<__and_<__is_swappable<_Elements>...>::value >::type std::swap ( tuple< _Elements... > &  __x, tuple< _Elements... > &  __y  )

inlineconstexprdeletenoexcept

swap

Definition at line 1646 of file tuple.

tie()

template<typename... _Elements>

constexpr tuple<_Elements&...> std::tie ( _Elements &...  __args )

constexprnoexcept

tie

Definition at line 1632 of file tuple.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().

tuple_cat()

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

constexpr auto std::tuple_cat ( _Tpls &&...  __tpls ) -> typename __tuple_cat_result<_Tpls...>::__type

constexpr

tuple_cat

Definition at line 1618 of file tuple.

Variable Documentation

piecewise_construct

constexpr piecewise_construct_t std::piecewise_construct

inlineconstexpr

Tag for piecewise construction of std::pair objects.

Definition at line 83 of file stl_pair.h.