Skip to content

Commit

Permalink
[DFT] Constrain data_type in compute_*ward real-real inplace
Browse files Browse the repository at this point in the history
* The compute_*ward real-real implace overload can be selected when the user
intends to use the complex-complex out-of-place overload.
* This suggestion stops this from happening when the user uses non-float
arguments that are presumably intended for the complex-complex overload.
  • Loading branch information
hjabird committed Jun 10, 2024
1 parent d7fcf87 commit 8fc18df
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 16 deletions.
24 changes: 16 additions & 8 deletions source/elements/oneMKL/source/domains/dft/compute_backward.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,15 @@ compute_backward (Buffer version)
inout_re
``sycl::buffer`` object of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
``sycl::buffer`` object of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

in
Expand Down Expand Up @@ -149,13 +151,15 @@ compute_backward (Buffer version)
inout_re
``sycl::buffer`` object of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
``sycl::buffer`` object of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

out
Expand Down Expand Up @@ -267,13 +271,15 @@ compute_backward (USM version)
inout_re
Pointer to USM allocation of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
Pointer to USM allocation of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

in
Expand Down Expand Up @@ -312,13 +318,15 @@ compute_backward (USM version)
inout_re
Pointer to USM allocation of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

inout_im
Pointer to USM allocation of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be the floating-point type
described by descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

out
Expand Down
24 changes: 16 additions & 8 deletions source/elements/oneMKL/source/domains/dft/compute_forward.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,15 @@ compute_forward (Buffer version)
inout_re
``sycl::buffer`` object of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

inout_im
``sycl::buffer`` object of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

in
Expand Down Expand Up @@ -149,13 +151,15 @@ compute_forward (Buffer version)
inout_re
``sycl::buffer`` object of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
``sycl::buffer`` object of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

out
Expand Down Expand Up @@ -267,13 +271,15 @@ compute_forward (USM version)
inout_re
Pointer to USM allocation of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
Pointer to USM allocation of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

in
Expand Down Expand Up @@ -312,13 +318,15 @@ compute_forward (USM version)
inout_re
Pointer to USM allocation of sufficient capacity to store the elements
defining the real parts of all the relevant data sequences, as configured
by ``desc``. Only with complex descriptors configured for in-place operations with
by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place operations with
:ref:`onemkl_dft_complex_storage_real_real`.

inout_im
Pointer to USM allocation of sufficient capacity to store the elements
defining the imaginary parts of all the relevant data sequences, as
configured by ``desc``. Only with complex descriptors configured for in-place
configured by ``desc``. ``data_type`` must be single or double precision floating-point, as
described by the descriptor's precision. Only with complex descriptors configured for in-place
operations with :ref:`onemkl_dft_complex_storage_real_real`.

out
Expand Down

0 comments on commit 8fc18df

Please sign in to comment.