Section 3: library functions
std::experimental::nullopt – std::experimental::nullopt Synopsis Defined in header <experimental/optional> constexpr nullopt_t nullopt{/*unspecified*/}; (library fundamentals TS) std::experimental::nullopt is a constant of type std::experimental::nullopt_t that is used to indicate optional type with uninitialized state. See also nullopt_t indicator of optional type with uninitialized state (class) (library fundamentals TS)
std::experimental::not_fn – std::experimental::not_fn Synopsis Defined in header <experimental/functional> template< class F> (library fundamentals TS v2) /*unspecified*/ not_fn( F&& f ); Creates a forwarding call wrapper that returns the complement of the callable object it holds. Parameters f – the object from which the Callable object held by the wrapper is constructed Return value Let FD…
std::experimental::nonesuch – std::experimental::nonesuch Synopsis Defined in header<experimental / type_traits> struct nonesuch { ~nonesuch() = delete; nonesuch(nonesuch const &) = delete; (library fundamentals TS v2) void operator=(nonesuch const &) = delete; }; std::experimental::nonesuch is a class type used by std::experimental::detected_t to indicate detection failure. nonesuch has no default constructor or initializer-list constructor, and is not an…
std::experimental::negation – std::experimental::negation Synopsis Defined in header<experimental / type_traits> template <class B> (1)(library fundamentals TS v2) struct negation; Forms the logical negation of the type trait B. The type negation<B> is a UnaryTypeTrait with a BaseCharacteristic of std::integral_constant<bool, !bool(B::value)>. Template parameters B – any type such that the expression bool(B::value) is a valid constant expression…
std::experimental::minmax – std::experimental::minmax Synopsis Defined in header<experimental / simd> template <class T, class Abi> std::pair<simd<T, Abi>, simd<T, Abi>> minmax(const simd<T, Abi> &a, const simd<T, Abi> &b) noexcept; Returns both the element-wise min result and element-wise max result. Parameters a – the first vector of elements for minmax b – the second vector of elements for…
std::experimental::min – std::experimental::min Synopsis Defined in header<experimental / simd> template <class T, class Abi> simd<T, Abi> min(const simd<T, Abi> &a, const simd<T, Abi> &b) noexcept; Parameters a – the first vector of elements for min b – the second vector of elements for min Return value The result of binary element-wise application of std::min(a[i], b[i])…
std::experimental::max – std::experimental::max Synopsis Defined in header<experimental / simd> template <class T, class Abi> simd<T, Abi> max(const simd<T, Abi> &a, const simd<T, Abi> &b) noexcept; Parameters a – the first vector of elements for max b – the second vector of elements for max Return value The result of binary element-wise application of std::max(a[i], b[i])…
std::experimental::make_ready_future – std::experimental::make_ready_future Synopsis Defined in header <experimental/future> template < class T > (1) (concurrency TS) future<V /* see below */> make_ready_future(T&& value); future<void> make_ready_future(); (2) (concurrency TS) 1) If std::decay_t<T> is std::reference_wrapper<X>, then the type V is X&, otherwise, V is std::decay_t<T>. Creates a shared state of type V that is immediately ready, with…
std::experimental::make_ostream_joiner – std::experimental::make_ostream_joiner Synopsis Defined in header <experimental/iterator> template <class charT, class traits, class DelimT> std::experimental::ostream_joiner<std::decay_t<DelimT>, charT, traits> (library fundamentals TS v2) make_ostream_joiner(std::basic_ostream<charT, traits>& os, DelimT&& delimiter); Creates an ostream_joiner object, deducing the template arguments from the types of the function arguments. Parameters os – the basic_ostream object that the iterator is to be associated…
std::experimental::make_optional – std::experimental::make_optional Synopsis Defined in header <experimental/optional> template< class T > constexpr optional<typename std::decay<T>::type> (library fundamentals TS) make_optional( T&& value ); Creates an optional object from value. Effectively calls optional<typename std::decay<T>::type>(std::forward<T>(value)) Parameters value – the value to construct optional object with Return value An optional object with value as the contained value. Exceptions Throws…
std::experimental::make_observer – std::experimental::make_observer Synopsis Defined in header <experimental/memory> template <class W> (library fundamentals TS v2) std::experimental::observer_ptr<W> make_observer(W* p) noexcept; Creates an observer_ptr object, deducing the template argument from the type of the function argument. Parameters p – pointer to the object to be watched by the observer_ptr object Return value A observer_ptr object, created as…
std::experimental::make_exceptional_future – std::experimental::make_exceptional_future Synopsis Defined in header<experimental / future> template <class T> (1)(concurrency TS) future<T> make_exceptional_future(std::exception_ptr ex); template <class T, class E> (2)(concurrency TS) future<T> make_exceptional_future(E ex); 1) Creates a shared state of type T that is immediately ready and stores the exception pointer ex, then return a future associated with that shared state, as…
std::experimental::make_array – std::experimental::make_array Synopsis Defined in header<experimental / array> template <class D = void, class… Types> (library fundamentals TS v2) constexpr std::array<VT /* see below */, sizeof…(Types)> make_array(Types &&…t); Creates a std::array whose size is equal to the number of arguments and whose elements are initialized from the corresponding arguments. Returns std::array<VT, sizeof…(Types)>{std::forward<Types>(t)…} If D…
std::experimental::lcm – std::experimental::lcm Synopsis Defined in header <experimental/numeric> template< class M, class N> (library fundamentals TS v2) constexpr std::common_type_t<M, N> lcm(M m, N n); Computes the least common multiple of the integers m and n. Parameters m, n – integer values Return value If either m or n is zero, returns zero. Otherwise, return the…
std::experimental::latch::wait – std::experimental::latch::wait Synopsis void wait() const; (1)(concurrency TS) Blocks the calling thread until the internal counter reaches 0. If it is zero already, returns immediately. Parameters (none) Return value (none) Exceptions Throws nothing.
std::experimental::latch::~latch – std::experimental::latch::~latch Synopsis ~latch(); (concurrency TS) Destroys the latch. The behavior is undefined if a thread is blocked at the synchronization point. The destructor may be called even if not all threads have returned from wait() or count_down_and_wait(), provided the internal counter must equal zero. The destructor may block until all threads have returned…
std::experimental::latch::is_ready – std::experimental::latch::is_ready Synopsis bool is_ready() const noexcept; (1) (concurrency TS) Returns true if the internal counter equals zero. Parameters (none) Return value true if the internal counter of *this latch equals zero.
std::experimental::latch::count_down_and_wait – std::experimental::latch::count_down_and_wait Synopsis void count_down_and_wait(); (1)(concurrency TS) Atomically decrements the internal counter by 1 and (if necessary) blocks the calling thread until the counter reaches zero. The behavior is undefined if the internal counter is already zero. This operation synchronizes_with all calls that block on this latch and all is_ready calls on this latch…
std::experimental::latch::count_down – std::experimental::latch::count_down Synopsis void count_down(ptrdiff_t n = 1); (1)(concurrency TS) Atomically decrements the internal counter by n without blocking the caller. If n is greater than the value of the internal counter or is negative, the behavior is undefined. This operation synchronizes_with all calls that block on this latch and all is_ready calls on…
std::experimental::latch – std::experimental::latch Synopsis Defined in header <experimental/latch> class latch; (concurrency TS) The latch class is a downward counter of type ptrdiff_t which can be used to synchronize threads. The value of the counter is initialized on creation. Threads may block on the latch until the counter is decremented to zero. There is no possibility…