Skip to content

Commit

Permalink
[DFT] clarifying get_value's behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
raphael-egan committed Oct 31, 2023
1 parent fda0525 commit 75af8a9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions source/elements/oneMKL/source/domains/dft/descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,12 @@ type ``oneapi::mkl::dft::domain``, ``oneapi::mkl::dft::precision``,
``oneapi::mkl::dft::config_value`` or a native type like ``std::int64_t`` or
``float`` (more details available :ref:`here<onemkl_dft_enum_config_param>`).

.. note::
The value returned by ``get_value`` corresponds to the latest value set for
the corresponding configuration parameter being queried or the
corresponding default value if that parameter was not set or if it is not
writable, even if that value was set after the descriptor was committed.

.. rubric:: Syntax

.. code-block:: cpp
Expand Down

0 comments on commit 75af8a9

Please sign in to comment.