onemkl::dft::Descriptor<onemkl::dft::Precision, onemkl::dft::Domain>::getValue

Gets the configuration value of one particular configuration parameter.

Syntax

onemkl::dft::ErrCode getValue(onemkl::dft::ConfigParam param, ...)

Include Files

• mkl_dfti_sycl.hpp

Description

This function gets the configuration value of one particular parameter. 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

Note

All calls to getValue must be done after init, and before commit. This is because the handle may have been moved to an offloaded device after commit.

The function returns onemkl::dft::ErrCode::NO_ERROR when it completes successfully. See Status Checking Functions for more information on the returned status.

Input Parameters

Name	Type	Description
param	enum DFTI_CONFIG_PARAM	Configuration parameter.
value_ptr	Depends on the configuration parameter	Pointer to configuration value.

Output Parameters

Name	Type	Description
value	Depends on the configuration parameter	Configuration value.
status	std::int64_t	Function completion status.

Return Values

The function returns a value indicating whether the operation was successful or not, and why.

Return Value	Description
onemkl::dft::ErrCode::NO_ERROR	The operation was successful.
onemkl::dft::ErrCode::BAD_DESCRIPTOR	DFTI handle provided is invalid.
onemkl::dft::ErrCode::INCONSISTENT_CONFIGURATION/ onemkl::dft::ErrCode::INVALID_CONFIGURATION	An input value provided is invalid.
onemkl::dft::ErrCode::UNIMPLEMENTED	Functionality requested is not implemented.

Parent topic: Fourier Transform Functions