Deploying to gh-pages from @ a80fc93 🚀

Author: LTLA

docs/index.html

@@ -169,7 +169,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 Saving and reloading indices</h1>
 <p>To save and reload Annoy indices from disk, we need to register a loading function into <b>knncolle</b>'s <code>load_prebuilt_registry()</code>. This is a little complicated as we must decide on which combinations of types and distances we want to deal with. In the example below, we only consider the obvious distance metrics and the defaults for the internal Annoy types, though more combinations could also be supported at the cost of larger binaries and longer compile times.</p>
 <div class="fragment"><div class="line"><span class="keyword">auto</span>&amp; reg = <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#aa08de1eb1a23d5e13dc11e23ad7967ea">knncolle::load_prebuilt_registry&lt;int, double, double&gt;</a>();</div>
-<div class="line">reg[knncolle_annoy::annoy_prebuilt_save_name] = [](<span class="keyword">const</span> std::filesystem::path&amp; dir) -&gt; Prebuilt&lt;int, double, double&gt;* {</div>
+<div class="line">reg[knncolle_annoy::annoy_prebuilt_save_name] = [](<span class="keyword">const</span> std::filesystem::path&amp; dir) -&gt; <a class="code hl_classRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html">knncolle::Prebuilt&lt;int, double, double&gt;</a>* {</div>
 <div class="line">    <span class="keyword">auto</span> config = <a class="code hl_function" href="namespaceknncolle__annoy.html#a9eff16d6db0a482607ada4d00b00c3d1">knncolle_annoy::load_annoy_prebuilt_types</a>(dir);</div>
 <div class="line"> </div>
 <div class="line">    <span class="comment">// Checks that the AnnoyIndex_ and AnnoyData_ types are the same as the defaults.</span></div>
@@ -187,11 +187,12 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <div class="line">    }</div>
 <div class="line">    <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceknncolle__annoy.html#a7869865e7f1417bd6fdcad52a7a66303">knncolle_annoy::load_annoy_prebuilt&lt;int, double, double, Annoy::Manhattan&gt;</a>(dir);</div>
 <div class="line">};</div>
+<div class="ttc" id="aclassknncolle_1_1Prebuilt_html"><div class="ttname"><a href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html">knncolle::Prebuilt</a></div></div>
 <div class="ttc" id="anamespaceknncolle__annoy_html_a7869865e7f1417bd6fdcad52a7a66303"><div class="ttname"><a href="namespaceknncolle__annoy.html#a7869865e7f1417bd6fdcad52a7a66303">knncolle_annoy::load_annoy_prebuilt</a></div><div class="ttdeci">auto load_annoy_prebuilt(const std::filesystem::path &amp;dir)</div><div class="ttdef"><b>Definition</b> load_annoy_prebuilt.hpp:107</div></div>
 <div class="ttc" id="anamespaceknncolle__annoy_html_a9eff16d6db0a482607ada4d00b00c3d1"><div class="ttname"><a href="namespaceknncolle__annoy.html#a9eff16d6db0a482607ada4d00b00c3d1">knncolle_annoy::load_annoy_prebuilt_types</a></div><div class="ttdeci">AnnoyPrebuiltTypes load_annoy_prebuilt_types(const std::filesystem::path &amp;dir)</div><div class="ttdef"><b>Definition</b> load_annoy_prebuilt.hpp:50</div></div>
 <div class="ttc" id="anamespaceknncolle_html_a84e640363d9246c58008c93166021f26"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a84e640363d9246c58008c93166021f26">knncolle::get_numeric_type</a></div><div class="ttdeci">NumericType get_numeric_type()</div></div>
 <div class="ttc" id="anamespaceknncolle_html_aa08de1eb1a23d5e13dc11e23ad7967ea"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#aa08de1eb1a23d5e13dc11e23ad7967ea">knncolle::load_prebuilt_registry</a></div><div class="ttdeci">std::unordered_map&lt; std::string, LoadPrebuiltFunction&lt; Index_, Data_, Distance_ &gt; &gt; &amp; load_prebuilt_registry()</div></div>
-</div><!-- fragment --><p>Then we can save and reload the <code>Prebuilt</code> Annoy indices. Note the caveats on <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#add21dc74e08a6ad495c6e241fa3d5968">knncolle::Prebuilt::save()</a></code> - specifically, the files are not guaranteed to be portable between machines or even different versions of <b><a class="el" href="namespaceknncolle__annoy.html" title="Approximate nearest neighbor search with Annoy.">knncolle_annoy</a></b>.</p>
+</div><!-- fragment --><p>Then we can save and reload the <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html">knncolle::Prebuilt</a></code> Annoy indices. Note the caveats on <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#add21dc74e08a6ad495c6e241fa3d5968">knncolle::Prebuilt::save()</a></code> - specifically, the files are not guaranteed to be portable between machines or even different versions of <b><a class="el" href="namespaceknncolle__annoy.html" title="Approximate nearest neighbor search with Annoy.">knncolle_annoy</a></b>.</p>
 <div class="fragment"><div class="line">std::filesystem::path save_loc = <span class="stringliteral">&quot;annoy/location/here&quot;</span>;</div>
 <div class="line">std::filesystem::create_directory(save_loc);</div>
 <div class="line">an_index.save(save_loc);</div>
@@ -209,7 +210,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <div class="line">};</div>
 <div class="line"> </div>
 <div class="line"><span class="comment">// Make a new loading function that uses the saved custom information. </span></div>
-<div class="line">reg[knncolle_annoy::annoy_prebuilt_save_name] = [](<span class="keyword">const</span> std::filesystem::path&amp; dir) -&gt; Prebuilt&lt;int, double, double&gt;* {</div>
+<div class="line">reg[knncolle_annoy::annoy_prebuilt_save_name] = [](<span class="keyword">const</span> std::filesystem::path&amp; dir) -&gt; <a class="code hl_classRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html">knncolle::Prebuilt&lt;int, double, double&gt;</a>* {</div>
 <div class="line">    <span class="keyword">auto</span> config = <a class="code hl_function" href="namespaceknncolle__annoy.html#a9eff16d6db0a482607ada4d00b00c3d1">knncolle_annoy::load_annoy_prebuilt_types</a>(dir);</div>
 <div class="line">    <span class="keywordflow">if</span> (config.index != <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a84e640363d9246c58008c93166021f26">knncolle::get_numeric_type&lt;int&gt;</a>()) {</div>
 <div class="line">        <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">&quot;unexpected type for the Annoy index&quot;</span>);</div>