From be1aaf75407c5a68f4065f36596fd20a579565f4 Mon Sep 17 00:00:00 2001 From: Hugh Bird Date: Fri, 3 Nov 2023 10:40:58 +0000 Subject: [PATCH] Romain suggested changes --- .../source/domains/dft/config_params/workspace_placement.rst | 1 + source/elements/oneMKL/source/domains/dft/descriptor.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) 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 776283af1..27fc7a8e8 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 @@ -57,6 +57,7 @@ Usage of ``WORKSPACE_EXTERNAL`` typically involves the following order of operat #. The required workspace size is queried. #. A workspace of sufficient size is provided to the descriptor. #. Compute functions following the type of external workspace provided are called. +#. The user is responsible for freeing the external workspace. This is shown in the following example code: diff --git a/source/elements/oneMKL/source/domains/dft/descriptor.rst b/source/elements/oneMKL/source/domains/dft/descriptor.rst index 044062825..8873b0c9b 100644 --- a/source/elements/oneMKL/source/domains/dft/descriptor.rst +++ b/source/elements/oneMKL/source/domains/dft/descriptor.rst @@ -434,7 +434,7 @@ Set the workspace for when ``config_param::WORKSPACE_PLACEMENT`` is set to ``con This function sets the workspace to use when computing DFTs for when an external workspace is set. This function may only be called after the descriptor has been committed. -The provided workspace must be equal to or larger than the required +The size of the provided workspace must be equal to or larger than the required workspace size obtained by calling ``descriptor::get_value(config_param::WORKSPACE_EXTERNAL_BYTES_REQUIRED, &workspaceBytes)``. A descriptor where ``WORKSPACE_EXTERNAL`` is specified is not a valid descriptor