legate::mapping::StoreMapping#

class StoreMapping#

A mapping policy for stores.

Public Functions

InstanceMappingPolicy &policy()#

Returns the instance mapping policy of this StoreMapping object.

Returns:

A reference to the InstanceMappingPolicy object

const InstanceMappingPolicy &policy() const#

Returns the instance mapping policy of this StoreMapping object.

Returns:

A reference to the InstanceMappingPolicy object

Store store() const#

Returns the store for which this StoreMapping object describes a mapping policy.

If the policy is for multiple stores, the first store added to this policy will be returned;

Returns:

A Store object

std::vector<Store> stores() const#

Returns all the stores for which this StoreMapping object describes a mapping policy.

Returns:

A vector of Store objects

void add_store(const Store &store)#

Adds a store to this StoreMapping object.

Parameters:

storeStore to add

Public Static Functions

static StoreMapping default_mapping(
const Store &store,
StoreTarget target,
bool exact = false
)#

Creates a mapping policy for the given store following the default mapping policy.

Parameters:
  • store – Target store

  • target – Kind of the memory to which the store should be mapped

  • exact – Indicates whether the instance should be exact

Returns:

A store mapping

static StoreMapping create(
const Store &store,
InstanceMappingPolicy &&policy
)#

Creates a mapping policy for the given store using the instance mapping policy.

Parameters:
  • store – Target store for the mapping policy

  • policy – Instance mapping policy to apply

Returns:

A store mapping

static StoreMapping create(
const std::vector<Store> &stores,
InstanceMappingPolicy &&policy
)#

Creates a mapping policy for the given set of stores using the instance mapping policy.

Parameters:
  • stores – Target stores for the mapping policy

  • policy – Instance mapping policy to apply

Returns:

A store mapping

class ReleaseKey#