Update API docs (dc8d29a).

facebookresearch · Jan 24, 2025 · d7fc851 · d7fc851
1 parent 7019d51
commit d7fc851
Show file tree

Hide file tree

Showing 4 changed files with 150 additions and 149 deletions.
diff --git a/xml/namespacefaiss.xml b/xml/namespacefaiss.xml
@@ -10544,13 +10544,13 @@
           <declname>assign</declname>
         </param>
         <briefdescription>
-<para>a balanced assignment has a IF of 1 </para>
         </briefdescription>
         <detaileddescription>
+<para>a balanced assignment has a IF of 1, a completely unbalanced assignment has an IF = k. </para>
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="94" column="8" declfile="faiss/utils/utils.h" declline="94" declcolumn="8"/>
+        <location file="faiss/utils/utils.h" line="95" column="8" declfile="faiss/utils/utils.h" declline="95" declcolumn="8"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a94c1d99ac39d22e362aa27ce7c7ff714" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>double</type>
@@ -10573,7 +10573,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="97" column="8" declfile="faiss/utils/utils.h" declline="97" declcolumn="8"/>
+        <location file="faiss/utils/utils.h" line="98" column="8" declfile="faiss/utils/utils.h" declline="98" declcolumn="8"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a7bea462108bee98d8d5859b51ec4db8e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>int</type>
@@ -10604,7 +10604,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="100" column="5" declfile="faiss/utils/utils.h" declline="100" declcolumn="5"/>
+        <location file="faiss/utils/utils.h" line="101" column="5" declfile="faiss/utils/utils.h" declline="101" declcolumn="5"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a154a47857ed321b9db91122770a16e09" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -10653,7 +10653,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="107" column="6" declfile="faiss/utils/utils.h" declline="107" declcolumn="6"/>
+        <location file="faiss/utils/utils.h" line="108" column="6" declfile="faiss/utils/utils.h" declline="108" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a9961a06bc9beb19366bb0437e11ac962" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>uint64_t</type>
@@ -10676,7 +10676,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="110" column="10" declfile="faiss/utils/utils.h" declline="110" declcolumn="10"/>
+        <location file="faiss/utils/utils.h" line="111" column="10" declfile="faiss/utils/utils.h" declline="111" declcolumn="10"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ade786759a9b5dbd0b2329966756c0b77" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>uint64_t</type>
@@ -10699,7 +10699,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="113" column="10" declfile="faiss/utils/utils.h" declline="113" declcolumn="10"/>
+        <location file="faiss/utils/utils.h" line="114" column="10" declfile="faiss/utils/utils.h" declline="114" declcolumn="10"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a2de355ba1527a128fdd6895a4a9cdd7a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -10764,7 +10764,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="122" column="6" declfile="faiss/utils/utils.h" declline="122" declcolumn="6"/>
+        <location file="faiss/utils/utils.h" line="123" column="6" declfile="faiss/utils/utils.h" declline="123" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a184bb08545d1f469662b75b2f33a899f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>const float *</type>
@@ -10849,7 +10849,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="133" column="13" declfile="faiss/utils/utils.h" declline="133" declcolumn="13"/>
+        <location file="faiss/utils/utils.h" line="134" column="13" declfile="faiss/utils/utils.h" declline="134" declcolumn="13"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ac8260e10cfeed08a4344b85845773e16" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -10902,7 +10902,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="147" column="6" declfile="faiss/utils/utils.h" declline="147" declcolumn="6"/>
+        <location file="faiss/utils/utils.h" line="148" column="6" declfile="faiss/utils/utils.h" declline="148" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ab491c9e2f77a750c9f0324bfe00e3e57" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -10955,7 +10955,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="156" column="6" declfile="faiss/utils/utils.h" declline="156" declcolumn="6"/>
+        <location file="faiss/utils/utils.h" line="157" column="6" declfile="faiss/utils/utils.h" declline="157" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a0e26e4710a7c276f46b730d8ab6ac1e0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>uint64_t</type>
@@ -10978,7 +10978,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="159" column="10" declfile="faiss/utils/utils.h" declline="159" declcolumn="10"/>
+        <location file="faiss/utils/utils.h" line="160" column="10" declfile="faiss/utils/utils.h" declline="160" declcolumn="10"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ad86caef545c6a7672422d7d34c03f446" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>bool</type>
@@ -10993,7 +10993,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="162" column="6" declfile="faiss/utils/utils.h" declline="162" declcolumn="6"/>
+        <location file="faiss/utils/utils.h" line="163" column="6" declfile="faiss/utils/utils.h" declline="163" declcolumn="6"/>
       </memberdef>
     </sectiondef>
     <briefdescription>

diff --git a/xml/structfaiss_1_1CodeSet.xml b/xml/structfaiss_1_1CodeSet.xml
@@ -15,7 +15,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="199" column="12" bodyfile="faiss/utils/utils.h" bodystart="199" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="200" column="12" bodyfile="faiss/utils/utils.h" bodystart="200" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CodeSet_1afedcaf6cc25213d3d442d0f2f14f60cc" prot="public" static="no" mutable="no">
         <type>std::set&lt; std::vector&lt; uint8_t &gt; &gt;</type>
@@ -29,7 +29,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="200" column="14" bodyfile="faiss/utils/utils.h" bodystart="200" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="201" column="14" bodyfile="faiss/utils/utils.h" bodystart="201" bodyend="-1"/>
       </memberdef>
     </sectiondef>
     <sectiondef kind="public-func">
@@ -49,7 +49,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="202" column="14" bodyfile="faiss/utils/utils.h" bodystart="202" bodyend="202"/>
+        <location file="faiss/utils/utils.h" line="203" column="14" bodyfile="faiss/utils/utils.h" bodystart="203" bodyend="203"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1CodeSet_1a427b0b7caf3bd66c1f27e841ce95d23b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -75,14 +75,14 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="203" column="10"/>
+        <location file="faiss/utils/utils.h" line="204" column="10"/>
       </memberdef>
     </sectiondef>
     <briefdescription>
     </briefdescription>
     <detaileddescription>
     </detaileddescription>
-    <location file="faiss/utils/utils.h" line="198" column="1" bodyfile="faiss/utils/utils.h" bodystart="198" bodyend="204"/>
+    <location file="faiss/utils/utils.h" line="199" column="1" bodyfile="faiss/utils/utils.h" bodystart="199" bodyend="205"/>
     <listofallmembers>
       <member refid="structfaiss_1_1CodeSet_1a86a72861d902f0f51c946ede725cef58" prot="public" virt="non-virtual"><scope>faiss::CodeSet</scope><name>CodeSet</name></member>
       <member refid="structfaiss_1_1CodeSet_1a011bcc10cd3486f406cbf6b02e606c9e" prot="public" virt="non-virtual"><scope>faiss::CodeSet</scope><name>d</name></member>

diff --git a/xml/structfaiss_1_1CombinerRangeKNN.xml b/xml/structfaiss_1_1CombinerRangeKNN.xml
@@ -21,7 +21,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="169" column="13" bodyfile="faiss/utils/utils.h" bodystart="169" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="170" column="13" bodyfile="faiss/utils/utils.h" bodystart="170" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a512c0573e1f6d06edbd52efc713bd87e" prot="public" static="no" mutable="no">
         <type>size_t</type>
@@ -36,7 +36,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="170" column="12" bodyfile="faiss/utils/utils.h" bodystart="170" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="171" column="12" bodyfile="faiss/utils/utils.h" bodystart="171" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a533c4abee4eda14e5d3d7c1aa9ae00fa" prot="public" static="no" mutable="no">
         <type>T</type>
@@ -51,7 +51,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="171" column="7" bodyfile="faiss/utils/utils.h" bodystart="171" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="172" column="7" bodyfile="faiss/utils/utils.h" bodystart="172" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a2bfdb0e40d08040b47b2684fec5f0674" prot="public" static="no" mutable="no">
         <type>bool</type>
@@ -66,7 +66,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="172" column="10" bodyfile="faiss/utils/utils.h" bodystart="172" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="173" column="10" bodyfile="faiss/utils/utils.h" bodystart="173" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a092c91d01f6227c4acc437d0d2805e2e" prot="public" static="no" mutable="no">
         <type>const int64_t *</type>
@@ -82,7 +82,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="178" column="19" bodyfile="faiss/utils/utils.h" bodystart="178" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="179" column="19" bodyfile="faiss/utils/utils.h" bodystart="179" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1adb040f0aab9e0822cf97b7ae8f77554c" prot="public" static="no" mutable="no">
         <type>const T *</type>
@@ -98,7 +98,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="179" column="13" bodyfile="faiss/utils/utils.h" bodystart="179" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="180" column="13" bodyfile="faiss/utils/utils.h" bodystart="180" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a99ffc825bff4b6bc07b5e3f3087d5a4d" prot="public" static="no" mutable="no">
         <type>const bool *</type>
@@ -116,7 +116,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="182" column="16" bodyfile="faiss/utils/utils.h" bodystart="182" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="183" column="16" bodyfile="faiss/utils/utils.h" bodystart="183" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1af170c7fc6b3ff56a93f0a0141a49265d" prot="public" static="no" mutable="no">
         <type>const int64_t *</type>
@@ -132,7 +132,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="185" column="19" bodyfile="faiss/utils/utils.h" bodystart="185" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="186" column="19" bodyfile="faiss/utils/utils.h" bodystart="186" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a8a4621b4b68545cbd08269086be63fa6" prot="public" static="no" mutable="no">
         <type>const T *</type>
@@ -148,7 +148,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="186" column="13" bodyfile="faiss/utils/utils.h" bodystart="186" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="187" column="13" bodyfile="faiss/utils/utils.h" bodystart="187" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1a328ba7a9c54628328b3594d3e767abff" prot="public" static="no" mutable="no">
         <type>const int64_t *</type>
@@ -164,7 +164,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="187" column="19" bodyfile="faiss/utils/utils.h" bodystart="187" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="188" column="19" bodyfile="faiss/utils/utils.h" bodystart="188" bodyend="-1"/>
       </memberdef>
       <memberdef kind="variable" id="structfaiss_1_1CombinerRangeKNN_1aa14fedf775fc3f0a1f060d693be75430" prot="public" static="no" mutable="no">
         <type>const int64_t *</type>
@@ -180,7 +180,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="189" column="19" bodyfile="faiss/utils/utils.h" bodystart="189" bodyend="-1"/>
+        <location file="faiss/utils/utils.h" line="190" column="19" bodyfile="faiss/utils/utils.h" bodystart="190" bodyend="-1"/>
       </memberdef>
     </sectiondef>
     <sectiondef kind="public-func">
@@ -213,7 +213,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="174" column="5" bodyfile="faiss/utils/utils.h" bodystart="174" bodyend="175"/>
+        <location file="faiss/utils/utils.h" line="175" column="5" bodyfile="faiss/utils/utils.h" bodystart="175" bodyend="176"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1CombinerRangeKNN_1adbefea1de2c511a05d0980eaa7134fca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -232,7 +232,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="191" column="10"/>
+        <location file="faiss/utils/utils.h" line="192" column="10"/>
       </memberdef>
       <memberdef kind="function" id="structfaiss_1_1CombinerRangeKNN_1ae4dc62c36a66b7ebfc3076f2a35a911f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -255,15 +255,15 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/utils/utils.h" line="195" column="10"/>
+        <location file="faiss/utils/utils.h" line="196" column="10"/>
       </memberdef>
     </sectiondef>
     <briefdescription>
     </briefdescription>
     <detaileddescription>
 <para>This class is used to combine range and knn search results in contrib.exhaustive_search.range_search_gpu </para>
     </detaileddescription>
-    <location file="faiss/utils/utils.h" line="168" column="1" bodyfile="faiss/utils/utils.h" bodystart="168" bodyend="196"/>
+    <location file="faiss/utils/utils.h" line="169" column="1" bodyfile="faiss/utils/utils.h" bodystart="169" bodyend="197"/>
     <listofallmembers>
       <member refid="structfaiss_1_1CombinerRangeKNN_1a74330b6afb5296263e2a53482178c35d" prot="public" virt="non-virtual"><scope>faiss::CombinerRangeKNN</scope><name>CombinerRangeKNN</name></member>
       <member refid="structfaiss_1_1CombinerRangeKNN_1adbefea1de2c511a05d0980eaa7134fca" prot="public" virt="non-virtual"><scope>faiss::CombinerRangeKNN</scope><name>compute_sizes</name></member>