NAME

std::atomic_init - std::atomic_init

Synopsis

Defined in header <atomic>
template< class T >
(since C++11)
void atomic_init( std::atomic<T>* obj, (deprecated in C++20)

typename std::atomic<T>::value_type desired ) noexcept;
template< class T >
(since C++11)
void atomic_init( volatile std::atomic<T>* obj, (deprecated in C++20)

typename std::atomic<T>::value_type desired ) noexcept;

Initializes the default-constructed atomic object obj with the value desired. The
function is not atomic: concurrent access from another thread, even through an
atomic operation, is a data race.

If obj was not default-constructed, the behavior is undefined.

If this function is called twice on the same obj, the behavior is undefined.

Parameters

obj - pointer to an atomic object to initialize
desired - the value to initialize atomic object with

Return value

(none)

Notes

This function is provided for compatibility with C. If the compatibility is not
required, std::atomic may be initialized through their non-default constructors.

Example

This section is incomplete
Reason: no example

Defect reports

The following behavior-changing defect reports were applied retroactively to
previously published C++ standards.

DR Applied to Behavior as published Correct behavior
P0558R1 C++11 exact type match required because T is T is deduced from the
deduced from multiple arguments atomic argument only

See also

ATOMIC_VAR_INIT constant initialization of an atomic variable of static
(C++11)(deprecated in C++20) storage duration
(function macro)
constructor constructs an atomic object
(public member function of std::atomic<T>)