Deploying to gh-pages from @ 15bf334 🚀

Author: LTLA

docs/annotated.html

@@ -94,7 +94,7 @@
 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceknncolle__annoy.html" target="_self">knncolle_annoy</a></td><td class="desc">Approximate nearest neighbor search with Annoy </td></tr>
 <tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html" target="_self">AnnoyBuilder</a></td><td class="desc">Perform an approximate nearest neighbor search with Annoy </td></tr>
 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html" target="_self">AnnoyOptions</a></td><td class="desc">Options for <code>AnnoyBuilder()</code> </td></tr>
-<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html" target="_self">PrebuiltSaveConfig</a></td><td class="desc">Configuration of a saved Annoy index </td></tr>
+<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html" target="_self">AnnoyPrebuiltTypes</a></td><td class="desc">Template types of a saved Annoy index </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

docs/classes.html

@@ -89,14 +89,11 @@
   <div class="headertitle"><div class="title">Class Index</div></div>
 </div><!--header-->
 <div class="contents">
-<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a></div>
+<div class="qindex"><a class="qindex" href="#letter_A">A</a></div>
 <div class="classindex">
 <dl class="classindex even">
 <dt class="alphachar"><a id="letter_A" name="letter_A">A</a></dt>
-<dd><a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html">AnnoyBuilder</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd><dd><a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html">AnnoyOptions</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd></dl>
-<dl class="classindex odd">
-<dt class="alphachar"><a id="letter_P" name="letter_P">P</a></dt>
-<dd><a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html">PrebuiltSaveConfig</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd></dl>
+<dd><a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html">AnnoyBuilder</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd><dd><a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html">AnnoyOptions</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd><dd><a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html">AnnoyPrebuiltTypes</a> (<a class="el" href="namespaceknncolle__annoy.html">knncolle_annoy</a>)</dd></dl>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->

docs/doxygen_crawl.html

@@ -20,8 +20,8 @@
 <a href="classknncolle__annoy_1_1AnnoyBuilder-members.html"/>
 <a href="structknncolle__annoy_1_1AnnoyOptions.html"/>
 <a href="structknncolle__annoy_1_1AnnoyOptions-members.html"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig-members.html"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes-members.html"/>
 <a href="dir_d44c64559bbebec7f509842c48db8b23.html"/>
 <a href="dir_0e0ab553bc889f86cc4fdbe50dae835c.html"/>
 <a href="index.html"/>
@@ -31,8 +31,6 @@
 <a href="namespacemembers.html"/>
 <a href="namespacemembers.html"/>
 <a href="namespacemembers.html"/>
-<a href="namespacemembers.html"/>
-<a href="namespacemembers_func.html"/>
 <a href="namespacemembers_func.html"/>
 <a href="namespacemembers_func.html"/>
 <a href="namespacemembers_func.html"/>
@@ -85,11 +83,12 @@
 <a href="knncolle__annoy_8hpp.html"/>
 <a href="load__annoy__prebuilt_8hpp.html"/>
 <a href="load__annoy__prebuilt_8hpp.html#a480d8350b6c83729f140253ee3ca64cb"/>
+<a href="load__annoy__prebuilt_8hpp.html#a57a33c712b732200c7b46d36f13bfb78"/>
 <a href="namespaceknncolle__annoy.html"/>
 <a href="namespaceknncolle__annoy.html#a0f46fd7ab22d7976baec00c98c038bea"/>
 <a href="namespaceknncolle__annoy.html#a46b2125811a26fae459c4c54803be3ae"/>
 <a href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb"/>
-<a href="namespaceknncolle__annoy.html#a50ce8ca5c3c5ae8fa68bc34a67f092d9"/>
+<a href="namespaceknncolle__annoy.html#a57a33c712b732200c7b46d36f13bfb78"/>
 <a href="namespaceknncolle__annoy.html#a5a77303e4f9434ddc0218aa14b19f1fb"/>
 <a href="namespaceknncolle__annoy.html#ab5b68f6564b16322f9b231b4548ecd0c"/>
 <a href="namespaceknncolle__annoy.html#ab5b68f6564b16322f9b231b4548ecd0ca027acd3aa6b1dd7f26119d3cf0f9a063"/>
@@ -123,14 +122,13 @@
 <a href="structknncolle__annoy_1_1AnnoyOptions.html"/>
 <a href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932"/>
 <a href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a28f36ec21f626ad20b19368475240d73"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a509ca03b8cb13c972f16d4b82f8e547e"/>
-<a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a7504e43b372b437bc1940397bf550086"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a06aaf2f6d1337bf71175ffc35a45ded2"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a189a767607a3b01f203ec7eb312f883e"/>
+<a href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a3ebbe427960efa7d30fa5ffd80bdfe1b"/>
 <a href="utils_8hpp.html"/>
 <a href="utils_8hpp.html#a0f46fd7ab22d7976baec00c98c038bea"/>
 <a href="utils_8hpp.html#a46b2125811a26fae459c4c54803be3ae"/>
-<a href="utils_8hpp.html#a50ce8ca5c3c5ae8fa68bc34a67f092d9"/>
 <a href="utils_8hpp.html#a5a77303e4f9434ddc0218aa14b19f1fb"/>
 <a href="utils_8hpp.html#ab5b68f6564b16322f9b231b4548ecd0c"/>
 <a href="utils_8hpp.html#ab5b68f6564b16322f9b231b4548ecd0ca027acd3aa6b1dd7f26119d3cf0f9a063"/>

docs/functions.html

@@ -91,10 +91,10 @@
 <li>build_known_raw()&#160;:&#160;<a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html#a9c2ddf11d516555b458b1dad3306102d">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></li>
 <li>build_known_shared()&#160;:&#160;<a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html#aeb1e5d4f935173899a8cc98b7bdb6684">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></li>
 <li>build_known_unique()&#160;:&#160;<a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html#a39cd70c3a33db9b2700cb0da079e041d">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></li>
-<li>data&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a7504e43b372b437bc1940397bf550086">knncolle_annoy::PrebuiltSaveConfig</a></li>
-<li>distance&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a509ca03b8cb13c972f16d4b82f8e547e">knncolle_annoy::PrebuiltSaveConfig</a></li>
+<li>data&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a189a767607a3b01f203ec7eb312f883e">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
+<li>distance&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a06aaf2f6d1337bf71175ffc35a45ded2">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
 <li>get_options()&#160;:&#160;<a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html#a45abac40b562d4aa23e89b0eae298dd0">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></li>
-<li>index&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a28f36ec21f626ad20b19368475240d73">knncolle_annoy::PrebuiltSaveConfig</a></li>
+<li>index&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a3ebbe427960efa7d30fa5ffd80bdfe1b">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
 <li>num_trees&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">knncolle_annoy::AnnoyOptions</a></li>
 <li>search_mult&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5">knncolle_annoy::AnnoyOptions</a></li>
 </ul>

docs/functions_vars.html

@@ -87,9 +87,9 @@
 
 <div class="contents">
 <div class="textblock">Here is a list of all documented variables with links to the class documentation for each member:</div><ul>
-<li>data&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a7504e43b372b437bc1940397bf550086">knncolle_annoy::PrebuiltSaveConfig</a></li>
-<li>distance&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a509ca03b8cb13c972f16d4b82f8e547e">knncolle_annoy::PrebuiltSaveConfig</a></li>
-<li>index&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a28f36ec21f626ad20b19368475240d73">knncolle_annoy::PrebuiltSaveConfig</a></li>
+<li>data&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a189a767607a3b01f203ec7eb312f883e">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
+<li>distance&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a06aaf2f6d1337bf71175ffc35a45ded2">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
+<li>index&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a3ebbe427960efa7d30fa5ffd80bdfe1b">knncolle_annoy::AnnoyPrebuiltTypes</a></li>
 <li>num_trees&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">knncolle_annoy::AnnoyOptions</a></li>
 <li>search_mult&#160;:&#160;<a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5">knncolle_annoy::AnnoyOptions</a></li>
 </ul>

docs/hierarchy.html

@@ -92,9 +92,9 @@
 <div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span>]</div><table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1AnnoyOptions.html" target="_self">knncolle_annoy::AnnoyOptions</a></td><td class="desc">Options for <code>AnnoyBuilder()</code> </td></tr>
-<tr id="row_1_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Builder.html" target="_self">knncolle::Builder&lt; typename Index_, typename Data_, typename Distance_, class Matrix_ &gt;</a>&#160;[external]</td><td class="desc"></td></tr>
-<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html" target="_self">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></td><td class="desc">Perform an approximate nearest neighbor search with Annoy </td></tr>
-<tr id="row_2_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html" target="_self">knncolle_annoy::PrebuiltSaveConfig</a></td><td class="desc">Configuration of a saved Annoy index </td></tr>
+<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html" target="_self">knncolle_annoy::AnnoyPrebuiltTypes</a></td><td class="desc">Template types of a saved Annoy index </td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="dynsection.toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Builder.html" target="_self">knncolle::Builder&lt; typename Index_, typename Data_, typename Distance_, class Matrix_ &gt;</a>&#160;[external]</td><td class="desc"></td></tr>
+<tr id="row_2_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classknncolle__annoy_1_1AnnoyBuilder.html" target="_self">knncolle_annoy::AnnoyBuilder&lt; Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_, Matrix_ &gt;</a></td><td class="desc">Perform an approximate nearest neighbor search with Annoy </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

docs/index.html

@@ -170,7 +170,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <p>To save and reload Annoy indices from disk, we need to register a loading function into <b>knncolle</b>'s <code>load_prebuilt()</code> registry. This is a little complicated as we must decide on which combinations of types and distances we want to deal with. Here, 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::save_name] = [](<span class="keyword">const</span> std::string&amp; prefix) -&gt; Prebuilt&lt;int, double, double&gt;* {</div>
-<div class="line">    <span class="keyword">auto</span> config = <a class="code hl_function" href="namespaceknncolle__annoy.html#a50ce8ca5c3c5ae8fa68bc34a67f092d9">knncolle_annoy::scan_prebuilt_save_config</a>(prefix);</div>
+<div class="line">    <span class="keyword">auto</span> config = knncolle_annoy::scan_prebuilt_save_config(prefix);</div>
 <div class="line"> </div>
 <div class="line">    <span class="comment">// Maybe add some checks that the types are as expected.</span></div>
 <div class="line">    <span class="keywordflow">if</span> (config.index != <a class="code hl_function" href="namespaceknncolle__annoy.html#a5a77303e4f9434ddc0218aa14b19f1fb">knncolle_annoy::get_numeric_type&lt;int&gt;</a>()) {</div>
@@ -187,8 +187,7 @@ <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#a480d8350b6c83729f140253ee3ca64cb">knncolle_annoy::load_annoy_prebuilt&lt;int, double, double, Annoy::Manhattan&gt;</a>();</div>
 <div class="line">};</div>
-<div class="ttc" id="anamespaceknncolle__annoy_html_a480d8350b6c83729f140253ee3ca64cb"><div class="ttname"><a href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">knncolle_annoy::load_annoy_prebuilt</a></div><div class="ttdeci">auto load_annoy_prebuilt(const std::string &amp;prefix)</div><div class="ttdef"><b>Definition</b> load_annoy_prebuilt.hpp:62</div></div>
-<div class="ttc" id="anamespaceknncolle__annoy_html_a50ce8ca5c3c5ae8fa68bc34a67f092d9"><div class="ttname"><a href="namespaceknncolle__annoy.html#a50ce8ca5c3c5ae8fa68bc34a67f092d9">knncolle_annoy::scan_prebuilt_save_config</a></div><div class="ttdeci">PrebuiltSaveConfig scan_prebuilt_save_config(const std::string &amp;prefix)</div><div class="ttdef"><b>Definition</b> utils.hpp:218</div></div>
+<div class="ttc" id="anamespaceknncolle__annoy_html_a480d8350b6c83729f140253ee3ca64cb"><div class="ttname"><a href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">knncolle_annoy::load_annoy_prebuilt</a></div><div class="ttdeci">auto load_annoy_prebuilt(const std::string &amp;prefix)</div><div class="ttdef"><b>Definition</b> load_annoy_prebuilt.hpp:103</div></div>
 <div class="ttc" id="anamespaceknncolle__annoy_html_a5a77303e4f9434ddc0218aa14b19f1fb"><div class="ttname"><a href="namespaceknncolle__annoy.html#a5a77303e4f9434ddc0218aa14b19f1fb">knncolle_annoy::get_numeric_type</a></div><div class="ttdeci">NumericType get_numeric_type()</div><div class="ttdef"><b>Definition</b> utils.hpp:89</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#a87930f878bf3a22297b851173caaf893">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>