Update API docs (fa60ae6).

facebookresearch · Sep 17, 2024 · ad6fbd0 · ad6fbd0
1 parent adf34a2
commit ad6fbd0
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 16 deletions.
diff --git a/xml/index.xml b/xml/index.xml
@@ -9101,6 +9101,9 @@
     <member refid="namespacefaiss_1a97af3c36835c195254ba0312b0f78140" kind="function"><name>read_direct_map</name></member>
     <member refid="namespacefaiss_1ae931529308da688bc1470f04e9b34bf2" kind="function"><name>read_ivf_header</name></member>
     <member refid="namespacefaiss_1acf993db387d508bb9e1d517d612138d0" kind="function"><name>read_InvertedLists</name></member>
+    <member refid="namespacefaiss_1aa12092ef91253e1539c474b4697f287f" kind="function"><name>set_array_invlist</name></member>
+    <member refid="namespacefaiss_1a4eae12c70887bff34241a726efb9ff02" kind="function"><name>read_ProductQuantizer</name></member>
+    <member refid="namespacefaiss_1a39ebc7cee79b9534f7a5d6d622ed0250" kind="function"><name>read_ScalarQuantizer</name></member>
     <member refid="namespacefaiss_1abf86b394ccff3a1d3d5e4b848740059c" kind="function"><name>fourcc</name></member>
     <member refid="namespacefaiss_1aa4aee5942eb92dbce17469f4bdd2e0a5" kind="function"><name>fourcc</name></member>
     <member refid="namespacefaiss_1aa2a1c19599e8fc0b8a3025d3386637b8" kind="function"><name>fourcc_inv</name></member>

diff --git a/xml/index__read__utils_8h.xml b/xml/index__read__utils_8h.xml
@@ -218,18 +218,25 @@
 <codeline lineno="16"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="17"><highlight class="normal"></highlight></codeline>
 <codeline lineno="18"><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="19"><highlight class="normal"></highlight></codeline>
-<codeline lineno="20"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_index_header(Index*<sp/>idx,<sp/>IOReader*<sp/>f);</highlight></codeline>
-<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_direct_map(DirectMap*<sp/>dm,<sp/>IOReader*<sp/>f);</highlight></codeline>
-<codeline lineno="22"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_ivf_header(</highlight></codeline>
-<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>IndexIVF*<sp/>ivf,</highlight></codeline>
-<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>IOReader*<sp/>f,</highlight></codeline>
-<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;std::vector&lt;idx_t&gt;&gt;*<sp/>ids<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">);</highlight></codeline>
-<codeline lineno="26"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_InvertedLists(IndexIVF*<sp/>ivf,<sp/>IOReader*<sp/>f,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>io_flags);</highlight></codeline>
-<codeline lineno="27"><highlight class="normal"></highlight></codeline>
-<codeline lineno="28"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
-<codeline lineno="29"><highlight class="normal"></highlight></codeline>
-<codeline lineno="30"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight></codeline>
+<codeline lineno="19"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">ProductQuantizer;</highlight></codeline>
+<codeline lineno="20"><highlight class="normal"></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">ScalarQuantizer;</highlight></codeline>
+<codeline lineno="21"><highlight class="normal"></highlight></codeline>
+<codeline lineno="22"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_index_header(Index*<sp/>idx,<sp/>IOReader*<sp/>f);</highlight></codeline>
+<codeline lineno="23"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_direct_map(DirectMap*<sp/>dm,<sp/>IOReader*<sp/>f);</highlight></codeline>
+<codeline lineno="24"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_ivf_header(</highlight></codeline>
+<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>IndexIVF*<sp/>ivf,</highlight></codeline>
+<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>IOReader*<sp/>f,</highlight></codeline>
+<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;std::vector&lt;idx_t&gt;&gt;*<sp/>ids<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">);</highlight></codeline>
+<codeline lineno="28"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_InvertedLists(IndexIVF*<sp/>ivf,<sp/>IOReader*<sp/>f,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>io_flags);</highlight></codeline>
+<codeline lineno="29"><highlight class="normal">ArrayInvertedLists*<sp/>set_array_invlist(</highlight></codeline>
+<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>IndexIVF*<sp/>ivf,</highlight></codeline>
+<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;std::vector&lt;idx_t&gt;&gt;&amp;<sp/>ids);</highlight></codeline>
+<codeline lineno="32"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_ProductQuantizer(ProductQuantizer*<sp/>pq,<sp/>IOReader*<sp/>f);</highlight></codeline>
+<codeline lineno="33"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>read_ScalarQuantizer(ScalarQuantizer*<sp/>ivsc,<sp/>IOReader*<sp/>f);</highlight></codeline>
+<codeline lineno="34"><highlight class="normal"></highlight></codeline>
+<codeline lineno="35"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="36"><highlight class="normal"></highlight></codeline>
+<codeline lineno="37"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight></codeline>
     </programlisting>
     <location file="faiss/impl/index_read_utils.h"/>
   </compounddef>

diff --git a/xml/namespacefaiss.xml b/xml/namespacefaiss.xml
@@ -1520,7 +1520,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/impl/index_read_utils.h" line="20" column="6" declfile="faiss/impl/index_read_utils.h" declline="20" declcolumn="6"/>
+        <location file="faiss/impl/index_read_utils.h" line="22" column="6" declfile="faiss/impl/index_read_utils.h" declline="22" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1a97af3c36835c195254ba0312b0f78140" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -1541,7 +1541,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/impl/index_read_utils.h" line="21" column="6" declfile="faiss/impl/index_read_utils.h" declline="21" declcolumn="6"/>
+        <location file="faiss/impl/index_read_utils.h" line="23" column="6" declfile="faiss/impl/index_read_utils.h" declline="23" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1ae931529308da688bc1470f04e9b34bf2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -1567,7 +1567,7 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/impl/index_read_utils.h" line="22" column="6" declfile="faiss/impl/index_read_utils.h" declline="22" declcolumn="6"/>
+        <location file="faiss/impl/index_read_utils.h" line="24" column="6" declfile="faiss/impl/index_read_utils.h" declline="24" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1acf993db387d508bb9e1d517d612138d0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>void</type>
@@ -1592,7 +1592,70 @@
         </detaileddescription>
         <inbodydescription>
         </inbodydescription>
-        <location file="faiss/impl/index_read_utils.h" line="26" column="6" declfile="faiss/impl/index_read_utils.h" declline="26" declcolumn="6"/>
+        <location file="faiss/impl/index_read_utils.h" line="28" column="6" declfile="faiss/impl/index_read_utils.h" declline="28" declcolumn="6"/>
+      </memberdef>
+      <memberdef kind="function" id="namespacefaiss_1aa12092ef91253e1539c474b4697f287f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+        <type><ref refid="structfaiss_1_1ArrayInvertedLists" kindref="compound">ArrayInvertedLists</ref> *</type>
+        <definition>ArrayInvertedLists* faiss::set_array_invlist</definition>
+        <argsstring>(IndexIVF *ivf, std::vector&lt; std::vector&lt; idx_t &gt;&gt; &amp;ids)</argsstring>
+        <name>set_array_invlist</name>
+        <param>
+          <type><ref refid="structfaiss_1_1IndexIVF" kindref="compound">IndexIVF</ref> *</type>
+          <declname>ivf</declname>
+        </param>
+        <param>
+          <type>std::vector&lt; std::vector&lt; <ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref> &gt;&gt; &amp;</type>
+          <declname>ids</declname>
+        </param>
+        <briefdescription>
+        </briefdescription>
+        <detaileddescription>
+        </detaileddescription>
+        <inbodydescription>
+        </inbodydescription>
+        <location file="faiss/impl/index_read_utils.h" line="29" column="20" declfile="faiss/impl/index_read_utils.h" declline="29" declcolumn="20"/>
+      </memberdef>
+      <memberdef kind="function" id="namespacefaiss_1a4eae12c70887bff34241a726efb9ff02" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+        <type>void</type>
+        <definition>void faiss::read_ProductQuantizer</definition>
+        <argsstring>(ProductQuantizer *pq, IOReader *f)</argsstring>
+        <name>read_ProductQuantizer</name>
+        <param>
+          <type><ref refid="structfaiss_1_1ProductQuantizer" kindref="compound">ProductQuantizer</ref> *</type>
+          <declname>pq</declname>
+        </param>
+        <param>
+          <type><ref refid="structfaiss_1_1IOReader" kindref="compound">IOReader</ref> *</type>
+          <declname>f</declname>
+        </param>
+        <briefdescription>
+        </briefdescription>
+        <detaileddescription>
+        </detaileddescription>
+        <inbodydescription>
+        </inbodydescription>
+        <location file="faiss/impl/index_read_utils.h" line="32" column="6" declfile="faiss/impl/index_read_utils.h" declline="32" declcolumn="6"/>
+      </memberdef>
+      <memberdef kind="function" id="namespacefaiss_1a39ebc7cee79b9534f7a5d6d622ed0250" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
+        <type>void</type>
+        <definition>void faiss::read_ScalarQuantizer</definition>
+        <argsstring>(ScalarQuantizer *ivsc, IOReader *f)</argsstring>
+        <name>read_ScalarQuantizer</name>
+        <param>
+          <type><ref refid="structfaiss_1_1ScalarQuantizer" kindref="compound">ScalarQuantizer</ref> *</type>
+          <declname>ivsc</declname>
+        </param>
+        <param>
+          <type><ref refid="structfaiss_1_1IOReader" kindref="compound">IOReader</ref> *</type>
+          <declname>f</declname>
+        </param>
+        <briefdescription>
+        </briefdescription>
+        <detaileddescription>
+        </detaileddescription>
+        <inbodydescription>
+        </inbodydescription>
+        <location file="faiss/impl/index_read_utils.h" line="33" column="6" declfile="faiss/impl/index_read_utils.h" declline="33" declcolumn="6"/>
       </memberdef>
       <memberdef kind="function" id="namespacefaiss_1abf86b394ccff3a1d3d5e4b848740059c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
         <type>uint32_t</type>