Update API docs (a233bc9).

facebookresearch · Apr 26, 2024 · 68441f6 · 68441f6
1 parent b383622
commit 68441f6
Show file tree

Hide file tree

Showing 15 changed files with 946 additions and 877 deletions.
diff --git a/xml/InvertedLists_8h.xml b/xml/InvertedLists_8h.xml
diff --git a/xml/index.xml b/xml/index.xml
diff --git a/xml/namespacefaiss.xml b/xml/namespacefaiss.xml
@@ -484,7 +484,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="318" column="1" bodyfile="faiss/invlists/InvertedLists.h" bodystart="318" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="327" column="1" bodyfile="faiss/invlists/InvertedLists.h" bodystart="327" bodyend="-1"/>
       </memberdef>
       <memberdef kind="typedef" id="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" prot="public" static="no">
         <type>int64_t</type>

diff --git a/xml/structfaiss_1_1ArrayInvertedLists.xml b/xml/structfaiss_1_1ArrayInvertedLists.xml
diff --git a/xml/structfaiss_1_1BlockInvertedLists.xml b/xml/structfaiss_1_1BlockInvertedLists.xml
diff --git a/xml/structfaiss_1_1HStackInvertedLists.xml b/xml/structfaiss_1_1HStackInvertedLists.xml
diff --git a/xml/structfaiss_1_1InvertedLists.xml b/xml/structfaiss_1_1InvertedLists.xml
diff --git a/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml b/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml
@@ -14,7 +14,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="214" column="29" bodyfile="faiss/invlists/InvertedLists.h" bodystart="214" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="220" column="29" bodyfile="faiss/invlists/InvertedLists.h" bodystart="220" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_1a926fbb54841811b8457ac7e2aa815735" prot="public" static="no" mutable="no">
         <type>const uint8_t *</type>
@@ -27,7 +27,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="215" column="23" bodyfile="faiss/invlists/InvertedLists.h" bodystart="215" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="221" column="23" bodyfile="faiss/invlists/InvertedLists.h" bodystart="221" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_1a7f659101d92e5a7b02cdbc780aeb3fd8" prot="public" static="no" mutable="no">
         <type>size_t</type>
@@ -40,7 +40,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="216" column="16" bodyfile="faiss/invlists/InvertedLists.h" bodystart="216" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="222" column="16" bodyfile="faiss/invlists/InvertedLists.h" bodystart="222" bodyend="-1"/>
       </memberdef>
       </sectiondef>
       <sectiondef kind="public-func">
@@ -63,7 +63,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="218" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="218" bodyend="219"/>
+        <location file="faiss/invlists/InvertedLists.h" line="224" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="224" bodyend="225"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_1a78ff6ddb3ec12e8adba11e9637ef98d1" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type></type>
@@ -88,7 +88,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="221" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="221" bodyend="224"/>
+        <location file="faiss/invlists/InvertedLists.h" line="227" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="227" bodyend="230"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_1aaf6478daf36366fa07f1eb65065d942d" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type>const uint8_t *</type>
@@ -101,7 +101,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="226" column="23" bodyfile="faiss/invlists/InvertedLists.h" bodystart="226" bodyend="228"/>
+        <location file="faiss/invlists/InvertedLists.h" line="232" column="23" bodyfile="faiss/invlists/InvertedLists.h" bodystart="232" bodyend="234"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_1ac14920da79e4e6b758501401e72c6115" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type></type>
@@ -114,7 +114,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="230" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="230" bodyend="232"/>
+        <location file="faiss/invlists/InvertedLists.h" line="236" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="236" bodyend="238"/>
       </memberdef>
       </sectiondef>
     <briefdescription>
@@ -134,7 +134,7 @@
         </childnode>
       </node>
     </collaborationgraph>
-    <location file="faiss/invlists/InvertedLists.h" line="213" column="5" bodyfile="faiss/invlists/InvertedLists.h" bodystart="213" bodyend="233"/>
+    <location file="faiss/invlists/InvertedLists.h" line="219" column="5" bodyfile="faiss/invlists/InvertedLists.h" bodystart="219" bodyend="239"/>
     <listofallmembers>
       <member refid="structfaiss_1_1InvertedLists_1_1ScopedCodes_1a926fbb54841811b8457ac7e2aa815735" prot="public" virt="non-virtual"><scope>faiss::InvertedLists::ScopedCodes</scope><name>codes</name></member>
       <member refid="structfaiss_1_1InvertedLists_1_1ScopedCodes_1aaf6478daf36366fa07f1eb65065d942d" prot="public" virt="non-virtual"><scope>faiss::InvertedLists::ScopedCodes</scope><name>get</name></member>

diff --git a/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml b/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml
@@ -14,7 +14,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="193" column="29" bodyfile="faiss/invlists/InvertedLists.h" bodystart="193" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="199" column="29" bodyfile="faiss/invlists/InvertedLists.h" bodystart="199" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1InvertedLists_1_1ScopedIds_1af6da06a0f3fa92945bce458853a82899" prot="public" static="no" mutable="no">
         <type>const <ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref> *</type>
@@ -27,7 +27,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="194" column="21" bodyfile="faiss/invlists/InvertedLists.h" bodystart="194" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="200" column="21" bodyfile="faiss/invlists/InvertedLists.h" bodystart="200" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1InvertedLists_1_1ScopedIds_1a66f75ce4c81aaa2fa38f8e3de647354e" prot="public" static="no" mutable="no">
         <type>size_t</type>
@@ -40,7 +40,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="195" column="16" bodyfile="faiss/invlists/InvertedLists.h" bodystart="195" bodyend="-1"/>
+        <location file="faiss/invlists/InvertedLists.h" line="201" column="16" bodyfile="faiss/invlists/InvertedLists.h" bodystart="201" bodyend="-1"/>
       </memberdef>
       </sectiondef>
       <sectiondef kind="public-func">
@@ -63,7 +63,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="197" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="197" bodyend="198"/>
+        <location file="faiss/invlists/InvertedLists.h" line="203" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="203" bodyend="204"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedIds_1a8d364e731f2789a8856f5463f50e64e6" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type>const <ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref> *</type>
@@ -76,7 +76,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="200" column="21" bodyfile="faiss/invlists/InvertedLists.h" bodystart="200" bodyend="202"/>
+        <location file="faiss/invlists/InvertedLists.h" line="206" column="21" bodyfile="faiss/invlists/InvertedLists.h" bodystart="206" bodyend="208"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedIds_1a4773050fbb34aaabc0e2447626976ffa" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
         <type><ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref></type>
@@ -93,7 +93,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="204" column="15" bodyfile="faiss/invlists/InvertedLists.h" bodystart="204" bodyend="206"/>
+        <location file="faiss/invlists/InvertedLists.h" line="210" column="15" bodyfile="faiss/invlists/InvertedLists.h" bodystart="210" bodyend="212"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1InvertedLists_1_1ScopedIds_1ac4b3370c7075ef1b79a873588d3e44dc" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type></type>
@@ -106,7 +106,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/invlists/InvertedLists.h" line="208" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="208" bodyend="210"/>
+        <location file="faiss/invlists/InvertedLists.h" line="214" column="9" bodyfile="faiss/invlists/InvertedLists.h" bodystart="214" bodyend="216"/>
       </memberdef>
       </sectiondef>
     <briefdescription>
@@ -126,7 +126,7 @@
         </childnode>
       </node>
     </collaborationgraph>
-    <location file="faiss/invlists/InvertedLists.h" line="192" column="5" bodyfile="faiss/invlists/InvertedLists.h" bodystart="192" bodyend="211"/>
+    <location file="faiss/invlists/InvertedLists.h" line="198" column="5" bodyfile="faiss/invlists/InvertedLists.h" bodystart="198" bodyend="217"/>
     <listofallmembers>
       <member refid="structfaiss_1_1InvertedLists_1_1ScopedIds_1a8d364e731f2789a8856f5463f50e64e6" prot="public" virt="non-virtual"><scope>faiss::InvertedLists::ScopedIds</scope><name>get</name></member>
       <member refid="structfaiss_1_1InvertedLists_1_1ScopedIds_1af6da06a0f3fa92945bce458853a82899" prot="public" virt="non-virtual"><scope>faiss::InvertedLists::ScopedIds</scope><name>ids</name></member>