Skip to content

Commit

Permalink
Update API docs (fd6d784).
Browse files Browse the repository at this point in the history
  • Loading branch information
facebook-github-bot committed Oct 21, 2024
1 parent 7c43118 commit ef13cf4
Show file tree
Hide file tree
Showing 39 changed files with 1,479 additions and 1,469 deletions.
1 change: 1 addition & 0 deletions xml/FlatIndex_8cuh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline><highlight class="normal">//<sp/>@lint-ignore-every<sp/>LICENSELINT</highlight></codeline>
<codeline><highlight class="normal">/**</highlight></codeline>
<codeline><highlight class="normal"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
<codeline><highlight class="normal"><sp/>*</highlight></codeline>
Expand Down
565 changes: 283 additions & 282 deletions xml/GpuIndexCagra_8h.xml

Large diffs are not rendered by default.

395 changes: 198 additions & 197 deletions xml/GpuIndex_8h.xml

Large diffs are not rendered by default.

611 changes: 306 additions & 305 deletions xml/GpuResources_8h.xml

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions xml/RaftCagra_8cuh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline><highlight class="normal">//<sp/>@lint-ignore-every<sp/>LICENSELINT</highlight></codeline>
<codeline><highlight class="normal">/**</highlight></codeline>
<codeline><highlight class="normal"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
<codeline><highlight class="normal"><sp/>*</highlight></codeline>
Expand Down
1 change: 1 addition & 0 deletions xml/RaftFlatIndex_8cuh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline><highlight class="normal">//<sp/>@lint-ignore-every<sp/>LICENSELINT</highlight></codeline>
<codeline><highlight class="normal">/**</highlight></codeline>
<codeline><highlight class="normal"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
<codeline><highlight class="normal"><sp/>*</highlight></codeline>
Expand Down
1 change: 1 addition & 0 deletions xml/RaftIVFFlat_8cuh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline><highlight class="normal">//<sp/>@lint-ignore-every<sp/>LICENSELINT</highlight></codeline>
<codeline><highlight class="normal">/**</highlight></codeline>
<codeline><highlight class="normal"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
<codeline><highlight class="normal"><sp/>*</highlight></codeline>
Expand Down
1 change: 1 addition & 0 deletions xml/RaftIVFPQ_8cuh.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline><highlight class="normal">//<sp/>@lint-ignore-every<sp/>LICENSELINT</highlight></codeline>
<codeline><highlight class="normal">/**</highlight></codeline>
<codeline><highlight class="normal"><sp/>*<sp/>Copyright<sp/>(c)<sp/>Facebook,<sp/>Inc.<sp/>and<sp/>its<sp/>affiliates.</highlight></codeline>
<codeline><highlight class="normal"><sp/>*</highlight></codeline>
Expand Down
151 changes: 76 additions & 75 deletions xml/RaftUtils_8h.xml

Large diffs are not rendered by default.

519 changes: 260 additions & 259 deletions xml/StandardGpuResources_8h.xml

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions xml/classfaiss_1_1gpu_1_1GpuIndex.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="178" column="21" bodyfile="faiss/gpu/GpuIndex.h" bodystart="178" bodyend="-1"/>
<location file="faiss/gpu/GpuIndex.h" line="179" column="21" bodyfile="faiss/gpu/GpuIndex.h" bodystart="179" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classfaiss_1_1gpu_1_1GpuIndex_1ab62da82105579618d1b89a810d61e3bd" prot="protected" static="no" mutable="no">
<type>const <ref refid="structfaiss_1_1gpu_1_1GpuIndexConfig" kindref="compound">GpuIndexConfig</ref></type>
Expand All @@ -33,7 +33,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="181" column="26" bodyfile="faiss/gpu/GpuIndex.h" bodystart="181" bodyend="-1"/>
<location file="faiss/gpu/GpuIndex.h" line="182" column="26" bodyfile="faiss/gpu/GpuIndex.h" bodystart="182" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classfaiss_1_1gpu_1_1GpuIndex_1a32a08664fc4dca2f9405e07ea5bc206f" prot="protected" static="no" mutable="no">
<type>size_t</type>
Expand All @@ -47,7 +47,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="184" column="12" bodyfile="faiss/gpu/GpuIndex.h" bodystart="184" bodyend="-1"/>
<location file="faiss/gpu/GpuIndex.h" line="185" column="12" bodyfile="faiss/gpu/GpuIndex.h" bodystart="185" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
Expand Down Expand Up @@ -82,7 +82,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="54" column="5"/>
<location file="faiss/gpu/GpuIndex.h" line="55" column="5"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1af4f02c713f639bd70e09af8afebd0f51" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
Expand All @@ -96,7 +96,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="62" column="9"/>
<location file="faiss/gpu/GpuIndex.h" line="63" column="9"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a2eb235a51b0a70bdbc2c814a48a0917d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classfaiss_1_1gpu_1_1GpuResources" kindref="compound">GpuResources</ref> &gt;</type>
Expand All @@ -110,7 +110,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="66" column="21"/>
<location file="faiss/gpu/GpuIndex.h" line="67" column="21"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a6c82cbea6b02cc996d634f822c1d310b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
Expand All @@ -128,7 +128,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="70" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="71" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a6402d93925d2a403dc187dc1a7aab1e3" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>size_t</type>
Expand All @@ -142,7 +142,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="73" column="12"/>
<location file="faiss/gpu/GpuIndex.h" line="74" column="12"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a5fcf3e9af349e17c27ce82fc0ed94966" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand All @@ -165,7 +165,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="78" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="79" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a0e7fa779ba9d47b0af36161de2a3b191" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand All @@ -192,7 +192,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="83" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="84" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1ab6382636bc3f651645ee66d8744f7c0f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -224,7 +224,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="87" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="88" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a7d7d3746b5f02be8317e142d966c7d4f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -264,7 +264,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="92" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="93" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a6d03010928f0a641ac6a1b45c0c034f0" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -308,7 +308,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="102" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="103" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1ae076ddbcfde3e7a21879ac379ff991d9" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -336,7 +336,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="113" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="114" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a1a1ccf88e127b613c5ef65e52d7a6428" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -368,7 +368,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="118" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="119" column="10"/>
</memberdef>
<memberdef kind="function" id="structfaiss_1_1Index_1a8f67dfd73993e192dc78f2c93d9d9532" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type>void</type>
Expand Down Expand Up @@ -987,7 +987,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="126" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="127" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a6fa51de122f2cf2bd49727d909fb4b6c" prot="protected" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
Expand All @@ -1005,7 +1005,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="129" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="130" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a358cad8f80a9c4b3aff45f3f7c131d03" prot="protected" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
<type>bool</type>
Expand All @@ -1022,7 +1022,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="133" column="18"/>
<location file="faiss/gpu/GpuIndex.h" line="134" column="18"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a65a58cacb67105435b5c65c32477cbae" prot="protected" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>void</type>
Expand Down Expand Up @@ -1051,7 +1051,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="137" column="18"/>
<location file="faiss/gpu/GpuIndex.h" line="138" column="18"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a4ac48a0e615826e28748c8ac5c4bb6dc" prot="protected" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
<type>void</type>
Expand Down Expand Up @@ -1092,7 +1092,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="141" column="18"/>
<location file="faiss/gpu/GpuIndex.h" line="142" column="18"/>
</memberdef>
</sectiondef>
<sectiondef kind="private-func">
Expand Down Expand Up @@ -1120,7 +1120,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="152" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="153" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a0e7ec437f143a5efcaf3e3ec4f35f26b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
Expand All @@ -1146,7 +1146,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="155" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="156" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1acf802eff7e36a8f77f6ce4fdcf5d01a9" prot="private" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
Expand Down Expand Up @@ -1184,7 +1184,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="158" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="159" column="10"/>
</memberdef>
<memberdef kind="function" id="classfaiss_1_1gpu_1_1GpuIndex_1a57aff3a07419205bd285c42a452d6a31" prot="private" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
Expand Down Expand Up @@ -1222,7 +1222,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="faiss/gpu/GpuIndex.h" line="168" column="10"/>
<location file="faiss/gpu/GpuIndex.h" line="169" column="10"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-type">
Expand Down Expand Up @@ -1422,7 +1422,7 @@
<link refid="structfaiss_1_1Index"/>
</node>
</collaborationgraph>
<location file="faiss/gpu/GpuIndex.h" line="52" column="1" bodyfile="faiss/gpu/GpuIndex.h" bodystart="52" bodyend="185"/>
<location file="faiss/gpu/GpuIndex.h" line="53" column="1" bodyfile="faiss/gpu/GpuIndex.h" bodystart="53" bodyend="186"/>
<listofallmembers>
<member refid="classfaiss_1_1gpu_1_1GpuIndex_1a5fcf3e9af349e17c27ce82fc0ed94966" prot="public" virt="virtual"><scope>faiss::gpu::GpuIndex</scope><name>add</name></member>
<member refid="classfaiss_1_1gpu_1_1GpuIndex_1a0e7fa779ba9d47b0af36161de2a3b191" prot="public" virt="virtual"><scope>faiss::gpu::GpuIndex</scope><name>add_with_ids</name></member>
Expand Down
Loading

0 comments on commit ef13cf4

Please sign in to comment.