Struct PlacesConfig#

Struct Documentation#

struct PlacesConfig#

Configuration for creating a Places

Public Functions

inline void assertValid() const#: Check whether the configuration is valid, throw an error if not valid

Public Members

std::variant<Size, GhostSize> ghostSize = 1#

Size of the Ghost Regions.

Can be either a single integer for using the same size at each direction, or a GhostSize instance for configuring the size at each direction

Default to 1 (same for all direction)

std::optional<NDArray<DeviceRank>> deviceMap = std::nullopt#

The rule of how to map each Places block to devices

Configured as an NDArray, where each cell represent a Places block and the integer value on it is the rank of the assigned device.

This configuration is optional, if not provided, the mapping will be determined automatically by the library, which does not guarantee to be optimal.

MemoryOrder memoryOrder = MemoryOrder::ROW_MAJOR #: The memory order of the Place instances within the Places grid