std::atomic_ref<T>:: fetch_min

From cppreference.com
C++
Concurrency support library
Threads
(C++11)
(C++20)
(C++17) (C++17)
this_thread namespace
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
Generic lock management
Condition variables
(C++11)
(C++11)
(C++11)
(C++11)
Semaphores
(C++20) (C++20)
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
Hazard Pointers
(C++26)
(C++26)
(C++26)
Atomic types
(C++11)
(C++20)
(C++11)
Initialization of atomic types
(C++11) (deprecated in C++20)
(C++11) (deprecated in C++20)
(C++11)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
Free functions for atomic operations
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11) (C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++26) (C++26)
(C++26) (C++26)
(C++11)
(C++20) (C++20)
(C++20)
(C++20)
Free functions for atomic flags
(C++11) (C++11)
(C++11) (C++11)
(C++20) (C++20)
(C++20) (C++20)
(C++20)
(C++20)
std::atomic_ref
Member functions
(C++26)
Constants
Specialized member functions
Specialized for integral,
floating-point and pointer types
Specialized for integral and
pointer types only
(C++26)
atomic_ref::fetch_min
(C++26)
Specialized for integral types only
member only of atomic_ref< Integral  > specializations
T fetch_min ( T arg, std:: memory_order order =
std:: memory_order_seq_cst ) const noexcept ;
(1) (since C++26)
member only of atomic_ref<T*> partial specialization
T * fetch_min ( T * arg, std:: memory_order order =
std:: memory_order_seq_cst ) const noexcept ;
(2) (since C++26)

Atomically replaces the current value of the referenced object with the result of std::min of the value and arg . That is, it performs atomic minimum operation. The operation is a read-modify-write operation. Memory is affected according to the value of order .

2) If the pointers point to different complete objects (or subobjects thereof), pointer comparison does not establish a strict weak ordering .

Parameters

arg - the other argument of std::min
order - memory order constraints to enforce

Return value

The value immediately preceding the effects of this function in the modification order of * this .

Notes

Feature-test macro Value Std Feature
__cpp_lib_atomic_min_max 202403L (C++26) Atomic minimum/maximum

Example

This section is incomplete
Reason: no example
Retrieved from " https://en.cppreference.com/mwiki/index.php?title=cpp/atomic/atomic_ref/fetch_min&oldid=171421 "