libMesh::Threads::atomic< T > Class Template Reference

Defines atomic operations which can only be executed on a single thread at a time. More...

#include <threads_none.h>

Inheritance diagram for libMesh::Threads::atomic< T >:

Public Member Functions
	atomic ()
	operator T& ()
	atomic ()
	operator T ()
T	operator= (T value)
atomic< T > &	operator= (const atomic< T > &value)
T	operator+= (T value)
T	operator-= (T value)
T	operator++ ()
T	operator++ (int)
T	operator-- ()
T	operator-- (int)
	atomic ()

Private Attributes
T	_val
T	val
spin_mutex	smutex

Detailed Description

template<typename T>
class libMesh::Threads::atomic< T >

Defines atomic operations which can only be executed on a single thread at a time.

This is used in reference counting, for example, to allow count++/count– to work.

Legacy TBB: inherits tbb::atomic<T>. oneTBB: tbb::atomic was removed; inherits std::atomic<T> instead.

Definition at line 188 of file threads_none.h.

Constructor & Destructor Documentation

atomic() [1/3]

template<typename T >

libMesh::Threads::atomic< T >::atomic ( )

inline

Definition at line 191 of file threads_none.h.

: _val(0) {}

atomic() [2/3]

template<typename T >

libMesh::Threads::atomic< T >::atomic ( )

inline

Definition at line 485 of file threads_pthread.h.

: val(0) {}

atomic() [3/3]

template<typename T >

libMesh::Threads::atomic< T >::atomic ( )

inline

Definition at line 330 of file threads_tbb.h.

: std::atomic<T>(0) {}

Member Function Documentation

operator T()

template<typename T >

libMesh::Threads::atomic< T >::operator T ( )

inline

Definition at line 486 of file threads_pthread.h.

{ return val; }

References libMesh::Threads::atomic< T >::val.

operator T&()

template<typename T >

libMesh::Threads::atomic< T >::operator T& ( )

inline

Definition at line 192 of file threads_none.h.

{ return _val; }

References libMesh::Threads::atomic< T >::_val.

operator++() [1/2]

template<typename T >

T libMesh::Threads::atomic< T >::operator++ ( )

inline

Definition at line 517 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val++;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, and libMesh::Threads::atomic< T >::val.

operator++() [2/2]

template<typename T >

T libMesh::Threads::atomic< T >::operator++ ( int  )

inline

Definition at line 524 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val++;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, and libMesh::Threads::atomic< T >::val.

operator+=()

template<typename T >

T libMesh::Threads::atomic< T >::operator+= ( T  value )

inline

Definition at line 503 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val += value;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, libMesh::Threads::atomic< T >::val, and value.

operator--() [1/2]

template<typename T >

T libMesh::Threads::atomic< T >::operator-- ( )

inline

Definition at line 531 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val--;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, and libMesh::Threads::atomic< T >::val.

operator--() [2/2]

template<typename T >

T libMesh::Threads::atomic< T >::operator-- ( int  )

inline

Definition at line 538 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val--;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, and libMesh::Threads::atomic< T >::val.

operator-=()

template<typename T >

T libMesh::Threads::atomic< T >::operator-= ( T  value )

inline

Definition at line 510 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val -= value;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, libMesh::Threads::atomic< T >::val, and value.

operator=() [1/2]

template<typename T >

atomic< T > & libMesh::Threads::atomic< T >::operator= ( const atomic< T > &  value )

inline

Definition at line 495 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val = value;
    return *this;
  }

References libMesh::Threads::atomic< T >::smutex, libMesh::Threads::atomic< T >::val, and value.

operator=() [2/2]

template<typename T >

T libMesh::Threads::atomic< T >::operator= ( T  value )

inline

Definition at line 488 of file threads_pthread.h.

  {
    spin_mutex::scoped_lock lock(smutex);
    val = value;
    return val;
  }

References libMesh::Threads::atomic< T >::smutex, libMesh::Threads::atomic< T >::val, and value.

Member Data Documentation

_val

template<typename T >

T libMesh::Threads::atomic< T >::_val

private

Definition at line 194 of file threads_none.h.

Referenced by libMesh::Threads::atomic< T >::operator T&().

smutex

template<typename T >

spin_mutex libMesh::Threads::atomic< T >::smutex

private

Definition at line 547 of file threads_pthread.h.

Referenced by libMesh::Threads::atomic< T >::operator++(), libMesh::Threads::atomic< T >::operator++(), libMesh::Threads::atomic< T >::operator+=(), libMesh::Threads::atomic< T >::operator--(), libMesh::Threads::atomic< T >::operator--(), libMesh::Threads::atomic< T >::operator-=(), libMesh::Threads::atomic< T >::operator=(), and libMesh::Threads::atomic< T >::operator=().

val

template<typename T >

T libMesh::Threads::atomic< T >::val

private

Definition at line 546 of file threads_pthread.h.

Referenced by libMesh::Threads::atomic< T >::operator T(), libMesh::Threads::atomic< T >::operator++(), libMesh::Threads::atomic< T >::operator++(), libMesh::Threads::atomic< T >::operator+=(), libMesh::Threads::atomic< T >::operator--(), libMesh::Threads::atomic< T >::operator--(), libMesh::Threads::atomic< T >::operator-=(), libMesh::Threads::atomic< T >::operator=(), and libMesh::Threads::atomic< T >::operator=().

---

The documentation for this class was generated from the following files:

• include/parallel/threads_none.h
• include/parallel/threads_pthread.h
• include/parallel/threads_tbb.h