[#BloombergLP-bsls-AtomicOperations_DefaultInt-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::AtomicOperations_DefaultInt
:relfileprefix: ../../
:mrdocs:

Default implementations of non‐essential 32‐bit integer atomic operations.

== Synopsis

Declared in `<bsls_atomicoperations_default.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class IMP>
struct AtomicOperations_DefaultInt;
----

== Description

This class provides default implementations of non‐essential atomic operations for the 32‐bit integer type independent on any specific platform. It also provides prototypes for the atomic operations for the 32‐bit integer type that have to be implemented separately for each specific platform. These platform‐independent and platform‐specific atomic operations together form a full set of atomic operations for the 32‐bit integer type.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/AtomicTypes.adoc[`AtomicTypes`] 
| This `typedef` is an alias to `Atomic_TypeTraits<IMP>`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/addInt.adoc[`addInt`] 
| Atomically add to the specified `atomicInt` the specified `value`, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/addIntAcqRel.adoc[`addIntAcqRel`] 
| Atomically add to the specified `atomicInt` the specified `value`, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/addIntNvAcqRel.adoc[`addIntNvAcqRel`] 
| Atomically add to the specified `atomicInt` the specified `value` and return the resulting value, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/addIntNvRelaxed.adoc[`addIntNvRelaxed`] 
| Atomically add to the specified `atomicInt` the specified `value` and return the resulting value, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/addIntRelaxed.adoc[`addIntRelaxed`] 
| Atomically add to the specified `atomicInt` the specified `value`, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/decrementInt.adoc[`decrementInt`] 
| Atomically decrement the value of the specified `atomicInt` by 1, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/decrementIntAcqRel.adoc[`decrementIntAcqRel`] 
| Atomically decrement the value of the specified `atomicInt` by 1, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/decrementIntNv.adoc[`decrementIntNv`] 
| Atomically decrement the specified `atomicInt` by 1 and return the resulting value, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/decrementIntNvAcqRel.adoc[`decrementIntNvAcqRel`] 
| Atomically decrement the specified `atomicInt` by 1 and return the resulting value, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/getIntAcquire.adoc[`getIntAcquire`] 
| Atomically retrieve the value of the specified `atomicInt`, providing the acquire memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/getIntRelaxed.adoc[`getIntRelaxed`] 
| Atomically retrieve the value of the specified `atomicInt`, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/incrementInt.adoc[`incrementInt`] 
| Atomically increment the value of the specified `atomicInt` by 1, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/incrementIntAcqRel.adoc[`incrementIntAcqRel`] 
| Atomically increment the value of the specified `atomicInt` by 1, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/incrementIntNv.adoc[`incrementIntNv`] 
| Atomically increment the specified `atomicInt` by 1 and return the resulting value, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/incrementIntNvAcqRel.adoc[`incrementIntNvAcqRel`] 
| Atomically increment the specified `atomicInt` by 1 and return the resulting value, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/initInt.adoc[`initInt`] 
| Initialize the specified `atomicInt` and set its value to the optionally specified `initialValue`.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/setIntRelaxed.adoc[`setIntRelaxed`] 
| Atomically set the value of the specified `atomicInt` to the specified `value`, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/setIntRelease.adoc[`setIntRelease`] 
| Atomically set the value of the specified `atomicInt` to the specified `value`, providing the release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/subtractIntNv.adoc[`subtractIntNv`] 
| Atomically subtract `value` from `atomicInt` and return the result.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/subtractIntNvAcqRel.adoc[`subtractIntNvAcqRel`] 
| Atomically subtract from the specified `atomicInt` the specified `value` and return the resulting value, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/subtractIntNvRelaxed.adoc[`subtractIntNvRelaxed`] 
| Atomically subtract from the specified `atomicInt` the specified `value` and return the resulting value, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/swapIntAcqRel.adoc[`swapIntAcqRel`] 
| Atomically swap `atomicInt` with acquire/release ordering.
| xref:BloombergLP/bsls/AtomicOperations_DefaultInt-08/testAndSwapIntAcqRel.adoc[`testAndSwapIntAcqRel`] 
| Conditionally swap `atomicInt` with acquire/release ordering.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_Default32.adoc[`AtomicOperations_Default32`] 
| Default atomic operations for a generic 32‐bit platform.
| xref:BloombergLP/bsls/AtomicOperations_Default64-0b.adoc[`AtomicOperations_Default64`] 
| Default atomic operations for a generic 64‐bit platform.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#