dash::Comutex Class Reference

A fortran style comutex. More...

#include <Comutex.h>

Public Types
using	iterator = typename _storage_type::iterator
using	const_iterator = typename _storage_type::const_iterator
using	reference = typename _storage_type::reference
using	size_type = typename _storage_type::size_type

Public Member Functions
	Comutex (Team &team=dash::Team::All())
	Constructor to setup and initialize an Comutex. More...
iterator	begin () noexcept
const_iterator	begin () const noexcept
iterator	end () noexcept
const_iterator	end () const noexcept
size_type	size () const noexcept
void	initialize (Team &team)
	initializeds the mutexes. More...
Team &	team ()
reference	operator() (const int &unit)
	Operator to select mutex at given unit. More...
reference	operator() (const team_unit_t &unit)
	Operator to select mutex at given unit. More...

Detailed Description

A fortran style comutex.

Comutex is used to ensure mutual exclusion on a certain image. The interface is similar to dash::Coarray but does not allow local accesses. Hence it does not fulfill the DASH Container Concept.

Note

In its current implementation the Comutex does not scale well as each unit stores internally one ::mutex per unit. Hence, use this only for small teams.

Example:

Coarray<int> arr;
Comutex      comx;

{
 // lock unit i
 std::lock_guard<dash::Mutex> lg(comx(i));
 // exclusively access data on unti i
 arr(i) = 42;
}

: Use custom mutex to avoid storing the team multiple times (Each dash::Mutex) contains the team itself.

Definition at line 46 of file Comutex.h.

Constructor & Destructor Documentation

Comutex()

dash::Comutex::Comutex ( Team &  team = dash::Team::All() )

inlineexplicit

Constructor to setup and initialize an Comutex.

If dash is not initialized, use () after dash is initialized to initialize the Comutex

Definition at line 62 of file Comutex.h.

References initialize(), and dash::is_initialized().

                                                {
    if(dash::is_initialized()){
      initialize(team);
    }
  }

Member Function Documentation

initialize()

void dash::Comutex::initialize ( Team &  team )

inline

initializeds the mutexes.

If they were already initialized in the Ctor, the second initialization is skipped.

Definition at line 92 of file Comutex.h.

References dash::Team::size().

Referenced by Comutex().

                                     {
    if(!_is_initialized){
      _team = &team;
      _mutexes.reserve(team.size());
      for(decltype(team.size()) i = 0; i<team.size(); ++i){
        _mutexes.emplace_back(team);
      }
    } else {
      DASH_ASSERT_MSG((team == *_team),
                      "Comutex was initialized with a different team");
    }
    _is_initialized = true;
  }

operator()() [1/2]

reference dash::Comutex::operator() ( const int &  unit )

inline

Operator to select mutex at given unit.

Definition at line 113 of file Comutex.h.

                                                {
    DASH_ASSERT_MSG(_is_initialized, "Comutex is not initialized");
    return _mutexes.at(unit);
  }

operator()() [2/2]

reference dash::Comutex::operator() ( const team_unit_t &  unit )

inline

Operator to select mutex at given unit.

Definition at line 121 of file Comutex.h.

                                                        {
    return this->operator()(static_cast<int>(unit));
  }

---

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

• /tmp/tmporruphar/dash/include/dash/Comutex.h