TiledArray::detail::RoundRobinPmap Class Reference
Inheritance diagram for TiledArray::detail::RoundRobinPmap:
Collaboration diagram for TiledArray::detail::RoundRobinPmap:
Documentation
A blocked process map.
Map N elements among P processes into blocks that are approximately N/P elements in size. A minimum block size may also be specified.
Definition at line 17 of file round_robin_pmap.h.
Public Types | |
typedef Pmap::size_type | size_type |
Key type. More... | |
Public Types inherited from TiledArray::Pmap | |
typedef std::size_t | size_type |
Size type. More... | |
typedef Iterator | const_iterator |
Iterator type. More... | |
Public Member Functions | |
RoundRobinPmap (World &world, size_type size) | |
Construct Round Robin map. More... | |
virtual | ~RoundRobinPmap () |
virtual size_type | owner (const size_type tile) const |
Maps tile to the processor that owns it. More... | |
virtual bool | is_local (const size_type tile) const |
Check that the tile is owned by this process. More... | |
Public Member Functions inherited from TiledArray::Pmap | |
Pmap (World &world, const size_type size) | |
Process map constructor. More... | |
virtual | ~Pmap () |
size_type | size () const |
Size accessor. More... | |
size_type | rank () const |
Process rank accessor. More... | |
size_type | procs () const |
Process count accessor. More... | |
virtual bool | known_local_size () const |
Queries whether local size is known. More... | |
size_type | local_size () const |
Local size accessor. More... | |
bool | empty () const |
Check if there are any local elements. More... | |
virtual bool | is_replicated () const |
Replicated array status. More... | |
virtual const_iterator | begin () const |
Begin local element iterator. More... | |
virtual const_iterator | end () const |
End local element iterator. More... | |
const const_iterator | cbegin () const |
Begin local element iterator. More... | |
const const_iterator | cend () const |
End local element iterator. More... | |
Protected Attributes | |
const size_type | procs_ |
The number of processes. More... | |
const size_type | rank_ |
< The number of processes More... | |
const size_type | size_ |
< The rank of this process More... | |
Protected Attributes inherited from TiledArray::Pmap | |
const size_type | rank_ |
The rank of this process. More... | |
const size_type | procs_ |
The number of processes. More... | |
const size_type | size_ |
The number of tiles mapped among all processes. More... | |
std::vector< size_type > | local_ |
A list of local tiles (may be empty, if not needed) More... | |
size_type | local_size_ |
Member Typedef Documentation
◆ size_type
Key type.
Definition at line 28 of file round_robin_pmap.h.
Constructor & Destructor Documentation
◆ RoundRobinPmap()
|
inline |
Construct Round Robin map.
- Parameters
-
world The world where the tiles will be mapped size The number of tiles to be mapped
Definition at line 34 of file round_robin_pmap.h.
Here is the call graph for this function:
◆ ~RoundRobinPmap()
|
inlinevirtual |
Definition at line 43 of file round_robin_pmap.h.
Member Function Documentation
◆ is_local()
|
inlinevirtual |
Check that the tile is owned by this process.
- Parameters
-
tile The tile to be checked
- Returns
true
iftile
is owned by this process, otherwisefalse
.
Implements TiledArray::Pmap.
Definition at line 58 of file round_robin_pmap.h.
◆ owner()
|
inlinevirtual |
Maps tile
to the processor that owns it.
- Parameters
-
tile The tile to be queried
- Returns
- Processor that logically owns
tile
Implements TiledArray::Pmap.
Definition at line 49 of file round_robin_pmap.h.
Member Data Documentation
◆ procs_
|
protected |
◆ rank_
|
protected |
◆ size_
|
protected |
The documentation for this class was generated from the following file:
- TiledArray/pmap/round_robin_pmap.h