descriptor<precision, domain>::set

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-486E9F06-CA68-49D6-8E51-9C9AE14782BF

View Details

descriptor<precision, domain>::set_value

Sets one configuration parameter with the specified configuration value. This routine belongs to the oneapi::mkl::dft namespace.

Description
API

Description

This function sets one configuration parameter with the specified configuration value and throws an std::runtime_exception if it fails. 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. The DPC++ configuration parameters have type oneapi::mkl::dft::config_param. Some of them are relevant for Configuring Data Layouts or using User-Allocated Workspaces. Every other parameter oneapi::mkl::dft::config_param::<PARAMETER_NAME> has the same meaning and possible values as the C interface’s DFTI_<PARAMETER_NAME>, which are thoroughly documented in Config Params. Note that some of these options available in the C interface are not fully supported in the DPC++ interface yet. See the note below and the Intel® oneAPI Math Kernel Library Release Notes.

NOTE:

Transforms on GPU devices may overwrite DFT-irrelevant padding entries in the output data.

The set_value function cannot be used to change configuration parameters oneapi::mkl::dft::config_param::FORWARD_DOMAIN, oneapi::mkl::dft::config_param::PRECISION since these are a part of the template. Likewise, oneapi::mkl::dft::config_param::LENGTHS is set with the constructor.

All calls to set_value() must be done before calls to commit(). This is because the handle may have been moved to an offloaded device after commit().

API

Syntax

namespace oneapi::mkl::dft{
  void descriptor<prec,dom>::set_value(config_param param, ...);
}

Include Files

oneapi/mkl/dfti.hpp

Input Parameters

Name	Type	Description
param	`oneapi::mkl::dft::config_param`	Configuration parameter
value	Depends on the configuration parameter	Configuration value

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

descriptor<precision, domain>::set_value

Description

API