Querying a Local Subdomain¶

hasSingleLocalSubdomain¶

proc array.hasSingleLocalSubdomain() : bool;

This is a param function which returns a boolean. If true, then the index set owned by a locale can be represented by a single domain.

This function always returns true for non-distributed arrays.

To support this function on a custom distributed array type, write a param function named 'dsiHasSingleLocalSubdomain'.

localSubdomain¶

proc array.localSubdomain() : domain;

This function only operates on arrays whose 'hasSingleLocalSubdomain()' result is true. Otherwise, a compiler error is thrown.

This function returns a single domain that represents the index set owned by the current locale. This returned domain cannot be used to modify the index set owned by the locale.

For non-distributed arrays, this function returns a copy of that array's domain.

To support this function on a custom distributed array type, write a function named 'dsiLocalSubdomain'.

localSubdomains¶

iter array.localSubdomains() : domain;

This iterator yields the subdomain(s) that represent the index set owned by the current locale.

If the locale's index set can be represented by a single domain, then the result of localSubdomain is yielded.

Currently, this is a serial iterator.

To support this iterator on a custom distributed array type, write an iterator named 'dsiLocalSubdomains'.

targetLocales¶

proc array.targetLocales() : [] locale;

This function returns an array of locales that the distribution uses as the locale grid.