Deploying to gh-pages from @ cace2a4 🚀

Author: LTLA

docs/Annoy_8hpp_source.html

@@ -31,6 +31,8 @@
 <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,6 +87,7 @@
 <a href="load__annoy__prebuilt_8hpp.html#a480d8350b6c83729f140253ee3ca64cb"/>
 <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#a5a77303e4f9434ddc0218aa14b19f1fb"/>
@@ -126,6 +129,7 @@
 <a href="structknncolle__annoy_1_1PrebuiltSaveConfig.html#a7504e43b372b437bc1940397bf550086"/>
 <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"/>

docs/doxygen_crawl.html

@@ -114,7 +114,7 @@ <h1><a class="anchor" id="autotoc_md2"></a>
 <div class="line"><span class="keyword">auto</span> results = <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a2c6d8b116464bab254bda34216338c3c">knncolle::find_nearest_neighbors</a>(*an_index, 10); </div>
 <div class="ttc" id="aclassknncolle_1_1Builder_html_a93cac638de3e4ad31919bc5d677d16b7"><div class="ttname"><a href="https://knncolle.github.io/knncolle/classknncolle_1_1Builder.html#a93cac638de3e4ad31919bc5d677d16b7">knncolle::Builder::build_unique</a></div><div class="ttdeci">std::unique_ptr&lt; Prebuilt&lt; Index_, Data_, Distance_ &gt; &gt; build_unique(const Matrix_ &amp;data) const</div></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__annoy_1_1AnnoyBuilder_html"><div class="ttname"><a href="classknncolle__annoy_1_1AnnoyBuilder.html">knncolle_annoy::AnnoyBuilder</a></div><div class="ttdoc">Perform an approximate nearest neighbor search with Annoy.</div><div class="ttdef"><b>Definition</b> Annoy.hpp:403</div></div>
+<div class="ttc" id="aclassknncolle__annoy_1_1AnnoyBuilder_html"><div class="ttname"><a href="classknncolle__annoy_1_1AnnoyBuilder.html">knncolle_annoy::AnnoyBuilder</a></div><div class="ttdoc">Perform an approximate nearest neighbor search with Annoy.</div><div class="ttdef"><b>Definition</b> Annoy.hpp:408</div></div>
 <div class="ttc" id="aknncolle__annoy_8hpp_html"><div class="ttname"><a href="knncolle__annoy_8hpp.html">knncolle_annoy.hpp</a></div><div class="ttdoc">Approximate nearest neighbor search with Annoy.</div></div>
 <div class="ttc" id="anamespaceknncolle_html_a2c6d8b116464bab254bda34216338c3c"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a2c6d8b116464bab254bda34216338c3c">knncolle::find_nearest_neighbors</a></div><div class="ttdeci">NeighborList&lt; Index_, Distance_ &gt; find_nearest_neighbors(const Prebuilt&lt; Index_, Data_, Distance_ &gt; &amp;index, int k, int num_threads=1)</div></div>
 </div><!-- fragment --><p>Check out the <a href="https://knncolle.github.io/knncolle_annoy/">reference documentation</a> for more details.</p>
@@ -131,7 +131,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 </div><!-- fragment --><p>We could also modify the builder after construction:</p>
 <div class="fragment"><div class="line"><span class="keyword">auto</span>&amp; opt = an_builder.<a class="code hl_function" href="classknncolle__annoy_1_1AnnoyBuilder.html#a45abac40b562d4aa23e89b0eae298dd0">get_options</a>()</div>
 <div class="line">opt.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">num_trees</a> = 100;</div>
-<div class="ttc" id="aclassknncolle__annoy_1_1AnnoyBuilder_html_a45abac40b562d4aa23e89b0eae298dd0"><div class="ttname"><a href="classknncolle__annoy_1_1AnnoyBuilder.html#a45abac40b562d4aa23e89b0eae298dd0">knncolle_annoy::AnnoyBuilder::get_options</a></div><div class="ttdeci">AnnoyOptions &amp; get_options()</div><div class="ttdef"><b>Definition</b> Annoy.hpp:422</div></div>
+<div class="ttc" id="aclassknncolle__annoy_1_1AnnoyBuilder_html_a45abac40b562d4aa23e89b0eae298dd0"><div class="ttname"><a href="classknncolle__annoy_1_1AnnoyBuilder.html#a45abac40b562d4aa23e89b0eae298dd0">knncolle_annoy::AnnoyBuilder::get_options</a></div><div class="ttdeci">AnnoyOptions &amp; get_options()</div><div class="ttdef"><b>Definition</b> Annoy.hpp:427</div></div>
 </div><!-- fragment --><p>Advanced users can configure the template parameters to use more suitable types for their applications. A hypothetical configuration is shown below with (mostly made up) reasons:</p>
 <div class="fragment"><div class="line"><span class="keyword">typedef</span> <a class="code hl_class" href="classknncolle__annoy_1_1AnnoyBuilder.html">knncolle_annoy::AnnoyBuilder</a>&lt;</div>
 <div class="line">    <span class="comment">// The type for the observation indices - perhaps int isn&#39;t big enough to</span></div>
@@ -188,8 +188,8 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <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:213</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:84</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_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>
 <div class="fragment"><div class="line">std::string path_prefix = <span class="stringliteral">&quot;anno/location/here_&quot;</span>;</div>

docs/index.html

@@ -187,6 +187,13 @@
       <anchor>a50ce8ca5c3c5ae8fa68bc34a67f092d9</anchor>
       <arglist>(const std::string &amp;prefix)</arglist>
     </member>
+    <member kind="function">
+      <type>std::function&lt; void(const std::string &amp;)&gt; &amp;</type>
+      <name>customize_save_for_annoy_types</name>
+      <anchorfile>namespaceknncolle__annoy.html</anchorfile>
+      <anchor>a46b2125811a26fae459c4c54803be3ae</anchor>
+      <arglist>()</arglist>
+    </member>
   </compound>
   <compound kind="page">
     <name>index</name>

docs/knncolle_annoy.tag

@@ -158,6 +158,9 @@
 <tr class="separator:a5a77303e4f9434ddc0218aa14b19f1fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a50ce8ca5c3c5ae8fa68bc34a67f092d9" id="r_a50ce8ca5c3c5ae8fa68bc34a67f092d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structknncolle__annoy_1_1PrebuiltSaveConfig.html">PrebuiltSaveConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50ce8ca5c3c5ae8fa68bc34a67f092d9">scan_prebuilt_save_config</a> (const std::string &amp;prefix)</td></tr>
 <tr class="separator:a50ce8ca5c3c5ae8fa68bc34a67f092d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a46b2125811a26fae459c4c54803be3ae" id="r_a46b2125811a26fae459c4c54803be3ae"><td class="memTemplParams" colspan="2">template&lt;class AnnoyDistance_ , typename AnnoyIndex_ , typename AnnoyData_ &gt; </td></tr>
+<tr class="memitem:a46b2125811a26fae459c4c54803be3ae"><td class="memTemplItemLeft" align="right" valign="top">std::function&lt; void(const std::string &amp;)&gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a46b2125811a26fae459c4c54803be3ae">customize_save_for_annoy_types</a> ()</td></tr>
+<tr class="separator:a46b2125811a26fae459c4c54803be3ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Approximate nearest neighbor search with Annoy. </p>
@@ -186,6 +189,35 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab5b68f6564b16322f9b231b4
 </div>
 </div>
 <h2 class="groupheader">Function Documentation</h2>
+<a id="a46b2125811a26fae459c4c54803be3ae" name="a46b2125811a26fae459c4c54803be3ae"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a46b2125811a26fae459c4c54803be3ae">&#9670;&#160;</a></span>customize_save_for_annoy_types()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<div class="memtemplate">
+template&lt;class AnnoyDistance_ , typename AnnoyIndex_ , typename AnnoyData_ &gt; </div>
+      <table class="memname">
+        <tr>
+          <td class="memname">std::function&lt; void(const std::string &amp;)&gt; &amp; knncolle_annoy::customize_save_for_annoy_types </td>
+          <td>(</td>
+          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Define a customized saving function to preserve type information from the Annoy index in <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code>. Users can provide their own function here, to handle types that are unknown to <code><a class="el" href="#a5a77303e4f9434ddc0218aa14b19f1fb">get_numeric_type()</a></code> or <code><a class="el" href="#a0f46fd7ab22d7976baec00c98c038bea">get_distance_name()</a></code>. Any modifications to this function are not thread-safe and should be done in a serial section.</p>
+<dl class="tparams"><dt>Template Parameters</dt><dd>
+  <table class="tparams">
+    <tr><td class="paramname">AnnoyDistance_</td><td>An <b>Annoy</b>-compatible class to compute the distance between vectors. </td></tr>
+    <tr><td class="paramname">AnnoyIndex_</td><td>Integer type for the observation indices in the Annoy index. </td></tr>
+    <tr><td class="paramname">AnnoyData_</td><td>Floating-point type for data in the Annoy index.</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>A global function for saving information about <code>AnnoyDistance_</code>, <code>AnnoyIndex_</code> and <code>AnnoyData_</code>. If set, this will be called by the <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code> method for the Annoy <code>Prebuilt</code> subclass. </dd></dl>
+
+</div>
+</div>
 <a id="a0f46fd7ab22d7976baec00c98c038bea" name="a0f46fd7ab22d7976baec00c98c038bea"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a0f46fd7ab22d7976baec00c98c038bea">&#9670;&#160;</a></span>get_distance_name()</h2>
 
@@ -208,7 +240,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0f46fd7ab22d7976baec00c9
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>Name of the distance metric, e.g., <code>"euclidean"</code>, <code>"manhattan"</code>. This is taken from <code>AnnoyDistance_::name()</code> if such a method exists, otherwise <code>"unknown"</code> is returned. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>Name of the distance metric, e.g., <code>"euclidean"</code>, <code>"manhattan"</code>. This is taken from <code>AnnoyDistance_::name()</code> if such a method exists, otherwise <code>"unknown"</code> is returned.</dd></dl>
+<p>For unknown distances, consider using <code><a class="el" href="#a46b2125811a26fae459c4c54803be3ae">customize_save_for_annoy_types()</a></code> to add more information to the on-disk representation during a <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code> call. </p>
 
 </div>
 </div>
@@ -234,7 +267,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5a77303e4f9434ddc0218aa1
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>Identity of the numeric type. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>Identity of the numeric type.</dd></dl>
+<p>For unknown types, consider using <code><a class="el" href="#a46b2125811a26fae459c4c54803be3ae">customize_save_for_annoy_types()</a></code> to add more information to the on-disk representation during a <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code> call. </p>
 
 </div>
 </div>

docs/namespaceknncolle__annoy.html

@@ -87,6 +87,7 @@
 
 <div class="contents">
 <div class="textblock">Here is a list of all documented namespace members with links to the namespaces they belong to:</div><ul>
+<li>customize_save_for_annoy_types()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a46b2125811a26fae459c4c54803be3ae">knncolle_annoy</a></li>
 <li>get_distance_name()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a0f46fd7ab22d7976baec00c98c038bea">knncolle_annoy</a></li>
 <li>get_numeric_type()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a5a77303e4f9434ddc0218aa14b19f1fb">knncolle_annoy</a></li>
 <li>load_annoy_prebuilt()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">knncolle_annoy</a></li>

docs/namespacemembers.html

@@ -87,6 +87,7 @@
 
 <div class="contents">
 <div class="textblock">Here is a list of all documented namespace functions with links to the namespaces they belong to:</div><ul>
+<li>customize_save_for_annoy_types()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a46b2125811a26fae459c4c54803be3ae">knncolle_annoy</a></li>
 <li>get_distance_name()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a0f46fd7ab22d7976baec00c98c038bea">knncolle_annoy</a></li>
 <li>get_numeric_type()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a5a77303e4f9434ddc0218aa14b19f1fb">knncolle_annoy</a></li>
 <li>load_annoy_prebuilt()&#160;:&#160;<a class="el" href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">knncolle_annoy</a></li>

docs/namespacemembers_func.html

@@ -6,5 +6,6 @@ var searchData=
   ['cmake_20with_20tt_20fetchcontent_20tt_3',['CMake with <tt>FetchContent</tt>',['../index.html#autotoc_md6',1,'']]],
   ['cmake_20with_20tt_20find_5fpackage_20tt_4',['CMake with <tt>find_package()</tt>',['../index.html#autotoc_md7',1,'']]],
   ['count_5fall_5fneighbors_5fwithout_5fself_5',['count_all_neighbors_without_self',['https://knncolle.github.io/knncolle/namespaceknncolle.html#ab636bced615a3a669ef0e207b5d848cc',1,'knncolle']]],
-  ['customizing_20the_20search_6',['Customizing the search',['../index.html#autotoc_md3',1,'']]]
+  ['customize_5fsave_5ffor_5fannoy_5ftypes_6',['customize_save_for_annoy_types',['../namespaceknncolle__annoy.html#a46b2125811a26fae459c4c54803be3ae',1,'knncolle_annoy']]],
+  ['customizing_20the_20search_7',['Customizing the search',['../index.html#autotoc_md3',1,'']]]
 ];

docs/search/all_2.js

@@ -2,5 +2,6 @@ var searchData=
 [
   ['quick_20start_0',['Quick start',['../index.html#autotoc_md2',1,'']]],
   ['quick_5fload_1',['quick_load',['https://knncolle.github.io/knncolle/namespaceknncolle.html#ac5079c0b39b7f9e10bd97341ccfad46c',1,'knncolle']]],
-  ['quick_5fsave_2',['quick_save',['https://knncolle.github.io/knncolle/namespaceknncolle.html#afc954146b2f7fe5cbd1c7f3a5610ba94',1,'knncolle']]]
+  ['quick_5fload_5fas_5fstring_2',['quick_load_as_string',['https://knncolle.github.io/knncolle/namespaceknncolle.html#a83e38fc963fa7d735ef8f0d11f1f5a4b',1,'knncolle']]],
+  ['quick_5fsave_3',['quick_save',['https://knncolle.github.io/knncolle/namespaceknncolle.html#afc954146b2f7fe5cbd1c7f3a5610ba94',1,'knncolle']]]
 ];

docs/search/all_e.js

@@ -3,5 +3,6 @@ var searchData=
   ['can_5fsearch_5fall_0',['can_search_all',['https://knncolle.github.io/knncolle/classknncolle_1_1Searcher.html#a175ab05c339e3aa39b974f1ceebc21a3',1,'knncolle::Searcher']]],
   ['cap_5fk_1',['cap_k',['https://knncolle.github.io/knncolle/namespaceknncolle.html#a926c81cd626de7081b073a891d352543',1,'knncolle']]],
   ['cap_5fk_5fquery_2',['cap_k_query',['https://knncolle.github.io/knncolle/namespaceknncolle.html#a918d96e82ead9e67d7c008bde1e22505',1,'knncolle']]],
-  ['count_5fall_5fneighbors_5fwithout_5fself_3',['count_all_neighbors_without_self',['https://knncolle.github.io/knncolle/namespaceknncolle.html#ab636bced615a3a669ef0e207b5d848cc',1,'knncolle']]]
+  ['count_5fall_5fneighbors_5fwithout_5fself_3',['count_all_neighbors_without_self',['https://knncolle.github.io/knncolle/namespaceknncolle.html#ab636bced615a3a669ef0e207b5d848cc',1,'knncolle']]],
+  ['customize_5fsave_5ffor_5fannoy_5ftypes_4',['customize_save_for_annoy_types',['../namespaceknncolle__annoy.html#a46b2125811a26fae459c4c54803be3ae',1,'knncolle_annoy']]]
 ];