Update API docs (c3aa526).

facebookresearch · Jan 11, 2024 · 251de2e · 251de2e
1 parent 96c4dee
commit 251de2e
Show file tree

Hide file tree

Showing 14 changed files with 93 additions and 23 deletions.
diff --git a/cpp_api/file/fp16-arm_8h.rst b/cpp_api/file/fp16-arm_8h.rst
@@ -0,0 +1,4 @@
+File fp16-arm.h
+===============
+
+.. doxygenfile:: fp16-arm.h
diff --git a/cpp_api/namespace/namespacefaiss_1_1_0d138.rst b/cpp_api/namespace/namespacefaiss_1_1_0d138.rst
diff --git a/cpp_api/namespace/namespacefaiss_1_1_0d139.rst b/cpp_api/namespace/namespacefaiss_1_1_0d139.rst
@@ -0,0 +1,4 @@
+Namespace faiss::@139
+=====================
+
+.. doxygennamespace:: faiss::@139
diff --git a/cpp_api/namespace/namespacefaiss_1_1_0d154.rst b/cpp_api/namespace/namespacefaiss_1_1_0d154.rst
diff --git a/cpp_api/namespace/namespacefaiss_1_1_0d157.rst b/cpp_api/namespace/namespacefaiss_1_1_0d157.rst
@@ -0,0 +1,4 @@
+Namespace faiss::@157
+=====================
+
+.. doxygennamespace:: faiss::@157
diff --git a/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml b/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml
@@ -11,6 +11,7 @@
     <innerfile refid="distances_8h">distances.h</innerfile>
     <innerfile refid="extra__distances-inl_8h">extra_distances-inl.h</innerfile>
     <innerfile refid="extra__distances_8h">extra_distances.h</innerfile>
+    <innerfile refid="fp16-arm_8h">fp16-arm.h</innerfile>
     <innerfile refid="fp16-fp16c_8h">fp16-fp16c.h</innerfile>
     <innerfile refid="fp16-inl_8h">fp16-inl.h</innerfile>
     <innerfile refid="fp16_8h">fp16.h</innerfile>

diff --git a/xml/fp16-arm_8h.xml b/xml/fp16-arm_8h.xml
@@ -0,0 +1,61 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
+  <compounddef id="fp16-arm_8h" kind="file" language="C++">
+    <compoundname>fp16-arm.h</compoundname>
+    <includes local="no">arm_neon.h</includes>
+    <includes local="no">cstdint</includes>
+    <incdepgraph>
+      <node id="2">
+        <label>arm_neon.h</label>
+      </node>
+      <node id="3">
+        <label>cstdint</label>
+      </node>
+      <node id="1">
+        <label>faiss/utils/fp16-arm.h</label>
+        <link refid="fp16-arm_8h"/>
+        <childnode refid="2" relation="include">
+        </childnode>
+        <childnode refid="3" relation="include">
+        </childnode>
+      </node>
+    </incdepgraph>
+    <innernamespace refid="namespacefaiss">faiss</innernamespace>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline lineno="1"><highlight class="comment">/**</highlight></codeline>
+<codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
+<codeline lineno="3"><highlight class="comment"><sp/>*</highlight></codeline>
+<codeline lineno="4"><highlight class="comment"><sp/>*<sp/>This<sp/>source<sp/>code<sp/>is<sp/>licensed<sp/>under<sp/>the<sp/>MIT<sp/>license<sp/>found<sp/>in<sp/>the</highlight></codeline>
+<codeline lineno="5"><highlight class="comment"><sp/>*<sp/>LICENSE<sp/>file<sp/>in<sp/>the<sp/>root<sp/>directory<sp/>of<sp/>this<sp/>source<sp/>tree.</highlight></codeline>
+<codeline lineno="6"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="7"><highlight class="normal"></highlight></codeline>
+<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="9"><highlight class="normal"></highlight></codeline>
+<codeline lineno="10"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;arm_neon.h&gt;</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="11"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;cstdint&gt;</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="12"><highlight class="normal"></highlight></codeline>
+<codeline lineno="13"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespacefaiss" kindref="compound">faiss</ref><sp/>{</highlight></codeline>
+<codeline lineno="14"><highlight class="normal"></highlight></codeline>
+<codeline lineno="15"><highlight class="normal"></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/>uint16_t<sp/>encode_fp16(</highlight><highlight class="keywordtype">float</highlight><highlight class="normal"><sp/>x)<sp/>{</highlight></codeline>
+<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/>float32x4_t<sp/>fx4<sp/>=<sp/>vdupq_n_f32(x);</highlight></codeline>
+<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/>float16x4_t<sp/>f16x4<sp/>=<sp/>vcvt_f16_f32(fx4);</highlight></codeline>
+<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/>uint16x4_t<sp/>ui16x4<sp/>=<sp/>vreinterpret_u16_f16(f16x4);</highlight></codeline>
+<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>vduph_lane_u16(ui16x4,<sp/>3);</highlight></codeline>
+<codeline lineno="20"><highlight class="normal">}</highlight></codeline>
+<codeline lineno="21"><highlight class="normal"></highlight></codeline>
+<codeline lineno="22"><highlight class="normal"></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal"><sp/>decode_fp16(uint16_t<sp/>x)<sp/>{</highlight></codeline>
+<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/>uint16x4_t<sp/>ui16x4<sp/>=<sp/>vdup_n_u16(x);</highlight></codeline>
+<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/>float16x4_t<sp/>f16x4<sp/>=<sp/>vreinterpret_f16_u16(ui16x4);</highlight></codeline>
+<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>float32x4_t<sp/>fx4<sp/>=<sp/>vcvt_f32_f16(f16x4);</highlight></codeline>
+<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>vdups_laneq_f32(fx4,<sp/>3);</highlight></codeline>
+<codeline lineno="27"><highlight class="normal">}</highlight></codeline>
+<codeline lineno="28"><highlight class="normal"></highlight></codeline>
+<codeline lineno="29"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
+    </programlisting>
+    <location file="faiss/utils/fp16-arm.h"/>
+  </compounddef>
+</doxygen>
diff --git a/xml/fp16_8h.xml b/xml/fp16_8h.xml
@@ -81,9 +81,11 @@
 <codeline lineno="13"><highlight class="normal"></highlight></codeline>
 <codeline lineno="14"><highlight class="normal"></highlight><highlight class="preprocessor">#if<sp/>defined(__F16C__)</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="15"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;faiss/utils/fp16-fp16c.h&gt;</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="16"><highlight class="normal"></highlight><highlight class="preprocessor">#else</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="17"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;faiss/utils/fp16-inl.h&gt;</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="18"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight></codeline>
+<codeline lineno="16"><highlight class="normal"></highlight><highlight class="preprocessor">#elif<sp/>defined(__aarch64__)</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="17"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;faiss/utils/fp16-arm.h&gt;</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="18"><highlight class="normal"></highlight><highlight class="preprocessor">#else</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="19"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;faiss/utils/fp16-inl.h&gt;</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="20"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight></codeline>
     </programlisting>
     <location file="faiss/utils/fp16.h"/>
   </compounddef>

diff --git a/xml/index.xml b/xml/index.xml
@@ -8762,14 +8762,14 @@
     <member refid="namespacefaiss_1a0e26e4710a7c276f46b730d8ab6ac1e0" kind="function"><name>hash_bytes</name></member>
     <member refid="namespacefaiss_1ad86caef545c6a7672422d7d34c03f446" kind="function"><name>check_openmp</name></member>
   </compound>
-  <compound refid="namespacefaiss_1_1_0d138" kind="namespace"><name>faiss::@138</name>
-  </compound>
-  <compound refid="namespacefaiss_1_1_0d154" kind="namespace"><name>faiss::@154</name>
+  <compound refid="namespacefaiss_1_1_0d139" kind="namespace"><name>faiss::@139</name>
   </compound>
   <compound refid="namespacefaiss_1_1_0d155" kind="namespace"><name>faiss::@155</name>
   </compound>
   <compound refid="namespacefaiss_1_1_0d156" kind="namespace"><name>faiss::@156</name>
   </compound>
+  <compound refid="namespacefaiss_1_1_0d157" kind="namespace"><name>faiss::@157</name>
+  </compound>
   <compound refid="namespacefaiss_1_1cppcontrib" kind="namespace"><name>faiss::cppcontrib</name>
   </compound>
   <compound refid="namespacefaiss_1_1cppcontrib_1_1_0d10" kind="namespace"><name>faiss::cppcontrib::@10</name>
@@ -9406,6 +9406,8 @@
   </compound>
   <compound refid="extra__distances_8h" kind="file"><name>extra_distances.h</name>
   </compound>
+  <compound refid="fp16-arm_8h" kind="file"><name>fp16-arm.h</name>
+  </compound>
   <compound refid="fp16-fp16c_8h" kind="file"><name>fp16-fp16c.h</name>
   </compound>
   <compound refid="fp16-inl_8h" kind="file"><name>fp16-inl.h</name>

diff --git a/xml/namespacefaiss.xml b/xml/namespacefaiss.xml
@@ -5348,7 +5348,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/fp16-fp16c.h" line="15" column="17" bodyfile="faiss/utils/fp16-fp16c.h" bodystart="15" bodyend="20"/>
+        <location file="faiss/utils/fp16-arm.h" line="15" column="17" bodyfile="faiss/utils/fp16-arm.h" bodystart="15" bodyend="20"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ac3f112424a7957effd27187654d90986" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type>float</type>
@@ -5365,7 +5365,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/fp16-fp16c.h" line="22" column="14" bodyfile="faiss/utils/fp16-fp16c.h" bodystart="22" bodyend="26"/>
+        <location file="faiss/utils/fp16-arm.h" line="22" column="14" bodyfile="faiss/utils/fp16-arm.h" bodystart="22" bodyend="27"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a0e10b0864a93653945dbd950b9fcdacf" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>

diff --git a/xml/namespacefaiss_1_1_0d138.xml → xml/namespacefaiss_1_1_0d139.xml b/xml/namespacefaiss_1_1_0d138.xml → xml/namespacefaiss_1_1_0d139.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
-  <compounddef id="namespacefaiss_1_1_0d138" kind="namespace" language="C++">
-    <compoundname>faiss::@138</compoundname>
+  <compounddef id="namespacefaiss_1_1_0d139" kind="namespace" language="C++">
+    <compoundname>faiss::@139</compoundname>
     <briefdescription>
     </briefdescription>
     <detaileddescription>

diff --git a/xml/namespacefaiss_1_1_0d155.xml b/xml/namespacefaiss_1_1_0d155.xml
@@ -6,6 +6,6 @@
     </briefdescription>
     <detaileddescription>
     </detaileddescription>
-    <location file="faiss/utils/simdlib_emulated.h" line="896" column="1"/>
+    <location file="faiss/utils/simdlib_avx2.h" line="777" column="1"/>
   </compounddef>
 </doxygen>
diff --git a/xml/namespacefaiss_1_1_0d156.xml b/xml/namespacefaiss_1_1_0d156.xml
@@ -6,6 +6,6 @@
     </briefdescription>
     <detaileddescription>
     </detaileddescription>
-    <location file="faiss/utils/simdlib_neon.h" line="1331" column="1"/>
+    <location file="faiss/utils/simdlib_emulated.h" line="896" column="1"/>
   </compounddef>
 </doxygen>
diff --git a/xml/namespacefaiss_1_1_0d154.xml → xml/namespacefaiss_1_1_0d157.xml b/xml/namespacefaiss_1_1_0d154.xml → xml/namespacefaiss_1_1_0d157.xml
@@ -1,11 +1,11 @@
 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
-  <compounddef id="namespacefaiss_1_1_0d154" kind="namespace" language="C++">
-    <compoundname>faiss::@154</compoundname>
+  <compounddef id="namespacefaiss_1_1_0d157" kind="namespace" language="C++">
+    <compoundname>faiss::@157</compoundname>
     <briefdescription>
     </briefdescription>
     <detaileddescription>
     </detaileddescription>
-    <location file="faiss/utils/simdlib_avx2.h" line="777" column="1"/>
+    <location file="faiss/utils/simdlib_neon.h" line="1331" column="1"/>
   </compounddef>
 </doxygen>