Skip to content

Commit

Permalink
Sphinx rebuild (6a419d4).
Browse files Browse the repository at this point in the history
  • Loading branch information
facebook-github-bot committed Dec 6, 2024
1 parent 6a419d4 commit 076940a
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/cpp_api/file/HNSW_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,11 @@ <h1>File HNSW.h<a class="headerlink" href="#file-hnsw-h" title="Permalink to thi
<span id="_CPPv3N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats"></span><span id="_CPPv2N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats"></span><span id="faiss::search_from_candidate_unbounded__HNSWCR.HNSW::NodeCR.DistanceComputerR.i.VisitedTableP.HNSWStatsR"></span><span class="target" id="namespacefaiss_1ab54b6b6ec63e400ffd053609ab833ed9"></span><a class="reference internal" href="../namespace/namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">priority_queue</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5faiss4HNSW4NodeE" title="faiss::HNSW::Node"><span class="n"><span class="pre">Node</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">search_from_candidate_unbounded</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hnsw</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5faiss4HNSW4NodeE" title="faiss::HNSW::Node"><span class="n"><span class="pre">Node</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">node</span></span>, <a class="reference internal" href="DistanceComputer_8h.html#_CPPv4N5faiss16DistanceComputerE" title="faiss::DistanceComputer"><span class="n"><span class="pre">DistanceComputer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">qdis</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ef</span></span>, <a class="reference internal" href="AuxIndexStructures_8h.html#_CPPv4N5faiss12VisitedTableE" title="faiss::VisitedTable"><span class="n"><span class="pre">VisitedTable</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">vt</span></span>, <a class="reference internal" href="#_CPPv4N5faiss9HNSWStatsE" title="faiss::HNSWStats"><span class="n"><span class="pre">HNSWStats</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">stats</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb">
<span id="_CPPv3N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb"></span><span id="_CPPv2N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb"></span><span id="faiss::search_neighbors_to_add__HNSWR.DistanceComputerR.std::priority_queue:HNSW::NodeDistCloser:R.i.float.i.VisitedTableR.b"></span><span class="target" id="namespacefaiss_1ad97c6c4a248bc0ac4399e4f0eea2ff99"></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">search_neighbors_to_add</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hnsw</span></span>, <a class="reference internal" href="DistanceComputer_8h.html#_CPPv4N5faiss16DistanceComputerE" title="faiss::DistanceComputer"><span class="n"><span class="pre">DistanceComputer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">qdis</span></span>, <a class="reference internal" href="../namespace/namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">priority_queue</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5faiss4HNSW14NodeDistCloserE" title="faiss::HNSW::NodeDistCloser"><span class="n"><span class="pre">NodeDistCloser</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">results</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">entry_point</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">d_entry_point</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">level</span></span>, <a class="reference internal" href="AuxIndexStructures_8h.html#_CPPv4N5faiss12VisitedTableE" title="faiss::VisitedTable"><span class="n"><span class="pre">VisitedTable</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">vt</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reference_version</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-variables">Variables</p>
Expand Down
5 changes: 5 additions & 0 deletions docs/cpp_api/namespace/namespacefaiss.html
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,11 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin
<span id="_CPPv3N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats"></span><span id="_CPPv2N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats"></span><span id="faiss::search_from_candidate_unbounded__HNSWCR.HNSW::NodeCR.DistanceComputerR.i.VisitedTableP.HNSWStatsR"></span><span class="target" id="namespacefaiss_1ab54b6b6ec63e400ffd053609ab833ed9"></span><a class="reference internal" href="namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">priority_queue</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSW4NodeE" title="faiss::HNSW::Node"><span class="n"><span class="pre">Node</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">search_from_candidate_unbounded</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hnsw</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSW4NodeE" title="faiss::HNSW::Node"><span class="n"><span class="pre">Node</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">node</span></span>, <a class="reference internal" href="../file/DistanceComputer_8h.html#_CPPv4N5faiss16DistanceComputerE" title="faiss::DistanceComputer"><span class="n"><span class="pre">DistanceComputer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">qdis</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ef</span></span>, <a class="reference internal" href="../file/AuxIndexStructures_8h.html#_CPPv4N5faiss12VisitedTableE" title="faiss::VisitedTable"><span class="n"><span class="pre">VisitedTable</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">vt</span></span>, <a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss9HNSWStatsE" title="faiss::HNSWStats"><span class="n"><span class="pre">HNSWStats</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">stats</span></span><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb">
<span id="_CPPv3N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb"></span><span id="_CPPv2N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb"></span><span id="faiss::search_neighbors_to_add__HNSWR.DistanceComputerR.std::priority_queue:HNSW::NodeDistCloser:R.i.float.i.VisitedTableR.b"></span><span class="target" id="namespacefaiss_1ad97c6c4a248bc0ac4399e4f0eea2ff99"></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">search_neighbors_to_add</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">hnsw</span></span>, <a class="reference internal" href="../file/DistanceComputer_8h.html#_CPPv4N5faiss16DistanceComputerE" title="faiss::DistanceComputer"><span class="n"><span class="pre">DistanceComputer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">qdis</span></span>, <a class="reference internal" href="namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">priority_queue</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSWE" title="faiss::HNSW"><span class="n"><span class="pre">HNSW</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="../file/HNSW_8h.html#_CPPv4N5faiss4HNSW14NodeDistCloserE" title="faiss::HNSW::NodeDistCloser"><span class="n"><span class="pre">NodeDistCloser</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">results</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">entry_point</span></span>, <span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">d_entry_point</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">level</span></span>, <a class="reference internal" href="../file/AuxIndexStructures_8h.html#_CPPv4N5faiss12VisitedTableE" title="faiss::VisitedTable"><span class="n"><span class="pre">VisitedTable</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">vt</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reference_version</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5faiss17read_index_headerEP5IndexP8IOReader">
<span id="_CPPv3N5faiss17read_index_headerEP5IndexP8IOReader"></span><span id="_CPPv2N5faiss17read_index_headerEP5IndexP8IOReader"></span><span id="faiss::read_index_header__IndexP.IOReaderP"></span><span class="target" id="namespacefaiss_1a33f83fe5af91626556b1ccde1f3cafcb"></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">read_index_header</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../file/Index_8h.html#_CPPv4N5faiss5IndexE" title="faiss::Index"><span class="n"><span class="pre">Index</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">idx</span></span>, <a class="reference internal" href="../file/io_8h.html#_CPPv4N5faiss8IOReaderE" title="faiss::IOReader"><span class="n"><span class="pre">IOReader</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">f</span></span><span class="sig-paren">)</span><br /></dt>
Expand Down
2 changes: 2 additions & 0 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -15524,6 +15524,8 @@ <h2 id="F">F</h2>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats">faiss::search_from_candidate_unbounded (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss31search_from_candidate_unboundedERK4HNSWRKN4HNSW4NodeER16DistanceComputeriP12VisitedTableR9HNSWStats">[1]</a>
</li>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss22search_from_candidatesERK4HNSWR16DistanceComputerR13ResultHandlerIN4HNSW1CEERN4HNSW11MinimaxHeapER12VisitedTableR9HNSWStatsiiPK20SearchParametersHNSW">faiss::search_from_candidates (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss22search_from_candidatesERK4HNSWR16DistanceComputerR13ResultHandlerIN4HNSW1CEERN4HNSW11MinimaxHeapER12VisitedTableR9HNSWStatsiiPK20SearchParametersHNSW">[1]</a>
</li>
<li><a href="cpp_api/file/HNSW_8h.html#_CPPv4N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb">faiss::search_neighbors_to_add (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss23search_neighbors_to_addER4HNSWR16DistanceComputerRNSt14priority_queueIN4HNSW14NodeDistCloserEEEifiR12VisitedTableb">[1]</a>
</li>
<li><a href="cpp_api/file/Index_8h.html#_CPPv4N5faiss16SearchParametersE">faiss::SearchParameters (C++ struct)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss16SearchParametersE">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1SearchParameters.html#_CPPv4N5faiss16SearchParametersE">[2]</a>
</li>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 076940a

Please sign in to comment.