Skip to content

Commit

Permalink
Use consistent wording; Align changes to 80 column limit
Browse files Browse the repository at this point in the history
  • Loading branch information
hjabird committed Jun 14, 2024
1 parent 8fc18df commit 4e444ba
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 31 deletions.
38 changes: 22 additions & 16 deletions source/elements/oneMKL/source/domains/dft/compute_backward.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,16 +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``. ``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
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``. ``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`.
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 @@ -271,16 +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``. ``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
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``. ``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`.
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 @@ -317,17 +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``. ``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
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``. ``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`.
configured by ``desc``. 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
36 changes: 21 additions & 15 deletions source/elements/oneMKL/source/domains/dft/compute_forward.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,16 +151,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``. ``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
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``. ``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`.
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 @@ -271,16 +273,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``. ``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
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``. ``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`.
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 @@ -318,16 +322,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``. ``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
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``. ``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`.
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

0 comments on commit 4e444ba

Please sign in to comment.