Skip to content

Commit 3ca94ed

Browse files
committed
Comment on usage in sort
1 parent a8f2b02 commit 3ca94ed

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/source/API/core/Macros.rst

+14-13
Original file line numberDiff line numberDiff line change
@@ -123,19 +123,20 @@ Third-Party Library Settings
123123

124124
These defines give information about what third-party libaries Kokkos was compiled with.
125125

126-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
127-
| Macro | Description |
128-
+===============================+=======================================================================================================================+
129-
| ``KOKKOS_ENABLE_HWLOC`` | Defined if `libhwloc <https://www.open-mpi.org/projects/hwloc/>`_ is enabled for NUMA and architecture information. |
130-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
131-
| ``KOKKOS_ENABLE_LIBRT`` | Defined if Kokkos links to the POSIX librt for backwards compatibility. |
132-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
133-
| ``KOKKOS_ENABLE_LIBDL`` | Defined if Kokkos links to the dynamic linker (libdl). |
134-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
135-
| ``KOKKOS_ENABLE_LIBQUADMATH`` | Defined if Kokkos links to the `GCC Quad-Precision Math Library API <https://gcc.gnu.org/onlinedocs/libquadmath/>`_. |
136-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
137-
| ``KOKKOS_ENABLE_ONEDPL`` | Defined if Kokkos links to the `oneDPL library <https://github.com/oneapi-src/oneDPL>`_ when using the SYCL backend. |
138-
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
126+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
127+
| Macro | Description |
128+
+===============================+========================================================================================================================+
129+
| ``KOKKOS_ENABLE_HWLOC`` | Defined if `libhwloc <https://www.open-mpi.org/projects/hwloc/>`_ is enabled for NUMA and architecture information. |
130+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
131+
| ``KOKKOS_ENABLE_LIBRT`` | Defined if Kokkos links to the POSIX librt for backwards compatibility. |
132+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
133+
| ``KOKKOS_ENABLE_LIBDL`` | Defined if Kokkos links to the dynamic linker (libdl). |
134+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
135+
| ``KOKKOS_ENABLE_LIBQUADMATH`` | Defined if Kokkos links to the `GCC Quad-Precision Math Library API <https://gcc.gnu.org/onlinedocs/libquadmath/>`_. |
136+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
137+
| ``KOKKOS_ENABLE_ONEDPL`` | Defined if Kokkos links to the `oneDPL library <https://github.com/oneapi-src/oneDPL>`_ when using the SYCL backend. |
138+
| | Enabling this TPL might affect performance for Kokkos algorithms that use it, e.g., `sort`. |
139+
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
139140

140141
Architectures
141142
-------------

0 commit comments

Comments
 (0)