Update API docs (db09984).

facebookresearch · Jan 8, 2024 · 73b6d31 · 73b6d31
1 parent 00bba5f
commit 73b6d31
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 43 deletions.
diff --git a/xml/index.xml b/xml/index.xml
@@ -631,7 +631,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ad0e9987bf1e7eca3084c795b0418424c" kind="variable"><name>dis</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ae9a4140b96289ff6918416abc1a93fd0" kind="variable"><name>i0</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a40bf222bea1ddba3454e07c9a4298995" kind="function"><name>handle</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ab0abb992487f720ef958ee8f6210fa3a" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a630083ce5e9d5bea4ae79592981087be" kind="function"><name>set_block_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a0c466901ad10190f156b680a2611e2d2" kind="function"><name>to_other_handler</name></member>
   </compound>
   <compound refid="structfaiss_1_1FlatCodesDistanceComputer" kind="struct"><name>faiss::FlatCodesDistanceComputer</name>
@@ -1621,7 +1621,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1aebd97e6c76eed4bad95eb6424d543dea" kind="function"><name>HeapHandler</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1a620040a758885b805334c89fd0f33f08" kind="function"><name>handle</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1ac0f70c6234e6d861d5e7aa7ff043a740" kind="function"><name>to_flat_arrays</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" kind="function"><name>set_block_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1afe0eeae1df6f7f6e49098930579b8ac6" kind="function"><name>adjust_with_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a0291967a32bfe5fd8c94fa9b603ef8d6" kind="function"><name>adjust_id</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ad18cf2a8b69cd1f760e3af6b9ef296ee" kind="function"><name>get_lt_mask</name></member>
@@ -7162,7 +7162,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1ReservoirHandler_1ad136f3a43541d2b04583d85f288e885f" kind="function"><name>ReservoirHandler</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1ReservoirHandler_1a795767a8ccf821c981f455e0cdd28db4" kind="function"><name>handle</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1ReservoirHandler_1a824aa28ca00ee6b43b1c06e34a590cc1" kind="function"><name>to_flat_arrays</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" kind="function"><name>set_block_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1afe0eeae1df6f7f6e49098930579b8ac6" kind="function"><name>adjust_with_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a0291967a32bfe5fd8c94fa9b603ef8d6" kind="function"><name>adjust_id</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ad18cf2a8b69cd1f760e3af6b9ef296ee" kind="function"><name>get_lt_mask</name></member>
@@ -7776,7 +7776,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a45d6be4e851264371325bf032a147048" kind="variable"><name>q_map</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a2d7b0e5943fb421bc6de7fa2731a266b" kind="variable"><name>dbias</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a826599a28cdb21613809bffd223128d8" kind="function"><name>SIMDResultHandler</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" kind="function"><name>set_block_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1afe0eeae1df6f7f6e49098930579b8ac6" kind="function"><name>adjust_with_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a0291967a32bfe5fd8c94fa9b603ef8d6" kind="function"><name>adjust_id</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ad18cf2a8b69cd1f760e3af6b9ef296ee" kind="function"><name>get_lt_mask</name></member>
@@ -7873,7 +7873,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1SingleResultHandler_1a6420072970f6b0bc1354fd324e794646" kind="function"><name>SingleResultHandler</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SingleResultHandler_1a07c3dddd613025d73c1b0d2c0936087d" kind="function"><name>handle</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SingleResultHandler_1a93e46f10cd5484e54dcc6044cbb5276f" kind="function"><name>to_flat_arrays</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" kind="function"><name>set_block_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1afe0eeae1df6f7f6e49098930579b8ac6" kind="function"><name>adjust_with_origin</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a0291967a32bfe5fd8c94fa9b603ef8d6" kind="function"><name>adjust_id</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ad18cf2a8b69cd1f760e3af6b9ef296ee" kind="function"><name>get_lt_mask</name></member>
@@ -8089,7 +8089,7 @@
     <member refid="structfaiss_1_1simd__result__handlers_1_1StoreResultHandler_1a1e9dabad5a45552c7ce7740604d0bcc7" kind="variable"><name>j0</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1StoreResultHandler_1a3b64e8061ed3d37d9c1d456709299824" kind="function"><name>StoreResultHandler</name></member>
     <member refid="structfaiss_1_1simd__result__handlers_1_1StoreResultHandler_1afb11f0d74a627fe4d9e100e5a41072d6" kind="function"><name>handle</name></member>
-    <member refid="structfaiss_1_1simd__result__handlers_1_1StoreResultHandler_1aaa5cf567373cdbe5f00aa927627974af" kind="function"><name>set_block_origin</name></member>
+    <member refid="structfaiss_1_1simd__result__handlers_1_1StoreResultHandler_1a2132dd4c40f73dc978caeb7ff538dd13" kind="function"><name>set_block_origin</name></member>
   </compound>
   <compound refid="classfaiss_1_1ThreadedIndex" kind="class"><name>faiss::ThreadedIndex</name>
     <member refid="classfaiss_1_1ThreadedIndex_1a1223180acd3979e7205c91d2dba9d306" kind="variable"><name>own_indices</name></member>

diff --git a/xml/simd__result__handlers_8h.xml b/xml/simd__result__handlers_8h.xml
@@ -235,9 +235,9 @@
 <codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>d1.store(data<sp/>+<sp/>ofs<sp/>+<sp/>16);</highlight></codeline>
 <codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="63"><highlight class="normal"></highlight></codeline>
-<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0)<sp/>{</highlight></codeline>
-<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0;</highlight></codeline>
-<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;j0<sp/>=<sp/>j0;</highlight></codeline>
+<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0_2,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0_2)<sp/>{</highlight></codeline>
+<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0_2;</highlight></codeline>
+<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;j0<sp/>=<sp/>j0_2;</highlight></codeline>
 <codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="68"><highlight class="normal">};</highlight></codeline>
 <codeline lineno="69"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
@@ -252,8 +252,8 @@
 <codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>dis[q<sp/>+<sp/>i0][2<sp/>*<sp/>b<sp/>+<sp/>1]<sp/>=<sp/>d1;</highlight></codeline>
 <codeline lineno="79"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="80"><highlight class="normal"></highlight></codeline>
-<codeline lineno="81"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0)<sp/>{</highlight></codeline>
-<codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0;</highlight></codeline>
+<codeline lineno="81"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0_2,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0)<sp/>{</highlight></codeline>
+<codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0_2;</highlight></codeline>
 <codeline lineno="83"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>assert(j0<sp/>==<sp/>0);</highlight></codeline>
 <codeline lineno="84"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="85"><highlight class="normal"></highlight></codeline>
@@ -286,9 +286,9 @@
 <codeline lineno="112"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler" kindref="compound">SIMDResultHandler</ref>(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>ntotal)</highlight></codeline>
 <codeline lineno="113"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>:<sp/>ntotal(ntotal),<sp/><ref refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ae66d2d2290c018b377f50898b2323dab" kindref="member">id_map</ref>(nullptr),<sp/>q_map(nullptr),<sp/>dbias(nullptr)<sp/>{}</highlight></codeline>
 <codeline lineno="114"><highlight class="normal"></highlight></codeline>
-<codeline lineno="115"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0)<sp/>{</highlight></codeline>
-<codeline lineno="116"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0;</highlight></codeline>
-<codeline lineno="117"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;j0<sp/>=<sp/>j0;</highlight></codeline>
+<codeline lineno="115"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>set_block_origin(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>i0_2,<sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>j0_2)<sp/>{</highlight></codeline>
+<codeline lineno="116"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;i0<sp/>=<sp/>i0_2;</highlight></codeline>
+<codeline lineno="117"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>this-&gt;j0<sp/>=<sp/>j0_2;</highlight></codeline>
 <codeline lineno="118"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
 <codeline lineno="119"><highlight class="normal"></highlight></codeline>
 <codeline lineno="120"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>adjust<sp/>handler<sp/>data<sp/>for<sp/>IVF.</highlight><highlight class="normal"></highlight></codeline>

diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml
@@ -74,14 +74,14 @@
         </inbodydescription>
         <location file="faiss/impl/simd_result_handlers.h" line="76" column="10" bodyfile="faiss/impl/simd_result_handlers.h" bodystart="76" bodyend="79"/>
       </memberdef>
-      <memberdef kind="function" id="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ab0abb992487f720ef958ee8f6210fa3a" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
+      <memberdef kind="function" id="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a630083ce5e9d5bea4ae79592981087be" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type>void</type>
         <definition>void faiss::simd_result_handlers::FixedStorageHandler&lt; NQ, BB &gt;::set_block_origin</definition>
-        <argsstring>(size_t i0, size_t j0)</argsstring>
+        <argsstring>(size_t i0_2, size_t j0)</argsstring>
         <name>set_block_origin</name>
         <param>
           <type>size_t</type>
-          <declname>i0</declname>
+          <declname>i0_2</declname>
         </param>
         <param>
           <type>size_t</type>
@@ -149,7 +149,7 @@
       <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ad0e9987bf1e7eca3084c795b0418424c" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>dis</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a40bf222bea1ddba3454e07c9a4298995" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>handle</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ae9a4140b96289ff6918416abc1a93fd0" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>i0</name></member>
-      <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1ab0abb992487f720ef958ee8f6210fa3a" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>set_block_origin</name></member>
+      <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a630083ce5e9d5bea4ae79592981087be" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>set_block_origin</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler_1a0c466901ad10190f156b680a2611e2d2" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::FixedStorageHandler</scope><name>to_other_handler</name></member>
     </listofallmembers>
   </compounddef>

diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml
@@ -279,18 +279,18 @@
         </inbodydescription>
         <location file="faiss/impl/simd_result_handlers.h" line="316" column="10" bodyfile="faiss/impl/simd_result_handlers.h" bodystart="316" bodyend="337"/>
       </memberdef>
-      <memberdef kind="function" id="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
+      <memberdef kind="function" id="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
         <type>void</type>
         <definition>void faiss::simd_result_handlers::SIMDResultHandler&lt; C, with_id_map &gt;::set_block_origin</definition>
-        <argsstring>(size_t i0, size_t j0)</argsstring>
+        <argsstring>(size_t i0_2, size_t j0_2)</argsstring>
         <name>set_block_origin</name>
         <param>
           <type>size_t</type>
-          <declname>i0</declname>
+          <declname>i0_2</declname>
         </param>
         <param>
           <type>size_t</type>
-          <declname>j0</declname>
+          <declname>j0_2</declname>
         </param>
         <briefdescription>
         </briefdescription>
@@ -424,7 +424,7 @@
       <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1a41a837ec51ed5f4e5e7a3695a8fd03cb" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>nq</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac2bd6d06d7bb0a7dfc8b4cf286ce8ee7" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>ntotal</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a45d6be4e851264371325bf032a147048" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>q_map</name></member>
-      <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a9e3e93cdfcbf7e3316e99bf6bd877615" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>set_block_origin</name></member>
+      <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1ac986d29b1b1253b8f9f03c44f3486509" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>set_block_origin</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1SIMDResultHandler_1a826599a28cdb21613809bffd223128d8" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>SIMDResultHandler</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1a85e527b03ac85f7f45a73b9453433a5c" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>T</name></member>
       <member refid="structfaiss_1_1simd__result__handlers_1_1HeapHandler_1a23abc38e0c0857182c02f20ee97d269e" prot="public" virt="non-virtual"><scope>faiss::simd_result_handlers::HeapHandler</scope><name>TI</name></member>