Skip to content

Search topics & cppreference

Search all study topics, concept maps, and 6,587 C++ and C reference pages.

std::atomic_init

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.

atomic
  • C++11
  • C++20
1 min readView on cppreference
NotebookLM
Defined in header <atomic>
template< class T >
void atomic_init
    ( std::atomic<T>* obj,
      typename std::atomic<T>::value_type desired ) noexcept;
(1) (since C++11)
(deprecated in C++20)
template< class T >
void atomic_init
    ( volatile std::atomic<T>* obj,
      typename std::atomic<T>::value_type desired ) noexcept;
(2) (since C++11)
(deprecated in C++20)

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, or 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 was required because
T was deduced from multiple arguments
T is only deduced
from obj

See also

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

Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.