AtomicValue.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
 
#include <agx/config/AGX_DEBUG_SYNCHRONIZATION_OVERHEAD_TESTING.h>
#include <agx/Integer.h>
#include <ostream>
#include <atomic>
 
namespace agx
{
 
  template< class T >
  class AtomicValueT
  {
  public:
    explicit AtomicValueT(T initialValue = 0);
 
    AtomicValueT( const agx::AtomicValueT<T>& av );
 
    AtomicValueT<T>& operator=(const agx::AtomicValueT<T>& rhs );
 
    inline T get() const;
 
    inline T set(T value);
 
    inline AtomicValueT<T>& operator= (T value);
 
    inline T add(T value);
 
    inline T sub(T value);
 
    inline T inc();
 
    inline T dec();
 
    inline T compareAndSet(T test, T newValue);
 
  private:
    #if !AGX_DEBUG_SYNCHRONIZATION_OVERHEAD_TESTING()
    std::atomic< T > m_value;
    #else
    T m_value;
    #endif
  };
 
 
  using AtomicValue = AtomicValueT<agx::Int32>;
 
 
 
  // -----------------------------------------------------------------------------------------------
  template<class T>
  inline std::ostream& operator << ( std::ostream& stream, const AtomicValueT<T>& value )
  {
    stream << value.get();
    return stream;
  }
 
  /* Implementation */
 
  #if !(defined(AGX_APPLE_IOS) || (AGX_DEBUG_SYNCHRONIZATION_OVERHEAD_TESTING()))
 
  template<class T>
  inline AtomicValueT<T>::AtomicValueT(T initialValue) : m_value(initialValue)
  {
  }
 
  template<class T>
  inline AtomicValueT<T>::AtomicValueT( const agx::AtomicValueT<T>& av )
  {
    m_value.store( av.m_value.load() );
  }
 
  template<class T>
  inline AtomicValueT<T>& AtomicValueT<T>::operator=(const agx::AtomicValueT<T>& rhs )
  {
    m_value.store( rhs.m_value.load() );
    return *this;
  }
 
  template<class T>
  inline T AtomicValueT<T>::get() const
  {
    return m_value;
  }
 
  template<class T>
  inline T AtomicValueT<T>::set(T value)
  {
    return m_value.exchange( value );
  }
 
  template<class T>
  inline AtomicValueT<T>& AtomicValueT<T>::operator=(T value)
  {
    m_value = value;
    return *this;
  }
 
 
  template<class T>
  inline T AtomicValueT<T>::add(T value)
  {
    return m_value.fetch_add( value );
  }
 
  template<class T>
  inline T AtomicValueT<T>::sub(T value)
  {
    return m_value.fetch_sub( value );
  }
 
  template<class T>
  inline T AtomicValueT<T>::inc()
  {
    return m_value.fetch_add( 1 );
  }
 
  template<class T>
  inline T AtomicValueT<T>::dec()
  {
    return m_value.fetch_sub( 1 );
  }
 
  template<class T>
  inline T AtomicValueT<T>::compareAndSet(T test, T newValue)
  {
    return m_value.compare_exchange_strong( test, newValue );
  }
 
  #else
  template<class T>
  inline AtomicValueT<T>::AtomicValueT(T initialValue) : m_value(initialValue)
  {
  }
 
  template<class T>
  inline AtomicValueT<T>::AtomicValueT( const agx::AtomicValueT<T>& av )
  {
    m_value = av.m_value;
  }
 
  template<class T>
  AtomicValueT<T>& AtomicValueT<T>::operator=(const agx::AtomicValueT<T>& rhs )
  {
    m_value = rhs.m_value;
    return *this;
  }
 
  template<class T>
  inline T AtomicValueT<T>::get() const
  {
    return m_value;
  }
 
  template<class T>
  inline T AtomicValueT<T>::set(T value)
  {
    T prev = m_value;
    m_value = value;
 
    return prev;
  }
 
  template<class T>
  inline AtomicValueT<T>& AtomicValueT<T>::operator=(T value)
  {
    m_value = value;
    return *this;
  }
 
 
  template<class T>
  inline T AtomicValueT<T>::add(T value)
  {
    T prev = m_value;
    m_value += value;
 
    return prev;
  }
 
  template<class T>
  inline T AtomicValueT<T>::sub(T value)
  {
    T prev = m_value;
    m_value -= value;
 
 
    return prev;
  }
 
  template<class T>
  inline T AtomicValueT<T>::inc()
  {
    return this->add(1);
  }
 
  template<class T>
  inline T AtomicValueT<T>::dec()
  {
    return this->add(-1);
  }
 
  template<class T>
  inline T AtomicValueT<T>::compareAndSet(T test, T newValue)
  {
    T prev = m_value;
    if (m_value == test)
      m_value = newValue;
 
    return prev;
  }
 
  #endif
}