Skip to content

Commit

Permalink
Update API docs (89e93e2).
Browse files Browse the repository at this point in the history
  • Loading branch information
@facebook-github-bot
facebook-github-bot committed Jan 14, 2025
1 parent f375ff7 commit 4660b41
Show file tree
Hide file tree
Showing 662 changed files with 36,851 additions and 26,815 deletions.
202 changes: 101 additions & 101 deletions xml/AdditiveQuantizer_8h.xml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.1" xml:lang="en-US">
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US">
<compounddef id="AdditiveQuantizer_8h" kind="file" language="C++">
<compoundname>AdditiveQuantizer.h</compoundname>
<includes local="no">cmath</includes>
Expand All @@ -8,14 +8,36 @@
<includes refid="Index_8h" local="no">faiss/Index.h</includes>
<includes refid="IndexFlat_8h" local="no">faiss/IndexFlat.h</includes>
<includes refid="Quantizer_8h" local="no">faiss/impl/Quantizer.h</includes>
<includedby refid="LocalSearchQuantizer_8h" local="no">faiss/impl/LocalSearchQuantizer.h</includedby>
<includedby refid="ProductAdditiveQuantizer_8h" local="no">faiss/impl/ProductAdditiveQuantizer.h</includedby>
<includedby refid="ResidualQuantizer_8h" local="no">faiss/impl/ResidualQuantizer.h</includedby>
<includedby refid="IndexAdditiveQuantizer_8h" local="no">faiss/IndexAdditiveQuantizer.h</includedby>
<includedby refid="IndexAdditiveQuantizerFastScan_8h" local="no">faiss/IndexAdditiveQuantizerFastScan.h</includedby>
<includedby refid="IndexIVFAdditiveQuantizer_8h" local="no">faiss/IndexIVFAdditiveQuantizer.h</includedby>
<includedby refid="IndexIVFAdditiveQuantizerFastScan_8h" local="no">faiss/IndexIVFAdditiveQuantizerFastScan.h</includedby>
<includedby refid="LocalSearchQuantizer_8h" local="no">faiss/impl/LocalSearchQuantizer.h</includedby>
<includedby refid="ProductAdditiveQuantizer_8h" local="no">faiss/impl/ProductAdditiveQuantizer.h</includedby>
<includedby refid="ResidualQuantizer_8h" local="no">faiss/impl/ResidualQuantizer.h</includedby>
<incdepgraph>
<node id="5">
<label>faiss/Index.h</label>
<link refid="Index_8h_source"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="12">
<label>faiss/IndexFlat.h</label>
<link refid="IndexFlat_8h_source"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="13">
<label>faiss/IndexFlatCodes.h</label>
<link refid="IndexFlatCodes_8h_source"/>
Expand All @@ -26,12 +48,38 @@
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="12">
<label>faiss/IndexFlat.h</label>
<link refid="IndexFlat_8h_source"/>
<node id="6">
<label>faiss/MetricType.h</label>
<link refid="MetricType_8h_source"/>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="1">
<label>faiss/impl/AdditiveQuantizer.h</label>
<link refid="AdditiveQuantizer_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="13" relation="include">
<childnode refid="5" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="14">
<label>faiss/impl/DistanceComputer.h</label>
<link refid="DistanceComputer_8h_source"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="15">
<label>faiss/impl/Quantizer.h</label>
<link refid="Quantizer_8h_source"/>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="7">
Expand All @@ -42,55 +90,55 @@
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="2">
<label>cmath</label>
</node>
<node id="3">
<label>cstdint</label>
</node>
<node id="8">
<label>cstdio</label>
</node>
<node id="9">
<label>sstream</label>
</node>
<node id="16">
<label>stdint.h</label>
</node>
<node id="2">
<label>cmath</label>
</node>
<node id="10">
<label>string</label>
</node>
<node id="15">
<label>faiss/impl/Quantizer.h</label>
<link refid="Quantizer_8h_source"/>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="11">
<label>typeinfo</label>
</node>
<node id="8">
<label>cstdio</label>
<node id="4">
<label>vector</label>
</node>
<node id="14">
<label>faiss/impl/DistanceComputer.h</label>
<link refid="DistanceComputer_8h_source"/>
<childnode refid="5" relation="include">
</incdepgraph>
<invincdepgraph>
<node id="2">
<label>faiss/IndexAdditiveQuantizer.h</label>
<link refid="IndexAdditiveQuantizer_8h_source"/>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="4">
<label>vector</label>
<node id="3">
<label>faiss/IndexAdditiveQuantizerFastScan.h</label>
<link refid="IndexAdditiveQuantizerFastScan_8h_source"/>
</node>
<node id="9">
<label>sstream</label>
<node id="4">
<label>faiss/IndexIVFAdditiveQuantizer.h</label>
<link refid="IndexIVFAdditiveQuantizer_8h_source"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="5">
<label>faiss/Index.h</label>
<link refid="Index_8h_source"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<label>faiss/IndexIVFAdditiveQuantizerFastScan.h</label>
<link refid="IndexIVFAdditiveQuantizerFastScan_8h_source"/>
</node>
<node id="7">
<label>faiss/gpu/GpuIcmEncoder.h</label>
<link refid="GpuIcmEncoder_8h_source"/>
</node>
<node id="1">
<label>faiss/impl/AdditiveQuantizer.h</label>
Expand All @@ -103,95 +151,47 @@
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="15" relation="include">
<childnode refid="6" relation="include">
</childnode>
</node>
<node id="6">
<label>faiss/MetricType.h</label>
<link refid="MetricType_8h_source"/>
<childnode refid="7" relation="include">
<childnode refid="8" relation="include">
</childnode>
</node>
</incdepgraph>
<invincdepgraph>
<node id="5">
<label>faiss/IndexAdditiveQuantizer.h</label>
<link refid="IndexAdditiveQuantizer_8h_source"/>
<childnode refid="6" relation="include">
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="4">
<label>faiss/impl/ProductAdditiveQuantizer.h</label>
<link refid="ProductAdditiveQuantizer_8h_source"/>
<childnode refid="5" relation="include">
<node id="6">
<label>faiss/impl/LocalSearchQuantizer.h</label>
<link refid="LocalSearchQuantizer_8h_source"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="6" relation="include">
<childnode refid="4" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="2">
<label>faiss/impl/LocalSearchQuantizer.h</label>
<link refid="LocalSearchQuantizer_8h_source"/>
<node id="8">
<label>faiss/impl/ProductAdditiveQuantizer.h</label>
<link refid="ProductAdditiveQuantizer_8h_source"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="9">
<label>faiss/impl/ResidualQuantizer.h</label>
<link refid="ResidualQuantizer_8h_source"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="7">
<label>faiss/IndexIVFAdditiveQuantizer.h</label>
<link refid="IndexIVFAdditiveQuantizer_8h_source"/>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="1">
<label>faiss/impl/AdditiveQuantizer.h</label>
<link refid="AdditiveQuantizer_8h"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="6">
<label>faiss/IndexAdditiveQuantizerFastScan.h</label>
<link refid="IndexAdditiveQuantizerFastScan_8h_source"/>
</node>
<node id="3">
<label>faiss/gpu/GpuIcmEncoder.h</label>
<link refid="GpuIcmEncoder_8h_source"/>
</node>
<node id="8">
<label>faiss/IndexIVFAdditiveQuantizerFastScan.h</label>
<link refid="IndexIVFAdditiveQuantizerFastScan_8h_source"/>
</node>
</invincdepgraph>
<innerclass refid="structfaiss_1_1AdditiveQuantizer" prot="public">faiss::AdditiveQuantizer</innerclass>
<innernamespace refid="namespacefaiss">faiss</innernamespace>
Expand Down Expand Up @@ -414,7 +414,7 @@
<codeline lineno="212"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespacefaiss_1ad63e84aa82f5bb0405ed924d58b20e2e" kindref="member">idx_t</ref>*<sp/>labels,</highlight></codeline>
<codeline lineno="213"><highlight class="normal"><sp/><sp/><sp/><sp/><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/><ref refid="structfaiss_1_1AdditiveQuantizer_1af366aff9e6f592413920232add8a4658" kindref="member">centroid_norms</ref>)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="214"><highlight class="normal"></highlight></codeline>
<codeline lineno="215"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">virtual</highlight><highlight class="normal"><sp/>~<ref refid="structfaiss_1_1AdditiveQuantizer" kindref="compound">AdditiveQuantizer</ref>();</highlight></codeline>
<codeline lineno="215"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">virtual</highlight><highlight class="normal"><sp/><ref refid="structfaiss_1_1AdditiveQuantizer" kindref="compound">~AdditiveQuantizer</ref>();</highlight></codeline>
<codeline lineno="216"><highlight class="normal">};</highlight></codeline>
<codeline lineno="217"><highlight class="normal"></highlight></codeline>
<codeline lineno="218"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>faiss</highlight><highlight class="normal"></highlight></codeline>
Expand Down
Loading

0 comments on commit 4660b41

Please sign in to comment.