Section 3: library functions
std::negation – std::negation Synopsis Defined in header<type_traits> template <class B> (1)(since C++ 17) struct negation; Forms the logical negation of the type trait B. The type std::negation<B> is a UnaryTypeTrait with a BaseCharacteristic of std::bool_constant<!bool(B::value)>. Template parameters B – any type such that the expression bool(B::value) is a valid constant expression Helper variable template template<class…
std::negate<void> – std::negate<void> Synopsis Defined in header<functional> template <> (since C++ 14) class negate<void>; std::negate<> is a specialization of std::negate with parameter and return type deduced. Member types Member type Definition is_transparent /* unspecified */ Member functions returns its negated argument operator() (public member function) std::negate<>::operator() template< class T > constexpr auto operator()( T&& arg…
std::nearbyint,std::nearbyintf,std::nearbyintl – std::nearbyint,std::nearbyintf,std::nearbyintl Synopsis Defined in header <cmath> float nearbyint ( float arg ); (1) (since C++11) float nearbyintf( float arg ); double nearbyint ( double arg ); (2) (since C++11) long double nearbyint ( long double arg ); (3) (since C++11) long double nearbyintl( long double arg ); double nearbyint ( IntegralType arg );…
std::nan,std::nanf,std::nanl – std::nan,std::nanf,std::nanl Synopsis Defined in header <cmath> float nanf( const char* arg ); (since C++11) double nan( const char* arg ); (since C++11) long double nanl( const char* arg ); (since C++11) Converts the implementation-defined character string arg into the corresponding quiet NaN value, as if by calling std::strtod, std::strtof, or std::strtold, respectively, as…
std::mutex::unlock – std::mutex::unlock Synopsis void unlock(); (since C++ 11) Unlocks the mutex. The mutex must be locked by the current thread of execution, otherwise, the behavior is undefined. This operation synchronizes-with (as defined in std::memory_order) any subsequent lock operation that obtains ownership of the same mutex. Parameters (none) Return value (none) Exceptions (none) Notes unlock()…
std::mutex::try_lock – std::mutex::try_lock Synopsis bool try_lock(); (since C++11) Tries to lock the mutex. Returns immediately. On successful lock acquisition returns true, otherwise returns false. This function is allowed to fail spuriously and return false even if the mutex is not currently locked by any other thread. If try_lock is called by a thread that already…
std::mutex::native_handle – std::mutex::native_handle Synopsis native_handle_type native_handle(); (since C++11) (optional) Returns the underlying implementation-defined native handle object. Parameters (none) Return value Implementation-defined native handle object. Exceptions Implementation-defined. Example This section is incomplete Reason: no example
std::mutex::~mutex – std::mutex::~mutex Synopsis ~mutex(); Destroys the mutex. The behavior is undefined if the mutex is owned by any thread or if any thread terminates while holding any ownership of the mutex. See also
std::mutex::lock – std::mutex::lock Synopsis void lock(); (since C++ 11) Locks the mutex. If another thread has already locked the mutex, a call to lock will block execution until the lock is acquired. If lock is called by a thread that already owns the mutex, the behavior is undefined: for example, the program may deadlock. An…
std::mutex – std::mutex Synopsis Defined in header <mutex> class mutex; (since C++11) The mutex class is a synchronization primitive that can be used to protect shared data from being simultaneously accessed by multiple threads. mutex offers exclusive, non-recursive ownership semantics: * A calling thread owns a mutex from the time that it successfully calls either…
std::multiset<Key,Compare,Allocator>::~multiset – std::multiset<Key,Compare,Allocator>::~multiset Synopsis ~multiset(); Destructs the container. The destructors of the elements are called and the used storage is deallocated. Note, that if the elements are pointers, the pointed-to objects are not destroyed. Complexity Linear in the size of the container.
std::multiplies<void> – std::multiplies<void> Synopsis Defined in header<functional> template <> (since C++ 14) class multiplies<void>; std::multiplies<> is a specialization of std::multiplies with parameter and return type deduced. Member types Member type Definition is_transparent /* unspecified */ Member functions returns the product of two arguments operator() (public member function) std::multiplies<>::operator() template< class T, class U> constexpr auto…
std::multimap<Key,T,Compare,Allocator>::~multimap – std::multimap<Key,T,Compare,Allocator>::~multimap Synopsis ~multimap(); Destructs the container. The destructors of the elements are called and the used storage is deallocated. Note, that if the elements are pointers, the pointed-to objects are not destroyed. Complexity Linear in the size of the container.
std::move_iterator<Iter>::operator[] – std::move_iterator<Iter>::operator[] Synopsis /*unspecified*/ operator[]( difference_type n ) const; (since C++11) (until C++17) constexpr /*unspecified*/ operator[]( difference_type n ) const; (since C++17) Returns a reference to the element at specified relative location. Parameters n – position relative to current location. Return value An rvalue reference to the element at relative location, that is, std::move(base()[n])….
std::move_iterator<Iter>::move_iterator – std::move_iterator<Iter>::move_iterator Synopsis move_iterator(); (until C++ 17) constexpr move_iterator(); (since C++ 17) explicit move_iterator(iterator_type x); (until C++ 17) constexpr explicit move_iterator(iterator_type x); (1)(since C++ 17) template <class U> (2)(until C++ 17) move_iterator(const move_iterator<U> &other); (3) template <class U> (since C++ 17) constexpr move_iterator(const move_iterator<U> &other); Constructs a new iterator adaptor. 1) Default constructor. The…
std::move_iterator<Iter>::base – std::move_iterator<Iter>::base Synopsis iterator_type base() const; (until C++17) constexpr iterator_type base() const; (since C++17) Returns the underlying base iterator. Parameters (none) Return value The underlying iterator. Exceptions (none) Example This section is incomplete Reason: no example See also operator* operator-> accesses the pointed-to element (public member function) (deprecated in C++20)
std::move_iterator – std::move_iterator Synopsis Defined in header <iterator> template< class Iter > (since C++11) class move_iterator; std::move_iterator is an iterator adaptor which behaves exactly like the underlying iterator (which must be at least an LegacyInputIterator), except that dereferencing converts the value returned by the underlying iterator into an rvalue. If this iterator is used as…
std::move_if_noexcept – std::move_if_noexcept Synopsis Defined in header<utility> template <class T> typename std::conditional< !std::is_nothrow_move_constructible<T>::value && std::is_copy_constructible<T>::value, (since C++ 11) const T &, (until C++ 14) T && >::type move_if_noexcept(T &x) noexcept; template <class T> constexpr typename std::conditional< !std::is_nothrow_move_constructible<T>::value && std::is_copy_constructible<T>::value, (since C++ 14) const T &, T && >::type move_if_noexcept(T &x) noexcept; move_if_noexcept obtains an rvalue…
std::move_backward – std::move_backward Synopsis Defined in header <algorithm> template< class BidirIt1, class BidirIt2 > (since C++11) BidirIt2 move_backward( BidirIt1 first, BidirIt1 last, BidirIt2 d_last ); (until C++20) template< class BidirIt1, class BidirIt2 > (since C++20) constexpr BidirIt2 move_backward( BidirIt1 first, BidirIt1 last, BidirIt2 d_last ); Moves the elements from the range [first, last), to another…
std::move – std::move Synopsis Defined in header <utility> template< class T > (since C++11) typename std::remove_reference<T>::type&& move( T&& t ) noexcept; (until C++14) template< class T > (since C++14) constexpr typename std::remove_reference<T>::type&& move( T&& t ) noexcept; std::move is used to indicate that an object t may be "moved from", i.e. allowing the efficient transfer…