From 56bef7645c0c64c503a94aabd0b62097dc7e098f Mon Sep 17 00:00:00 2001 From: Hugh Bird Date: Mon, 6 Nov 2023 15:17:08 +0000 Subject: [PATCH] Raphael formatting suggestions --- .../source/domains/dft/config_params/workspace_placement.rst | 2 +- source/elements/oneMKL/source/domains/dft/descriptor.rst | 4 ++-- .../oneMKL/source/domains/dft/enums_and_config_params.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/elements/oneMKL/source/domains/dft/config_params/workspace_placement.rst b/source/elements/oneMKL/source/domains/dft/config_params/workspace_placement.rst index 6c8d5e2a6..587e0ac08 100644 --- a/source/elements/oneMKL/source/domains/dft/config_params/workspace_placement.rst +++ b/source/elements/oneMKL/source/domains/dft/config_params/workspace_placement.rst @@ -19,7 +19,7 @@ for the following reasons: For some backends and configurations, ``config_value::WORKSPACE_EXTERNAL`` may reduce performance. -A typical workflow for using ``config_value::WORKSPACE_EXTERNAL`` is given in the section :ref:`onemkl_dft_typical_usage_of_workspace_external`. +A typical workflow for using ``config_value::WORKSPACE_EXTERNAL`` is given in the section :ref:`below`. WORKSPACE_PLACEMENT +++++++++++++++++++ diff --git a/source/elements/oneMKL/source/domains/dft/descriptor.rst b/source/elements/oneMKL/source/domains/dft/descriptor.rst index 6d881fa83..7a5cb972f 100644 --- a/source/elements/oneMKL/source/domains/dft/descriptor.rst +++ b/source/elements/oneMKL/source/domains/dft/descriptor.rst @@ -448,7 +448,7 @@ allocated workspace must only be used with USM compute calls. Failing to do this will result in an invalid descriptor for compute calls. If the workspace is a USM allocation, the user must not use it for other purposes -in parallel whilst the DFT `compute_forward` or `compute_backward` are in progress. +in parallel whilst the DFT ``compute_forward`` or ``compute_backward`` are in progress. This function can be called on committed descriptors where the workspace placement is not ``config_value::WORKSPACE_EXTERNAL``. The provided workspace may or may not @@ -489,7 +489,7 @@ be used in compute calls. However, the aforementioned restrictions will still ap .. rubric:: Throws - The `descriptor::set_workspace()` routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here: + The ``descriptor::set_workspace()`` routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here: :ref:`oneapi::mkl::invalid_argument()` If the provided buffer ``workspaceBuf`` is not sufficiently large, or if the provided USM allocation ``workspaceUSM`` is ``nullptr`` when an external workspace of size greater than zero is required. diff --git a/source/elements/oneMKL/source/domains/dft/enums_and_config_params.rst b/source/elements/oneMKL/source/domains/dft/enums_and_config_params.rst index d6d020a55..c1fd5428e 100644 --- a/source/elements/oneMKL/source/domains/dft/enums_and_config_params.rst +++ b/source/elements/oneMKL/source/domains/dft/enums_and_config_params.rst @@ -268,7 +268,7 @@ the :ref:`descriptor` class. * - :ref:`WORKSPACE_PLACEMENT` - Some FFT algorithm computation steps require a scratch space for permutations or other purposes. This parameter controls whether this scratch space is automatically allocated or provided by the user. - - | :ref:`onemkl_dft_config_workspace_placement` (possible values are ``config_value::WORKSPACE_AUTOMATIC`` or ``config_value::WORKSPACE_EXTERNAL``). + - | :ref:`onemkl_dft_enum_config_value` (possible values are ``config_value::WORKSPACE_AUTOMATIC`` or ``config_value::WORKSPACE_EXTERNAL``). | [``config_value::WORKSPACE_AUTOMATIC``] * - WORKSPACE_EXTERNAL_BYTES - The required minimum external workspace size for use by :ref:`set_workspace`.