Skip to content

Commit

Permalink
Deploying to gh-pages from @ 02d5c72 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Aug 11, 2024
1 parent 7d20795 commit 541b295
Show file tree
Hide file tree
Showing 51 changed files with 420 additions and 356 deletions.
7 changes: 5 additions & 2 deletions docs/classknncolle__hnsw_1_1HnswSearcher-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,11 @@

<p>This is the complete list of members for <a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>search</b>(Index_ i, Index_ k, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances) (defined in <a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a>)</td><td class="entry"><a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>search</b>(const Float_ *query, Index_ k, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances) (defined in <a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a>)</td><td class="entry"><a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#a8362d0f6ea1b7f6e09d26a9188d31d1d">can_search_all</a>() const</td><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html">knncolle::Searcher&lt; Index_, Float_ &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>search</b>(Index_ i, Index_ k, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances) (defined in <a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a>)</td><td class="entry"><a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>search</b>(const Float_ *query, Index_ k, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances) (defined in <a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a>)</td><td class="entry"><a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html">knncolle_hnsw::HnswSearcher&lt; Dim_, Index_, Float_, InternalData_ &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#ae7fb8a8e436303c5917f3717393cf056">search_all</a>(Index_ i, Float_ distance, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances)</td><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html">knncolle::Searcher&lt; Index_, Float_ &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#adbe92827aebee347f57257591712d093">search_all</a>(const Float_ *query, Float_ distance, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances)</td><td class="entry"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html">knncolle::Searcher&lt; Index_, Float_ &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
10 changes: 10 additions & 0 deletions docs/classknncolle__hnsw_1_1HnswSearcher.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,16 @@
<tr class="separator:a9d70835c18c171c0ec244acc8762caf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab478260e0e1b7f8f286a64d85f07afc2" id="r_ab478260e0e1b7f8f286a64d85f07afc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classknncolle__hnsw_1_1HnswSearcher.html#ab478260e0e1b7f8f286a64d85f07afc2">search</a> (<a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">const</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Float_</a> *<a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">query</a>, <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Index_</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">k</a>, std::vector&lt; <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Index_</a> &gt; *<a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">output_indices</a>, std::vector&lt; <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Float_</a> &gt; *<a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">output_distances</a>)</td></tr>
<tr class="separator:ab478260e0e1b7f8f286a64d85f07afc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classknncolle_1_1Searcher"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classknncolle_1_1Searcher')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html">knncolle::Searcher&lt; Index_, Float_ &gt;</a></td></tr>
<tr class="memitem:a8362d0f6ea1b7f6e09d26a9188d31d1d inherit pub_methods_classknncolle_1_1Searcher" id="r_a8362d0f6ea1b7f6e09d26a9188d31d1d"><td class="memItemLeft" align="right" valign="top">
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#a8362d0f6ea1b7f6e09d26a9188d31d1d">can_search_all</a> () const</td></tr>
<tr class="separator:a8362d0f6ea1b7f6e09d26a9188d31d1d inherit pub_methods_classknncolle_1_1Searcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7fb8a8e436303c5917f3717393cf056 inherit pub_methods_classknncolle_1_1Searcher" id="r_ae7fb8a8e436303c5917f3717393cf056"><td class="memItemLeft" align="right" valign="top">
virtual Index_&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#ae7fb8a8e436303c5917f3717393cf056">search_all</a> (Index_ i, Float_ distance, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances)</td></tr>
<tr class="separator:ae7fb8a8e436303c5917f3717393cf056 inherit pub_methods_classknncolle_1_1Searcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbe92827aebee347f57257591712d093 inherit pub_methods_classknncolle_1_1Searcher" id="r_adbe92827aebee347f57257591712d093"><td class="memItemLeft" align="right" valign="top">
virtual Index_&#160;</td><td class="memItemRight" valign="bottom"><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#adbe92827aebee347f57257591712d093">search_all</a> (const Float_ *query, Float_ distance, std::vector&lt; Index_ &gt; *output_indices, std::vector&lt; Float_ &gt; *output_distances)</td></tr>
<tr class="separator:adbe92827aebee347f57257591712d093 inherit pub_methods_classknncolle_1_1Searcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">typename</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Dim_</a>, <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">typename</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Index_</a>, <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">typename</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">Float_</a>, <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">typename</a> <a class="el" href="classknncolle__hnsw_1_1HnswPrebuilt.html">InternalData_</a>&gt;<br />
Expand Down
5 changes: 3 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,10 @@ <h1><a class="anchor" id="autotoc_md2"></a>
<div class="line"><span class="keyword">auto</span> an_index = an_builder.build_unique(mat);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Find 10 (approximate) nearest neighbors of every element.</span></div>
<div class="line"><span class="keyword">auto</span> results = knncolle::find_nearest_neighbors(*an_index, 10); </div>
<div class="line"><span class="keyword">auto</span> results = <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a22e035b2d5eb293fd828a67e61f3213d">knncolle::find_nearest_neighbors</a>(*an_index, 10); </div>
<div class="ttc" id="aclassknncolle_1_1SimpleMatrix_html"><div class="ttname"><a href="https://knncolle.github.io/knncolle/classknncolle_1_1SimpleMatrix.html">knncolle::SimpleMatrix</a></div></div>
<div class="ttc" id="aclassknncolle__hnsw_1_1HnswPrebuilt_html"><div class="ttname"><a href="classknncolle__hnsw_1_1HnswPrebuilt.html">knncolle_hnsw::HnswPrebuilt</a></div><div class="ttdoc">Prebuilt index for an Hnsw search.</div><div class="ttdef"><b>Definition</b> knncolle_hnsw.hpp:218</div></div>
<div class="ttc" id="aclassknncolle__hnsw_1_1HnswPrebuilt_html"><div class="ttname"><a href="classknncolle__hnsw_1_1HnswPrebuilt.html">knncolle_hnsw::HnswPrebuilt</a></div><div class="ttdoc">Prebuilt index for an Hnsw search.</div><div class="ttdef"><b>Definition</b> knncolle_hnsw.hpp:220</div></div>
<div class="ttc" id="anamespaceknncolle_html_a22e035b2d5eb293fd828a67e61f3213d"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a22e035b2d5eb293fd828a67e61f3213d">knncolle::find_nearest_neighbors</a></div><div class="ttdeci">NeighborList&lt; Index_, Float_ &gt; find_nearest_neighbors(const Prebuilt&lt; Dim_, Index_, Float_ &gt; &amp;index, int k, int num_threads=1)</div></div>
</div><!-- fragment --><p>We could alternate between exact and approximate searches at run-time:</p>
<div class="fragment"><div class="line">std::unique_ptr&lt;knncolle::Prebuilt&lt;int, int, double&gt; &gt; ptr;</div>
<div class="line"><span class="keywordflow">if</span> (use_exact) {</div>
Expand Down
2 changes: 2 additions & 0 deletions docs/knncolle__hnsw_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;queue&gt;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &quot;<a class="elRef" href="https://knncolle.github.io/knncolle/knncolle_8hpp.html">knncolle/knncolle.hpp</a>&quot;</code><br />
<code>#include &quot;hnswlib/hnswalg.h&quot;</code><br />
Expand Down
Loading

0 comments on commit 541b295

Please sign in to comment.