Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DFT] Constrain data_type in compute_*ward real-real inplace #544

Merged
merged 3 commits into from
Jul 2, 2024
Merged

[DFT] Constrain data_type in compute_*ward real-real inplace #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fc18df
[DFT] Constrain data_type in compute_*ward real-real inplace
hjabird Jun 10, 2024
4e444ba
Use consistent wording; Align changes to 80 column limit
hjabird Jun 14, 2024
554d0fa
Missing data_desc; Source formating #2
hjabird Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions source/elements/oneMKL/source/domains/dft/compute_backward.rst
View file
Open in desktop
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
hjabird marked this conversation as resolved.
Show resolved Hide resolved
: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,14 +151,18 @@ 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
``sycl::buffer`` object of sufficient capacity to store the elements
Expand Down Expand Up @@ -267,14 +273,18 @@ 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
Pointer to USM allocation of sufficient capacity to store the elements
Expand Down Expand Up @@ -311,15 +321,19 @@ 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 :ref:`onemkl_dft_complex_storage_real_real`.
defining the real parts of all the relevant data sequences, as 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
Pointer to USM allocation of sufficient capacity to store the elements
Expand Down
44 changes: 30 additions & 14 deletions source/elements/oneMKL/source/domains/dft/compute_forward.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,19 @@ 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 :ref:`onemkl_dft_complex_storage_real_real`.
defining the real parts of all the relevant data sequences, as 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
``sycl::buffer`` object of sufficient capacity to store the elements
Expand Down Expand Up @@ -149,14 +153,18 @@ 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
``sycl::buffer`` object of sufficient capacity to store the elements
Expand Down Expand Up @@ -267,14 +275,18 @@ 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
Pointer to USM allocation of sufficient capacity to store the elements
Expand Down Expand Up @@ -312,14 +324,18 @@ 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
operations with :ref:`onemkl_dft_complex_storage_real_real`.
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
Pointer to USM allocation of sufficient capacity to store the elements
Expand Down