Skip to content

Commit 16b032d

Browse files
meta-codesync[bot]meta-codesync[bot]
committed
Update API docs (da3191e).
1 parent f8f13dc commit 16b032d

27 files changed

Lines changed: 1398 additions & 956 deletions

‎cpp_api/struct/structfaiss_1_1IDScanContext.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Struct faiss::IDScanContext
2+
===========================
3+
4+
.. doxygenstruct:: faiss::IDScanContext

‎cpp_api/struct/structfaiss_1_1IDSelectorContextDispatch.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Struct faiss::IDSelectorContextDispatch
2+
=======================================
3+
4+
.. doxygenstruct:: faiss::IDSelectorContextDispatch

‎cpp_api/struct/structfaiss_1_1IDSelectorWithContext.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Struct faiss::IDSelectorWithContext
2+
===================================
3+
4+
.. doxygenstruct:: faiss::IDSelectorWithContext

‎xml/IDSelector_8h.xml‎

Lines changed: 193 additions & 146 deletions
Large diffs are not rendered by default.

‎xml/IVFPQScanner__impl_8h.xml‎

Lines changed: 524 additions & 511 deletions
Large diffs are not rendered by default.

‎xml/Panorama_8h.xml‎

Lines changed: 84 additions & 76 deletions
Large diffs are not rendered by default.

‎xml/expanded__scanners_8h.xml‎

Lines changed: 130 additions & 126 deletions
Large diffs are not rendered by default.

‎xml/index.xml‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2732,6 +2732,11 @@
27322732
<member refid="structfaiss_1_1lsq_1_1IcmEncoderFactory_1a2a9953e848c087b9a0aa4dc6a807bba7" kind="function"><name>get</name></member>
27332733
<member refid="structfaiss_1_1lsq_1_1IcmEncoderFactory_1ab8351263070c0817f97dabf036fa98c3" kind="function"><name>~IcmEncoderFactory</name></member>
27342734
</compound>
2735+
<compound refid="structfaiss_1_1IDScanContext" kind="struct"><name>faiss::IDScanContext</name>
2736+
<member refid="structfaiss_1_1IDScanContext_1a54cbb4f328fdbca36cb40d0dcc8c9789" kind="variable"><name>ids</name></member>
2737+
<member refid="structfaiss_1_1IDScanContext_1a0fb0deb2e5f552cd563e4aff13cee8be" kind="variable"><name>list_size</name></member>
2738+
<member refid="structfaiss_1_1IDScanContext_1aace048a2135967fa57ab81a43e7e10c4" kind="variable"><name>j</name></member>
2739+
</compound>
27352740
<compound refid="structfaiss_1_1IDSelector" kind="struct"><name>faiss::IDSelector</name>
27362741
<member refid="structfaiss_1_1IDSelector_1a57119188b2d81dcdeee8db5a08348fc0" kind="function"><name>is_member</name></member>
27372742
<member refid="structfaiss_1_1IDSelector_1a9c0edd3fe1536d9b3193e14f0a2092ee" kind="function"><name>~IDSelector</name></member>
@@ -2770,6 +2775,12 @@
27702775
<member refid="structfaiss_1_1IDSelectorBitmap_1a3c5bdfc7f2377cf569def3bb681b9d0d" kind="function"><name>is_member</name></member>
27712776
<member refid="structfaiss_1_1IDSelectorBitmap_1a5d5f32287ff1d2318fac1305b375057c" kind="function"><name>~IDSelectorBitmap</name></member>
27722777
</compound>
2778+
<compound refid="structfaiss_1_1IDSelectorContextDispatch" kind="struct"><name>faiss::IDSelectorContextDispatch</name>
2779+
<member refid="structfaiss_1_1IDSelectorContextDispatch_1ab237448c7547c65e846c4e45f1f4b104" kind="variable"><name>sel</name></member>
2780+
<member refid="structfaiss_1_1IDSelectorContextDispatch_1a856ed2ce817128ca7cd2577aa9348099" kind="variable"><name>ctx_sel</name></member>
2781+
<member refid="structfaiss_1_1IDSelectorContextDispatch_1a00e28d0cbf5a1bae59246b4a55a53d81" kind="function"><name>IDSelectorContextDispatch</name></member>
2782+
<member refid="structfaiss_1_1IDSelectorContextDispatch_1a5e506be208fd16564ff12ec068b30a68" kind="function"><name>is_member</name></member>
2783+
</compound>
27732784
<compound refid="structfaiss_1_1IDSelectorNot" kind="struct"><name>faiss::IDSelectorNot</name>
27742785
<member refid="structfaiss_1_1IDSelectorNot_1ad1aff9ca7358328c64daf17a595bd2c3" kind="variable"><name>sel</name></member>
27752786
<member refid="structfaiss_1_1IDSelectorNot_1aa1d278311b73d294fa2f3d8e3becd084" kind="function"><name>IDSelectorNot</name></member>
@@ -2800,6 +2811,10 @@
28002811
<member refid="structfaiss_1_1IDSelectorTranslated_1a2f9aae2c01869c6f700527c1bf8fc88f" kind="function"><name>IDSelectorTranslated</name></member>
28012812
<member refid="structfaiss_1_1IDSelectorTranslated_1ab5638224c8cda6f29a683b1876b65051" kind="function"><name>is_member</name></member>
28022813
</compound>
2814+
<compound refid="structfaiss_1_1IDSelectorWithContext" kind="struct"><name>faiss::IDSelectorWithContext</name>
2815+
<member refid="structfaiss_1_1IDSelectorWithContext_1a36fbc18334567dcbb3faa0584690cc19" kind="function"><name>is_member_with_context</name></member>
2816+
<member refid="structfaiss_1_1IDSelector_1a57119188b2d81dcdeee8db5a08348fc0" kind="function"><name>is_member</name></member>
2817+
</compound>
28032818
<compound refid="structfaiss_1_1IDSelectorXOr" kind="struct"><name>faiss::IDSelectorXOr</name>
28042819
<member refid="structfaiss_1_1IDSelectorXOr_1ad87c3951bf5764695228ed472423bfcf" kind="variable"><name>lhs</name></member>
28052820
<member refid="structfaiss_1_1IDSelectorXOr_1a87ede6785fbe4f5b7e63cdde0e4bb68e" kind="variable"><name>rhs</name></member>
@@ -13451,9 +13466,11 @@
1345113466
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a3cda8b43e6976ad751b88c3dc3fea61c" kind="variable"><name>res</name></member>
1345213467
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a7d9b615dc4f97654122471ccb7a42ff4" kind="variable"><name>nup</name></member>
1345313468
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a26bb99d81275a2a97807b9e34ac6bdc4" kind="variable"><name>list_no</name></member>
13469+
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a1d3e34d7d66b28f434a4147a27b20371" kind="variable"><name>list_size</name></member>
1345413470
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a103c4e5d1c4301d108ed78b47cb49f64" kind="variable"><name>ids</name></member>
1345513471
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1aeb0ff1c4375f3cec288f861f27fad9b2" kind="variable"><name>sel</name></member>
13456-
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1ac1d27d05cb0143296d84f067e37b2d09" kind="function"><name>WrappedSearchResult</name></member>
13472+
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a1633c83241cc682460421ecf56b199a2" kind="variable"><name>dispatch</name></member>
13473+
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a51556d6b2b21e36dd2e6416a25e32b0a" kind="function"><name>WrappedSearchResult</name></member>
1345713474
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a15cbab84ac5ba6bfe0f0b20b2483687c" kind="function"><name>skip_entry</name></member>
1345813475
<member refid="structfaiss_1_1pq__code__distance_1_1WrappedSearchResult_1a2642fb8a9ebbd0e45cf8753920571935" kind="function"><name>add</name></member>
1345913476
</compound>

‎xml/namespacefaiss.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,19 @@
103103
<innerclass refid="structfaiss_1_1HNSW" prot="public">faiss::HNSW</innerclass>
104104
<innerclass refid="structfaiss_1_1HNSWStats" prot="public">faiss::HNSWStats</innerclass>
105105
<innerclass refid="structfaiss_1_1HStackInvertedLists" prot="public">faiss::HStackInvertedLists</innerclass>
106+
<innerclass refid="structfaiss_1_1IDScanContext" prot="public">faiss::IDScanContext</innerclass>
106107
<innerclass refid="structfaiss_1_1IDSelector" prot="public">faiss::IDSelector</innerclass>
107108
<innerclass refid="structfaiss_1_1IDSelectorAll" prot="public">faiss::IDSelectorAll</innerclass>
108109
<innerclass refid="structfaiss_1_1IDSelectorAnd" prot="public">faiss::IDSelectorAnd</innerclass>
109110
<innerclass refid="structfaiss_1_1IDSelectorArray" prot="public">faiss::IDSelectorArray</innerclass>
110111
<innerclass refid="structfaiss_1_1IDSelectorBatch" prot="public">faiss::IDSelectorBatch</innerclass>
111112
<innerclass refid="structfaiss_1_1IDSelectorBitmap" prot="public">faiss::IDSelectorBitmap</innerclass>
113+
<innerclass refid="structfaiss_1_1IDSelectorContextDispatch" prot="public">faiss::IDSelectorContextDispatch</innerclass>
112114
<innerclass refid="structfaiss_1_1IDSelectorNot" prot="public">faiss::IDSelectorNot</innerclass>
113115
<innerclass refid="structfaiss_1_1IDSelectorOr" prot="public">faiss::IDSelectorOr</innerclass>
114116
<innerclass refid="structfaiss_1_1IDSelectorRange" prot="public">faiss::IDSelectorRange</innerclass>
115117
<innerclass refid="structfaiss_1_1IDSelectorTranslated" prot="public">faiss::IDSelectorTranslated</innerclass>
118+
<innerclass refid="structfaiss_1_1IDSelectorWithContext" prot="public">faiss::IDSelectorWithContext</innerclass>
116119
<innerclass refid="structfaiss_1_1IDSelectorXOr" prot="public">faiss::IDSelectorXOr</innerclass>
117120
<innerclass refid="structfaiss_1_1Index" prot="public">faiss::Index</innerclass>
118121
<innerclass refid="structfaiss_1_1Index2Layer" prot="public">faiss::Index2Layer</innerclass>

‎xml/namespacefaiss_1_1pq__code__distance.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
</detaileddescription>
4242
<inbodydescription>
4343
</inbodydescription>
44-
<location file="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" line="498" column="21" declfile="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" declline="498" declcolumn="21"/>
44+
<location file="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" line="511" column="21" declfile="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" declline="511" declcolumn="21"/>
4545
</memberdef>
4646
<memberdef kind="function" id="IVFPQScanner__impl_8h_1af6a7d6a634808cfff4adb38078cb54a4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
4747
<templateparamlist>
@@ -69,7 +69,7 @@
6969
</detaileddescription>
7070
<inbodydescription>
7171
</inbodydescription>
72-
<location file="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" line="505" column="1" bodyfile="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" bodystart="505" bodyend="546"/>
72+
<location file="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" line="518" column="1" bodyfile="faiss/impl/pq_code_distance/IVFPQScanner_impl.h" bodystart="518" bodyend="559"/>
7373
</memberdef>
7474
<memberdef kind="function" id="pq__code__distance-avx2_8h_1a3f7e7a9be9cca31a8862257caa3c42b9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
7575
<templateparamlist>

0 commit comments

Comments
 (0)