DOC: add reference for universal intrinsics

numpy · seiko2plus · Feb 14, 2022 · Feb 14, 2022 · Apr 28, 2022 · Apr 29, 2022
commit 9d3c253e7d35efe7595d0e8802261665bd12d84c
diff --git a/doc/source/reference/simd/index.rst b/doc/source/reference/simd/index.rst
@@ -38,6 +38,7 @@ The optimization process in NumPy is carried out in three layers:
 
     build-options
     how-it-works
+    intrinsics/index
 
 .. _`NEP-38`: https://numpy.org/neps/nep-0038-SIMD-optimizations.html
 
diff --git a/doc/source/reference/simd/intrinsics/arithmetic.rst b/doc/source/reference/simd/intrinsics/arithmetic.rst
@@ -0,0 +1,23 @@
+Arithmetic
+~~~~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_arithmetic
+
diff --git a/doc/source/reference/simd/intrinsics/bitwise.rst b/doc/source/reference/simd/intrinsics/bitwise.rst
@@ -0,0 +1,23 @@
+Bitwise
+~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_bitwise
+
diff --git a/doc/source/reference/simd/intrinsics/comparison.rst b/doc/source/reference/simd/intrinsics/comparison.rst
@@ -0,0 +1,23 @@
+Comparison
+~~~~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_comparison
+
diff --git a/doc/source/reference/simd/intrinsics/conversion.rst b/doc/source/reference/simd/intrinsics/conversion.rst
@@ -0,0 +1,23 @@
+Conversion
+~~~~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_conversion
+
diff --git a/doc/source/reference/simd/intrinsics/index.rst b/doc/source/reference/simd/intrinsics/index.rst
@@ -0,0 +1,46 @@
+Universal intrinsics (C++)
+==========================
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+Overview
+--------
+
+.. doxygengroup:: cpp_simd
+  :desc-only:
+
+
+Data Types
+----------
+
+.. doxygengroup:: cpp_simd_types
+
+Supported operations:
+---------------------
+
+.. toctree::
+
+    utils
+    miscellaneous
+    memory
+    bitwise
+    comparison
+    conversion
+    reorder
+    arithmetic
+    math
diff --git a/doc/source/reference/simd/intrinsics/math.rst b/doc/source/reference/simd/intrinsics/math.rst
@@ -0,0 +1,23 @@
+Math
+~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_math
+
diff --git a/doc/source/reference/simd/intrinsics/memory.rst b/doc/source/reference/simd/intrinsics/memory.rst
@@ -0,0 +1,22 @@
+Memory
+~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+.. doxygengroup:: cpp_simd_memory
+
diff --git a/doc/source/reference/simd/intrinsics/miscellaneous.rst b/doc/source/reference/simd/intrinsics/miscellaneous.rst
@@ -0,0 +1,23 @@
+Miscellaneous
+~~~~~~~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_misc
+
diff --git a/doc/source/reference/simd/intrinsics/reorder.rst b/doc/source/reference/simd/intrinsics/reorder.rst
@@ -0,0 +1,23 @@
+Reorder
+~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_reorder
+
diff --git a/doc/source/reference/simd/intrinsics/utils.rst b/doc/source/reference/simd/intrinsics/utils.rst
@@ -0,0 +1,24 @@
+Utility
+~~~~~~~
+
+.. raw:: html
+
+    <style>
+    /* hide the title of group cpp_simd */
+    .bd-article-container article section > dl > dt {
+        display:none;
+    }
+    /* hide the margin of group cpp_simd */
+    .bd-article-container article section > dl > dd {
+        margin: 0;
+    }
+    /* hide sections title typedefs, functions */
+    #breathe-section-title-typedefs, #breathe-section-title-functions, #breathe-section-title-variables {
+        display: none;
+    }
+    </style>
+
+
+.. doxygengroup:: cpp_simd_utils
+
+
diff --git a/numpy/_core/src/common/.doxyfile b/numpy/_core/src/common/.doxyfile
@@ -1 +1,8 @@
 INCLUDE_PATH += @CUR_DIR
+INPUT += @CUR_DIR/simd/simd.hpp \
+         @CUR_DIR/simd/wrapper/datatypes.hpp \
+         @CUR_DIR/simd/forward.inc.hpp
+
+
+PREDEFINED += NPY_FINLINE=inline NPY_CPU_DISPATCH_CURFX(X)=simd NPY_HAVE_SSE2
+EXCLUDE_SYMBOLS += NPYV_IMPL_* helper