mkl-devel-dpcpp 2024.2.1__py2.py3-none-win_amd64.whl → 2025.0.0__py2.py3-none-win_amd64.whl

mkl_devel_dpcpp-2024.2.1.data/data/Library/include/oneapi/mkl/dfti.hpp → mkl_devel_dpcpp-2025.0.0.data/data/Library/include/oneapi/mkl/dft.hpp

@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright 2019-2022 Intel Corporation.
+* Copyright 2024 Intel Corporation.
 *
 * This software and the related documents are Intel copyrighted  materials,  and
 * your use of  them is  governed by the  express license  under which  they were
@@ -12,8 +12,8 @@
 * License.
 *******************************************************************************/
 
-#ifndef _DFTI_HPP_
-#define _DFTI_HPP_
+#ifndef _DFT_HPP_
+#define _DFT_HPP_
 
 #include <cinttypes>    // std::int64_t
 #include <vector>       // std::vector
@@ -37,37 +37,51 @@ enum class domain {
 };
 
 enum class config_param {
-    FORWARD_DOMAIN          = DFTI_FORWARD_DOMAIN,
-    DIMENSION               = DFTI_DIMENSION,
-    LENGTHS                 = DFTI_LENGTHS,
-    PRECISION               = DFTI_PRECISION,
-    FORWARD_SCALE           = DFTI_FORWARD_SCALE,
-    BACKWARD_SCALE          = DFTI_BACKWARD_SCALE,
-    NUMBER_OF_TRANSFORMS    = DFTI_NUMBER_OF_TRANSFORMS,
-    COMPLEX_STORAGE         = DFTI_COMPLEX_STORAGE,
-    REAL_STORAGE            = DFTI_REAL_STORAGE,
-    CONJUGATE_EVEN_STORAGE  = DFTI_CONJUGATE_EVEN_STORAGE,
-    PLACEMENT               = DFTI_PLACEMENT,
-    INPUT_STRIDES           = DFTI_INPUT_STRIDES,
-    OUTPUT_STRIDES          = DFTI_OUTPUT_STRIDES,
-    FWD_DISTANCE            = DFTI_FWD_DISTANCE,
-    BWD_DISTANCE            = DFTI_BWD_DISTANCE,
-    WORKSPACE               = DFTI_WORKSPACE,
-    ORDERING                = DFTI_ORDERING,
-    TRANSPOSE               = DFTI_TRANSPOSE,
-    PACKED_FORMAT           = DFTI_PACKED_FORMAT,
-    COMMIT_STATUS           = DFTI_COMMIT_STATUS,
-    VERSION                 = DFTI_VERSION,
-    NUMBER_OF_USER_THREADS  = DFTI_NUMBER_OF_USER_THREADS,
-    THREAD_LIMIT            = DFTI_THREAD_LIMIT,
-    DESTROY_INPUT           = DFTI_DESTROY_INPUT,
+    FORWARD_DOMAIN                          = DFTI_FORWARD_DOMAIN,
+    DIMENSION                               = DFTI_DIMENSION,
+    LENGTHS                                 = DFTI_LENGTHS,
+    PRECISION                               = DFTI_PRECISION,
+    FORWARD_SCALE                           = DFTI_FORWARD_SCALE,
+    BACKWARD_SCALE                          = DFTI_BACKWARD_SCALE,
+    NUMBER_OF_TRANSFORMS                    = DFTI_NUMBER_OF_TRANSFORMS,
+    COMPLEX_STORAGE                         = DFTI_COMPLEX_STORAGE,
+    CONJUGATE_EVEN_STORAGE  [[deprecated]]  = DFTI_CONJUGATE_EVEN_STORAGE,
+    PLACEMENT                               = DFTI_PLACEMENT,
+    INPUT_STRIDES           [[deprecated("Use FWD/BWD strides instead.")]]
+                                            = DFTI_INPUT_STRIDES,
+    OUTPUT_STRIDES          [[deprecated("Use FWD/BWD strides instead.")]]
+                                            = DFTI_OUTPUT_STRIDES,
+    FWD_DISTANCE                            = DFTI_FWD_DISTANCE,
+    BWD_DISTANCE                            = DFTI_BWD_DISTANCE,
+    WORKSPACE                               = DFTI_WORKSPACE,
+    PACKED_FORMAT           [[deprecated]]  = DFTI_PACKED_FORMAT,
+    COMMIT_STATUS                           = DFTI_COMMIT_STATUS,
+    VERSION                 [[deprecated]]  = DFTI_VERSION,
+    THREAD_LIMIT                            = DFTI_THREAD_LIMIT,
+    DESTROY_INPUT                           = DFTI_DESTROY_INPUT,
     WORKSPACE_ESTIMATE_BYTES,
     WORKSPACE_BYTES,
     FWD_STRIDES,
-    BWD_STRIDES
+    BWD_STRIDES,
+    WORKSPACE_PLACEMENT,        // alias for WORKSPACE
+    WORKSPACE_EXTERNAL_BYTES    // alias for WORKSPACE_BYTES
 };
 
 enum class config_value {
+    COMMITTED                               = DFTI_COMMITTED,
+    UNCOMMITTED                             = DFTI_UNCOMMITTED,
+    COMPLEX_COMPLEX                         = DFTI_COMPLEX_COMPLEX,
+    REAL_REAL                               = DFTI_REAL_REAL,
+    INPLACE                                 = DFTI_INPLACE,
+    NOT_INPLACE                             = DFTI_NOT_INPLACE,
+    WORKSPACE_AUTOMATIC,            // alias for WORKSPACE_INTERNAL
+    COMPLEX_REAL            [[deprecated]]  = DFTI_COMPLEX_REAL,
+    ALLOW                                   = DFTI_ALLOW,
+    AVOID                                   = DFTI_AVOID,
+    CCE_FORMAT              [[deprecated]]  = DFTI_CCE_FORMAT,
+    PERM_FORMAT             [[deprecated]]  = DFTI_PERM_FORMAT,
+    PACK_FORMAT             [[deprecated]]  = DFTI_PACK_FORMAT,
+    CCS_FORMAT              [[deprecated]]  = DFTI_CCS_FORMAT,
     WORKSPACE_INTERNAL,
     WORKSPACE_EXTERNAL
 };
@@ -123,6 +137,7 @@ sycl::event compute_backward(
 
 template <precision prec, domain dom>
 class descriptor {
+    using real_scalar_t = std::conditional_t<prec == precision::DOUBLE, double, float>;
  public:
     // initializes the FFT description for a multi-dimensional FFT
     descriptor(std::vector<std::int64_t> dimensions);
@@ -134,7 +149,6 @@ class descriptor {
 
     void commit(sycl::queue &in);
 
-    // Friend compute functions
     // in place forward computation; buffer API
     template <typename descriptor_type, typename data_type>
     friend void compute_forward(
@@ -184,10 +198,42 @@ class descriptor {
         output_type *out,
         const std::vector<sycl::event> &dependencies);
 
-    // sets a non-default configuration option
-    void set_value(config_param param, ...);
-    // retrieves a configuration value
-    void get_value(config_param param, ...);
+    // configuration-setting member functions:
+    [[deprecated("Use set_value(config_param, config_value) instead.")]]
+    void set_value(config_param, DFTI_CONFIG_VALUE);
+    void set_value(config_param, config_value);
+    void set_value(config_param, std::int64_t);
+    void set_value(config_param, real_scalar_t);
+    [[deprecated("Use set_value(config_param, const std::vector<std::int64_t>&) instead.")]]
+    void set_value(config_param, const std::int64_t*);
+    void set_value(config_param, const std::vector<std::int64_t>&);
+    template <typename T, std::enable_if_t<std::is_integral_v<T>, bool> = true>
+    void set_value(config_param param, T value) {
+        set_value(param, static_cast<std::int64_t>(value));
+    }
+    template <typename T, std::enable_if_t<std::is_floating_point_v<T>, bool> = true>
+    void set_value(config_param param, T value) {
+        set_value(param, static_cast<real_scalar_t>(value));
+    }
+    [[deprecated("This set_value member function is deprecated.")]]
+    void set_value(config_param, ...);
+    // configuration-querying member functions:
+    [[deprecated("Use MKL_Get_Version_String(char*, int) instead.")]]
+    void get_value(config_param, char*) const;
+    [[deprecated("Use get_value(config_param, config_value*), "
+                 "get_value(config_param, domain*) or "
+                 "get_value(config_param, precision*) instead.")]]
+    void get_value(config_param, DFTI_CONFIG_VALUE*) const;
+    void get_value(config_param, config_value*) const;
+    void get_value(config_param, domain*) const;
+    void get_value(config_param, precision*) const;
+    [[deprecated("Use get_value(config_param, std::int64_t*) instead.")]]
+    void get_value(config_param, size_t*) const;
+    void get_value(config_param, std::int64_t*) const;
+    void get_value(config_param, real_scalar_t*) const;
+    void get_value(config_param, std::vector<std::int64_t>*) const;
+    [[deprecated("This get_value member function is deprecated.")]]
+    void get_value(config_param, ...) const;
 
     template<typename data_type>
     void set_workspace(sycl::buffer<data_type, 1> &workspace);
@@ -195,8 +241,8 @@ class descriptor {
     void set_workspace(data_type *workspace);
 
  private:
-    DFTI_DESCRIPTOR_HANDLE handle;          // local handle
-    SYCL_DFTI_DESCRIPTOR_HANDLE device_handle;  // device handle for buffer
+    DFTI_DESCRIPTOR_HANDLE handle;
+    SYCL_DFTI_DESCRIPTOR_HANDLE device_handle;
     sycl::buffer<SYCL_DFTI_DESCRIPTOR_HANDLE, 1> handle_buffer;
 };
 
@@ -204,4 +250,4 @@ class descriptor {
 }  // namespace mkl
 } // namespace oneapi
 
-#endif  /* _DFTI_HPP_ */
+#endif  /* _DFT_HPP_ */

mkl_devel_dpcpp-2025.0.0.data/data/Library/include/oneapi/mkl/dfti.hpp

@@ -0,0 +1,22 @@
+/*******************************************************************************
+* Copyright 2019-2022 Intel Corporation.
+*
+* This software and the related documents are Intel copyrighted  materials,  and
+* your use of  them is  governed by the  express license  under which  they were
+* provided to you (License).  Unless the License provides otherwise, you may not
+* use, modify, copy, publish, distribute,  disclose or transmit this software or
+* the related documents without Intel's prior written permission.
+*
+* This software and the related documents  are provided as  is,  with no express
+* or implied  warranties,  other  than those  that are  expressly stated  in the
+* License.
+*******************************************************************************/
+
+#ifndef _DFTI_HPP_
+#define _DFTI_HPP_
+
+#warning "Header 'oneapi/mkl/dfti.hpp' is deprecated. Please use oneapi/mkl/dft.hpp instead"
+
+#include "oneapi/mkl/dft.hpp"
+
+#endif  /* _DFTI_HPP_ */