Skip to content

Commit

Permalink
Sphinx rebuild (3bacb1e).
Browse files Browse the repository at this point in the history
  • Loading branch information
@facebook-github-bot
facebook-github-bot committed Jan 9, 2024
1 parent 3bacb1e commit 03834a5
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 24 deletions.
14 changes: 7 additions & 7 deletions docs/cpp_api/file/ResultHandler_8h.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/cpp_api/namespace/namespacefaiss.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10057,7 +10057,7 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::HeapResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1HeapResultHandler_1a2fa17fd25eff46715a1b3b88dfc4eedd"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::HeapResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1HeapResultHandler_1a66a74df00c131f5bd50487b340c6b335"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

Expand Down Expand Up @@ -10275,7 +10275,7 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss22ReservoirResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss22ReservoirResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss22ReservoirResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::ReservoirResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1ReservoirResultHandler_1ae2002e159553889c15336094af9f1fbb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss22ReservoirResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss22ReservoirResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::ReservoirResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1ReservoirResultHandler_1aeac49111142e01330a49acacb19b7c86"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

Expand Down Expand Up @@ -10357,7 +10357,7 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss22ReservoirResultHandler19SingleResultHandler5beginE6size_t">
<span id="_CPPv3N5faiss22ReservoirResultHandler19SingleResultHandler5beginE6size_t"></span><span id="_CPPv2N5faiss22ReservoirResultHandler19SingleResultHandler5beginE6size_t"></span><span id="faiss::ReservoirResultHandler::SingleResultHandler::begin__s"></span><span class="target" id="structfaiss_1_1ReservoirResultHandler_1_1SingleResultHandler_1a2cf964c0de200b1ff4199f0d8ebcfc02"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss22ReservoirResultHandler19SingleResultHandler5beginE6size_t"></span><span id="_CPPv2N5faiss22ReservoirResultHandler19SingleResultHandler5beginE6size_t"></span><span id="faiss::ReservoirResultHandler::SingleResultHandler::begin__s"></span><span class="target" id="structfaiss_1_1ReservoirResultHandler_1_1SingleResultHandler_1af2c6308d01b109060eb6dccdbb19b389"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin results for query # i </p>
</dd></dl>

Expand Down Expand Up @@ -10431,7 +10431,7 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::RangeSearchResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1RangeSearchResultHandler_1a434ac5e298311235064017995ddf79bd"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::RangeSearchResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1RangeSearchResultHandler_1a8e1a5d564e17707da11f459e65155df3"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

Expand Down Expand Up @@ -10571,13 +10571,13 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss23SingleBestResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss23SingleBestResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss23SingleBestResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::SingleBestResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1afb94d2bece0a3f9b67d18e56b07ca806"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss23SingleBestResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss23SingleBestResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::SingleBestResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1a8de4ac3ce5047323e9b3940cee3faa6f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss23SingleBestResultHandler11add_resultsE6size_t6size_tPK1T">
<span id="_CPPv3N5faiss23SingleBestResultHandler11add_resultsE6size_t6size_tPK1T"></span><span id="_CPPv2N5faiss23SingleBestResultHandler11add_resultsE6size_t6size_tPK1T"></span><span id="faiss::SingleBestResultHandler::add_results__s.s.TCP"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1abb6fa2c0633c14fb14e4d36a90305d72"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">add_results</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">j0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">j1</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../file/ResultHandler_8h.html#_CPPv4N5faiss23SingleBestResultHandler1TE" title="faiss::SingleBestResultHandler::T"><span class="n"><span class="pre">T</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dis_tab</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss23SingleBestResultHandler11add_resultsE6size_t6size_tPK1T"></span><span id="_CPPv2N5faiss23SingleBestResultHandler11add_resultsE6size_t6size_tPK1T"></span><span id="faiss::SingleBestResultHandler::add_results__s.s.TCP"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1a131abfe736b59787f6ecfdd904b56d30"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">add_results</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">j0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">j1</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../file/ResultHandler_8h.html#_CPPv4N5faiss23SingleBestResultHandler1TE" title="faiss::SingleBestResultHandler::T"><span class="n"><span class="pre">T</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dis_tab_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>add results for query i0..i1 and j0..j1 </p>
</dd></dl>

Expand Down Expand Up @@ -10633,7 +10633,7 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss23SingleBestResultHandler19SingleResultHandler5beginEK6size_t">
<span id="_CPPv3N5faiss23SingleBestResultHandler19SingleResultHandler5beginEK6size_t"></span><span id="_CPPv2N5faiss23SingleBestResultHandler19SingleResultHandler5beginEK6size_t"></span><span id="faiss::SingleBestResultHandler::SingleResultHandler::begin__sC"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1_1SingleResultHandler_1aae9c9960fa0f9794ae69ef2beb9009e7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">current_idx</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss23SingleBestResultHandler19SingleResultHandler5beginEK6size_t"></span><span id="_CPPv2N5faiss23SingleBestResultHandler19SingleResultHandler5beginEK6size_t"></span><span id="faiss::SingleBestResultHandler::SingleResultHandler::begin__sC"></span><span class="target" id="structfaiss_1_1SingleBestResultHandler_1_1SingleResultHandler_1ad309ac7261d9279942208ce08b0aed7b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">current_idx_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin results for query # i </p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion docs/cpp_api/struct/structfaiss_1_1HeapResultHandler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ <h1>Struct faiss::HeapResultHandler<a class="headerlink" href="#struct-faiss-hea

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::HeapResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1HeapResultHandler_1a2fa17fd25eff46715a1b3b88dfc4eedd"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss17HeapResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::HeapResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1HeapResultHandler_1a66a74df00c131f5bd50487b340c6b335"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion docs/cpp_api/struct/structfaiss_1_1RangeSearchResultHandler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ <h1>Struct faiss::RangeSearchResultHandler<a class="headerlink" href="#struct-fa

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t">
<span id="_CPPv3N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::RangeSearchResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1RangeSearchResultHandler_1a434ac5e298311235064017995ddf79bd"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1</span></span><span class="sig-paren">)</span><br /></dt>
<span id="_CPPv3N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="_CPPv2N5faiss24RangeSearchResultHandler14begin_multipleE6size_t6size_t"></span><span id="faiss::RangeSearchResultHandler::begin_multiple__s.s"></span><span class="target" id="structfaiss_1_1RangeSearchResultHandler_1a8e1a5d564e17707da11f459e65155df3"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin_multiple</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i0_2</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i1_2</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>begin </p>
</dd></dl>

Expand Down
Loading

0 comments on commit 03834a5

Please sign in to comment.