Update API docs (56b1087).

facebookresearch · Sep 28, 2023 · 0ff443e · 0ff443e
1 parent 8bf9251
commit 0ff443e
Show file tree

Hide file tree

Showing 6 changed files with 318 additions and 314 deletions.
diff --git a/xml/distances_8h.xml b/xml/distances_8h.xml
@@ -540,7 +540,30 @@
 <codeline lineno="434"><highlight class="comment"><sp/>*<sp/>Templatized<sp/>versions<sp/>of<sp/>distance<sp/>functions</highlight></codeline>
 <codeline lineno="435"><highlight class="comment"><sp/>***************************************************************************/</highlight><highlight class="normal"></highlight></codeline>
 <codeline lineno="436"><highlight class="normal"></highlight></codeline>
-<codeline lineno="437"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="437"><highlight class="normal"></highlight><highlight class="comment">/***************************************************************************</highlight></codeline>
+<codeline lineno="438"><highlight class="comment"><sp/>*<sp/>Misc<sp/><sp/>matrix<sp/>and<sp/>vector<sp/>manipulation<sp/>functions</highlight></codeline>
+<codeline lineno="439"><highlight class="comment"><sp/>***************************************************************************/</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="440"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
+<codeline lineno="441"><highlight class="comment">/**<sp/>compute<sp/>c<sp/>:=<sp/>a<sp/>+<sp/>bf<sp/>*<sp/>b<sp/>for<sp/>a,<sp/>b<sp/>and<sp/>c<sp/>tables</highlight></codeline>
+<codeline lineno="442"><highlight class="comment"><sp/>*</highlight></codeline>
+<codeline lineno="443"><highlight class="comment"><sp/>*<sp/>@param<sp/>n<sp/><sp/><sp/>size<sp/>of<sp/>the<sp/>tables</highlight></codeline>
+<codeline lineno="444"><highlight class="comment"><sp/>*<sp/>@param<sp/>a<sp/><sp/><sp/>size<sp/>n</highlight></codeline>
+<codeline lineno="445"><highlight class="comment"><sp/>*<sp/>@param<sp/>b<sp/><sp/><sp/>size<sp/>n</highlight></codeline>
+<codeline lineno="446"><highlight class="comment"><sp/>*<sp/>@param<sp/>c<sp/><sp/><sp/>restult<sp/>table,<sp/>size<sp/>n</highlight></codeline>
+<codeline lineno="447"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="448" refid="namespacefaiss_1a40328c31abd0bbba5bd95d7de951e847" refkind="member"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="namespacefaiss_1a40328c31abd0bbba5bd95d7de951e847" kindref="member">fvec_madd</ref>(</highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>n,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>a,<sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal"><sp/>bf,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>b,<sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>c);</highlight></codeline>
+<codeline lineno="449"><highlight class="normal"></highlight><highlight class="comment"></highlight></codeline>
+<codeline lineno="450"><highlight class="comment">/**<sp/>same<sp/>as<sp/>fvec_madd,<sp/>also<sp/>return<sp/>index<sp/>of<sp/>the<sp/>min<sp/>of<sp/>the<sp/>result<sp/>table</highlight></codeline>
+<codeline lineno="451"><highlight class="comment"><sp/>*<sp/>@return<sp/><sp/><sp/><sp/>index<sp/>of<sp/>the<sp/>min<sp/>of<sp/>table<sp/>c</highlight></codeline>
+<codeline lineno="452"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
+<codeline lineno="453" refid="namespacefaiss_1a9da63b8bb84460f5e8ccf8e17622cc7a" refkind="member"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="namespacefaiss_1a9da63b8bb84460f5e8ccf8e17622cc7a" kindref="member">fvec_madd_and_argmin</ref>(</highlight></codeline>
+<codeline lineno="454"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">size_t</highlight><highlight class="normal"><sp/>n,</highlight></codeline>
+<codeline lineno="455"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>a,</highlight></codeline>
+<codeline lineno="456"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal"><sp/>bf,</highlight></codeline>
+<codeline lineno="457"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>b,</highlight></codeline>
+<codeline lineno="458"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">float</highlight><highlight class="normal">*<sp/>c);</highlight></codeline>
+<codeline lineno="459"><highlight class="normal"></highlight></codeline>
+<codeline lineno="460"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
     </programlisting>
     <location file="faiss/utils/distances.h"/>
   </compounddef>

diff --git a/xml/index.xml b/xml/index.xml
@@ -8476,6 +8476,8 @@
     <member refid="namespacefaiss_1aca81a25a7d9100966a28f5f907d385c6" kind="function"><name>range_search_L2sqr</name></member>
     <member refid="namespacefaiss_1aa96f47c4109ec93b1f55f8e932ebe329" kind="function"><name>range_search_inner_product</name></member>
     <member refid="namespacefaiss_1a6bae4e24e73c75640d6db8760e513d6d" kind="function"><name>compute_PQ_dis_tables_dsub2</name></member>
+    <member refid="namespacefaiss_1a40328c31abd0bbba5bd95d7de951e847" kind="function"><name>fvec_madd</name></member>
+    <member refid="namespacefaiss_1a9da63b8bb84460f5e8ccf8e17622cc7a" kind="function"><name>fvec_madd_and_argmin</name></member>
     <member refid="namespacefaiss_1a8a1d1234d7f3f6fbcf277c2f6316760f" kind="function"><name>exhaustive_L2sqr_fused_cmax</name></member>
     <member refid="namespacefaiss_1ada09f7cd8c85cfbc3caf5b943b10bcc3" kind="function"><name>pairwise_extra_distances</name></member>
     <member refid="namespacefaiss_1a82b72341bc9020feaffe1420ab8eba63" kind="function"><name>knn_extra_metrics</name></member>
@@ -8591,8 +8593,6 @@
     <member refid="namespacefaiss_1af2a71f7d5402ae02ce169a4cc83020eb" kind="function"><name>getmillisecs</name></member>
     <member refid="namespacefaiss_1aa3af5769b0b649f112332a874c64d361" kind="function"><name>get_mem_usage_kb</name></member>
     <member refid="namespacefaiss_1a090355c2725c425a511a367cbfe41262" kind="function"><name>get_cycles</name></member>
-    <member refid="namespacefaiss_1a40328c31abd0bbba5bd95d7de951e847" kind="function"><name>fvec_madd</name></member>
-    <member refid="namespacefaiss_1a9da63b8bb84460f5e8ccf8e17622cc7a" kind="function"><name>fvec_madd_and_argmin</name></member>
     <member refid="namespacefaiss_1ab7c6da3d6915a010d5d3074d93878ce9" kind="function"><name>reflection</name></member>
     <member refid="namespacefaiss_1afb68fe89ad5e948974da1b70d7b4157c" kind="function"><name>matrix_qr</name></member>
     <member refid="namespacefaiss_1ad5827240bc67d6f8a612ba8761b34714" kind="function"><name>ranklist_handle_ties</name></member>