Unigine::AtomicInteger Class

AtomicInteger Class

Members

---

AtomicInteger ( ) #

Default constructor.

AtomicInteger ( Type v ) #

Constructor. Initializes the value by copying the binary representation of the provided value.

Arguments

• Type v - Initial value.

AtomicInteger ( const AtomicInteger& v ) #

Copy constructor. Initializes the object by copying the raw value from another atomic object, ensuring atomic consistency.

Arguments

• const AtomicInteger& v

Type operator Type() ( ) const#

Implicitly converts the AtomicInteger object to a value of type Type. Internally calls fetch() to return a thread-safe snapshot of the current value.

Return value

Returns copy of the current value.

RawType & getUnsafeRawValue ( ) #

Provides direct, non-synchronized access to the internal raw value. Calling this bypasses all thread safety and must only be used when external synchronization is guaranteed by the caller.

Return value

Returns a reference to the internal raw value.

const RawType & getUnsafeRawValue ( ) const#

Const-qualified version of getUnsafeRawValue(). Provides read-only, non-thread-safe access to the stored value.

Return value

Returns a const reference to the internal raw value.

RawType * getRawValuePtr ( ) #

Returns a pointer to the internal raw value.

Return value

Returns a pointer to the internal raw value.

const RawType * getRawValuePtr ( ) const#

Const-qualified version of getRawValuePtr(). Provides read-only, non-thread-safe access to the stored value.

Return value

Returns a const pointer to the internal raw value.

Type & getUnsafeValue ( ) #

Provides direct, non-synchronized access to the internal logical value, reinterpreted from the raw data. Unsafe in multithreaded contexts unless externally synchronized.

Return value

Returns non-thread-safe reference to the stored value.

const Type & getUnsafeValue ( ) const#

Const-qualified version of getUnsafeValue(). Provides read-only, non-thread-safe access to the stored value.

Return value

Returns non-thread-safe const reference to the stored value.

Type * getValuePtr ( ) #

Returns a raw pointer to the internal value, reinterpreted from the raw data. Unsafe in multithreaded contexts unless externally synchronized.

Return value

Returns pointer to the internal value.

const Type * getValuePtr ( ) const#

Const-qualified version of getValuePtr(). Provides read-only, non-thread-safe access to the stored value.

Return value

Returns const pointer to the internal value.

auto fetch ( ) const#

Retrieves the current value in a lock-free, thread-safe manner. Performs an atomic read of the raw internal storage and reinterprets the result.

Return value

Returns copy of the stored value.

void store ( Type v ) #

Stores a new value by writing its raw binary representation atomically into internal storage. Ensures thread-safe write access without locks.

Arguments

• Type v - The new value to store.

Type operator= ( Type v ) #

Copy assignment operator. Stores the new value atomically by calling store().

Arguments

• Type v - The new value to assign.

Return value

Returns the assigned value.

Type operator= ( const AtomicInteger& v ) #

Copy assignment operator. Atomically replaces the internal value with the one from another atomic object.

Arguments

• const AtomicInteger& v - Another atomic to copy from.

Return value

Returns the copied value.

Type swap ( Type v ) #

Atomically replaces the current value with a new one and returns the old value.

Arguments

• Type v - The new value to set.

Return value

Returns the value that was stored before swap.

bool compareAndSwap ( Type old_value, Type new_value ) #

Performs a lock-free compare-and-swap operation. If the current value equals old_value, it is replaced with new_value.

Arguments

• Type old_value - Expected current value.
• Type new_value - New value to assign if the current matches the expected.

Return value

Returns true if the internal value was updated; false if the current value did not match old_value.

void spinLock ( Type old_value, Type new_value ) #

Continuously attempts to atomically swap the value from old_value to new_value using compareAndSwap().

Arguments

• Type old_value - Expected current value.
• Type new_value - New value to assign if the current matches the expected.

void waitValue ( Type v ) #

Blocks the current thread in a spin loop until the internal value becomes equal to the provided one. Internally calls spinLock(v, v) and rechecks after each failure.

Arguments

• Type v - The value to wait for.

Type fetchAdd ( Type v ) #

Atomically adds value to the current atomic value and returns the previous value.

Arguments

• Type v - The value to add.

Return value

Returns the value held before the addition.

Type fetchSub ( Type v ) #

Atomically subtracts value from the current atomic value and returns the previous value.

Arguments

• Type v - The value to subtract.

Return value

Returns the value held before the subtraction.

Type fetchAnd ( Type v ) #

Atomically performs a bitwise AND with value and returns the previous value.

Arguments

• Type v - The value to AND with.

Return value

Returns the value before the operation.

Type fetchOr ( Type v ) #

Atomically performs a bitwise OR with value and returns the previous value.

Arguments

• Type v - The value to OR with.

Return value

Returns the value before the operation.

Type fetchXor ( Type v ) #

Atomically performs a bitwise XOR with value and returns the previous value.

Arguments

• Type v - The value to XOR with.

Return value

Returns the value before the operation.

Type fetchInc ( ) #

Atomically increments the current value by 1.

Return value

The value held before the increment.

Type fetchDec ( ) #

Atomically decrements the current value by 1.

Return value

The value held before the decrement.

Type operator+= ( Type v ) #

Atomically adds value to the current value and returns the result after the addition.

Arguments

• Type v - The value to add.

Return value

The updated value after the addition.

Type operator-= ( Type v ) #

Atomically subtracts value from the current value and returns the result after the subtraction.

Arguments

• Type v - The value to subtract.

Return value

The updated value after the subtraction.

Type operator++ ( int ) #

Postfix increment. Atomically increments the current value by 1.

Arguments

• int - dummy parameter to distinguish from the prefix version.

Return value

The value before the increment.

Type operator-- ( int ) #

Postfix decrement. Atomically decrements the current value by 1.

Arguments

• int - dummy parameter to distinguish from the prefix version.

Return value

The value before the decrement.

Type operator++ ( ) #

Prefix increment. Atomically increments the current value by 1.

Return value

The value after the increment.

Type operator-- ( ) #

Prefix decrement. Atomically decrements the current value by 1.

Return value

The value after the decrement.

Type operator&= ( Type v ) #

Atomically performs a bitwise AND with value and updates the current value.

Arguments

• Type v - The value to AND with.

Return value

The updated value after the operation.

Type operator|= ( Type v ) #

Atomically performs a bitwise OR with value and updates the current value.

Arguments

• Type v - The value to OR with.

Return value

The updated value after the operation.

Type operator^= ( Type v ) #

Atomically performs a bitwise XOR with value and updates the current value.

Arguments

• Type v - The value to XOR with.

Return value

The updated value after the operation.