Skip to content

Commit

Permalink
Sphinx rebuild (61ef241).
Browse files Browse the repository at this point in the history
  • Loading branch information
@facebook-github-bot
facebook-github-bot committed Aug 13, 2024
1 parent 61ef241 commit 5c4df9d
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/cpp_api/file/HNSW_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,11 @@ <h1>File HNSW.h<a class="headerlink" href="#file-hnsw-h" title="Permalink to thi
<span id="_CPPv3N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="faiss::SearchParametersHNSW::check_relative_distance__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1ae3b677b9eb7554502912e60797dc5c2f"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">check_relative_distance</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><a class="headerlink" href="#_CPPv4N5faiss20SearchParametersHNSW23check_relative_distanceE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">
<span id="_CPPv3N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="faiss::SearchParametersHNSW::bounded_queue__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1a7e0cb8fd6ab25707248a9de030baf744"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bounded_queue</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><a class="headerlink" href="#_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

Expand Down
5 changes: 5 additions & 0 deletions docs/cpp_api/namespace/namespacefaiss.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4738,6 +4738,11 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin
<span id="_CPPv3N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="faiss::SearchParametersHNSW::check_relative_distance__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1ae3b677b9eb7554502912e60797dc5c2f"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">check_relative_distance</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">
<span id="_CPPv3N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="faiss::SearchParametersHNSW::bounded_queue__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1a7e0cb8fd6ab25707248a9de030baf744"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bounded_queue</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss20SearchParametersHNSW3selE">
<span id="_CPPv3N5faiss20SearchParametersHNSW3selE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW3selE"></span><span id="faiss::SearchParametersHNSW::sel__IDSelectorP"></span><span class="target" id="structfaiss_1_1SearchParameters_1a85e6514f1599673eb1cf3d0276f00e3a"></span><a class="reference internal" href="../file/IDSelector_8h.html#_CPPv4N5faiss10IDSelectorE" title="faiss::IDSelector"><span class="n"><span class="pre">IDSelector</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">sel</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">nullptr</span></span><a class="headerlink" href="#_CPPv4N5faiss20SearchParametersHNSW3selE" title="Permalink to this definition"></a><br /></dt>
Expand Down
5 changes: 5 additions & 0 deletions docs/cpp_api/struct/structfaiss_1_1SearchParametersHNSW.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,11 @@ <h1>Struct faiss::SearchParametersHNSW<a class="headerlink" href="#struct-faiss-
<span id="_CPPv3N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW23check_relative_distanceE"></span><span id="faiss::SearchParametersHNSW::check_relative_distance__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1ae3b677b9eb7554502912e60797dc5c2f"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">check_relative_distance</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">
<span id="_CPPv3N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW13bounded_queueE"></span><span id="faiss::SearchParametersHNSW::bounded_queue__b"></span><span class="target" id="structfaiss_1_1SearchParametersHNSW_1a7e0cb8fd6ab25707248a9de030baf744"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bounded_queue</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><br /></dt>
<dd></dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss20SearchParametersHNSW3selE">
<span id="_CPPv3N5faiss20SearchParametersHNSW3selE"></span><span id="_CPPv2N5faiss20SearchParametersHNSW3selE"></span><span id="faiss::SearchParametersHNSW::sel__IDSelectorP"></span><span class="target" id="structfaiss_1_1SearchParameters_1a85e6514f1599673eb1cf3d0276f00e3a"></span><a class="reference internal" href="../file/IDSelector_8h.html#_CPPv4N5faiss10IDSelectorE" title="faiss::IDSelector"><span class="n"><span class="pre">IDSelector</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">sel</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">nullptr</span></span><br /></dt>
Expand Down
2 changes: 2 additions & 0 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15284,6 +15284,8 @@ <h2 id="F">F</h2>
<li><a href="cpp_api/file/Index_8h.html#_CPPv4N5faiss16SearchParametersD0Ev">faiss::SearchParameters::~SearchParameters (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss16SearchParametersD0Ev">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1SearchParameters.html#_CPPv4N5faiss16SearchParametersD0Ev">[2]</a>
</li>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss20SearchParametersHNSWE">faiss::SearchParametersHNSW (C++ struct)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss20SearchParametersHNSWE">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1SearchParametersHNSW.html#_CPPv4N5faiss20SearchParametersHNSWE">[2]</a>
</li>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">faiss::SearchParametersHNSW::bounded_queue (C++ member)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1SearchParametersHNSW.html#_CPPv4N5faiss20SearchParametersHNSW13bounded_queueE">[2]</a>
</li>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss20SearchParametersHNSW23check_relative_distanceE">faiss::SearchParametersHNSW::check_relative_distance (C++ member)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss20SearchParametersHNSW23check_relative_distanceE">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1SearchParametersHNSW.html#_CPPv4N5faiss20SearchParametersHNSW23check_relative_distanceE">[2]</a>
</li>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 5c4df9d

Please sign in to comment.