Gets the configuration value of one configuration parameter. This routine belongs to the mkl::dft namespace.
void descriptor<prec,dom>::get_value (config_param param , ...) ;
This function gets the configuration value of one particular configuration parameter and will throw an std::runtime_exception() in the case that it fails or an invalid configuration is provided. Each configuration parameter is a named constant, and the configuration value must have the corresponding type, which can be a named constant or a native type. For available configuration parameters and the corresponding configuration values, see DftiGetValue
Name |
Type |
Description |
---|---|---|
param |
enum DFTI_CONFIG_PARAM |
Configuration parameter. |
value_ptr |
Depends on the configuration parameter |
Pointer to configuration value. |
Name |
Type |
Description |
---|---|---|
value |
Depends on the configuration parameter |
Configuration value. |
status |
std::int64_t |
Function completion status. |
The function returns a value indicating whether the operation was successful or not, and why.
Return Value | Description |
---|---|
mkl::dft::ErrCode::NO_ERROR | The operation was successful. |
mkl::dft::ErrCode::BAD_DESCRIPTOR | DFTI handle provided is invalid. |
mkl::dft::ErrCode::INCONSISTENT_CONFIGURATION/ mkl::dft::ErrCode::INVALID_CONFIGURATION |
An input value provided is invalid. |
mkl::dft::ErrCode::UNIMPLEMENTED | Functionality requested is not implemented. |