A newer version of this document is available. Customers should click here to go to the newest version.
Scoped enumerations
This page describes the scoped enumerations pertaining to the definition or configuration of oneapi::mkl::experimental::dft::distributed_descriptor objects: oneapi::mkl::experimental::dft::distributed_config_param.
namespace oneapi::mkl::experimental::dft {
enum class distirbuted_config_param {
fwd_divided_dimension,
bwd_divided_dimension,
fwd_distribution,
bwd_distribution,
fwd_local_data_size_bytes,
bwd_local_data_size_bytes
};
}The scoped enumerations above belong to the oneapi::mkl::experimental::dft namespace and are declared in oneapi/mkl/experimental/distributed_dft.hpp (file to be included). The usage of prepended namespace specifiers oneapi::mkl::experimental::dft is omitted below for conciseness. Note that the configuration parameters and configuration values defined here are re-used within the distributed_descriptor class’s member functions to set/get most of the global DFT properties such as foward/backward scale, strides etc. This section discusses the new distributed_config_param introduced in the oneapi::mkl::experimental::dft namespace to be used exclusively for performing a distributed DFT.
The default configuration values associated with all writable distributed configuration parameters are documented in the page dedicated to the configuration-setting member function(s) of the distributed_descriptor class template.
distributed_config_param
This scoped enumeration type is used to represent distributed-dft–specific configuration parameters of oneMKL DFT distributed_descriptor objects. For any distributed_descriptor object, all its configuration parameters are associated with a configuration value. The type of the latter depends on the configuration parameter and is documented in the page specific to the configuration-setting (or configuration-querying, for read-only parameters) member functions of the distributed_descriptor class template.
Enumerator(s) |
Corresponding configuration parameter. |
|---|---|
distributed_config_param::fwd_divided_dimension |
Configuration parameter indicating which dimension to be slab decomposed for the forward domain. |
distributed_config_param::bwd_divided_dimension |
Configuration parameter indicating which dimension to be slab decomposed for the backward domain. |
distributed_config_param::fwd_distribution |
Configuration parameter indicating that a custom decomposition is to be used for the forward domain. |
distributed_config_param::bwd_distribution |
Configuration parameter indicating that a custom decomposition is to be used for the backward domain. |
distributed_config_param::fwd_local_data_size_bytes |
Exact size in bytes to be allocated for the forward domain within that specific process. |
distributed_config_param::bwd_local_data_size_bytes |
Exact size in bytes to be allocated for the backward domain within that specific process. |