Deploying to gh-pages from @ 799d7a5 🚀

Author: LTLA

docs/Annoy_8hpp_source.html

@@ -417,12 +417,12 @@
 <div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>        <span class="comment">// Handling custom Annoy types. </span></div>
 <div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span>        <span class="keyword">auto</span>&amp; icust = custom_save_for_annoy_index&lt;AnnoyIndex_&gt;(); </div>
 <div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span>        <span class="keywordflow">if</span> (icust) {</div>
-<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>            icust(prefix);</div>
+<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>            icust(prefix); </div>
 <div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span>        }</div>
 <div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span> </div>
 <div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span>        <span class="keyword">auto</span>&amp; dcust = custom_save_for_annoy_data&lt;AnnoyData_&gt;();</div>
 <div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span>        <span class="keywordflow">if</span> (dcust) {</div>
-<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span>            dcust(prefix);</div>
+<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span>            dcust(prefix); </div>
 <div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span>        }</div>
 <div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span> </div>
 <div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>        <span class="keyword">auto</span>&amp; dscust = custom_save_for_annoy_distance&lt;AnnoyDistance_&gt;();</div>

docs/namespaceknncolle__annoy.html

@@ -148,6 +148,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#acf44a3fe6882f4a5acba1a78
       </table>
 </div><div class="memdoc">
 <p>Define a custom saving function to preserve <code>AnnoyData_</code> type information when saving a prebuilt 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 an <code>AnnoyData_</code> type that is unknown to <code><a class="elRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a84e640363d9246c58008c93166021f26">knncolle::get_numeric_type()</a></code>. Any modifications to this function are not thread-safe and should be done in a serial section.</p>
+<p>The sole argument of this function is the same <code>prefix</code> provided to <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code>, and the function is generally expected to write to files at paths starting with <code>prefix</code>. It is generally recommended that an additional <code>_</code>, <code>-</code> or <code>.</code> is added to <code>prefix</code> to avoid conflicts with other files generated by <code>save()</code>.</p>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
     <tr><td class="paramname">AnnoyData_</td><td>Floating-point type for data in the Annoy index.</td></tr>
@@ -175,6 +176,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7316f370cf35287d8f26edeb
       </table>
 </div><div class="memdoc">
 <p>Define a custom saving function to preserve <code>AnnoyDistance_</code> type information when saving a prebuilt 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 an <code>AnnoyDistance_</code> type that is unknown to <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>
+<p>The sole argument of this function is the same <code>prefix</code> provided to <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code>, and the function is generally expected to write to files at paths starting with <code>prefix</code>. It is generally recommended that an additional <code>_</code>, <code>-</code> or <code>.</code> is added to <code>prefix</code> to avoid conflicts with other files generated by <code>save()</code>.</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>
@@ -202,13 +204,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a006988a9f533b84711821cd5
       </table>
 </div><div class="memdoc">
 <p>Define a custom saving function to preserve <code>AnnoyIndex_</code> type information when saving a prebuilt 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 an <code>AnnoyIndex_</code> type that is unknown to <code><a class="elRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a84e640363d9246c58008c93166021f26">knncolle::get_numeric_type()</a></code>. Any modifications to this function are not thread-safe and should be done in a serial section.</p>
+<p>The sole argument of this function is the same <code>prefix</code> provided to <code><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html#a87930f878bf3a22297b851173caaf893">knncolle::Prebuilt::save()</a></code>, and the function is generally expected to write to files at paths starting with <code>prefix</code>. It is generally recommended that an additional <code>_</code>, <code>-</code> or <code>.</code> is added to <code>prefix</code> to avoid conflicts with other files generated by <code>save()</code>.</p>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
     <tr><td class="paramname">AnnoyIndex_</td><td>Integer type for the observation indices 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>AnnoyIndex_</code>. By default, no function is provided. If set, the function 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>
+<dl class="section return"><dt>Returns</dt><dd>A global function for saving information about <code>AnnoyIndex_</code>. By default, no function is provided. If set, the function 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><a class="elRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Prebuilt.html">knncolle::Prebuilt</a></code> subclass. </dd></dl>
 
 </div>
 </div>

docs/utils_8hpp_source.html

@@ -133,39 +133,39 @@
 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>}</div>
 </div>
 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span> </div>
-<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyIndex_&gt;</div>
-<div class="foldopen" id="foldopen00074" data-start="{" data-end="}">
-<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">   74</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">custom_save_for_annoy_index</a>() {</div>
-<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
-<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>    <span class="keywordflow">return</span> fun;</div>
-<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>}</div>
+<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyIndex_&gt;</div>
+<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
+<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">   78</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">custom_save_for_annoy_index</a>() {</div>
+<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
+<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>    <span class="keywordflow">return</span> fun;</div>
+<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>}</div>
 </div>
-<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
-<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyData_&gt;</div>
-<div class="foldopen" id="foldopen00091" data-start="{" data-end="}">
-<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">   91</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">custom_save_for_annoy_data</a>() {</div>
-<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
-<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>    <span class="keywordflow">return</span> fun;</div>
-<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>}</div>
+<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
+<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyData_&gt;</div>
+<div class="foldopen" id="foldopen00099" data-start="{" data-end="}">
+<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">   99</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">custom_save_for_annoy_data</a>() {</div>
+<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
+<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>    <span class="keywordflow">return</span> fun;</div>
+<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>}</div>
 </div>
-<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span> </div>
-<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyDistance_&gt;</div>
-<div class="foldopen" id="foldopen00108" data-start="{" data-end="}">
-<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">  108</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">custom_save_for_annoy_distance</a>() {</div>
-<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
-<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>    <span class="keywordflow">return</span> fun;</div>
-<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>}</div>
+<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
+<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="keyword">template</span>&lt;<span class="keyword">class</span> AnnoyDistance_&gt;</div>
+<div class="foldopen" id="foldopen00120" data-start="{" data-end="}">
+<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">  120</a></span>std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt;&amp; <a class="code hl_function" href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">custom_save_for_annoy_distance</a>() {</div>
+<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>    <span class="keyword">static</span> std::function&lt;void(<span class="keyword">const</span> std::string&amp;)&gt; fun;</div>
+<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>    <span class="keywordflow">return</span> fun;</div>
+<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>}</div>
 </div>
-<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span> </div>
-<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>}</div>
-<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span> </div>
-<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span> </div>
+<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>}</div>
+<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span> </div>
+<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aknncolle_8hpp_html"><div class="ttname"><a href="https://knncolle.github.io/knncolle/knncolle_8hpp.html">knncolle.hpp</a></div></div>
 <div class="ttc" id="anamespaceknncolle__annoy_html"><div class="ttname"><a href="namespaceknncolle__annoy.html">knncolle_annoy</a></div><div class="ttdoc">Approximate nearest neighbor search with Annoy.</div><div class="ttdef"><b>Definition</b> Annoy.hpp:23</div></div>
-<div class="ttc" id="anamespaceknncolle__annoy_html_a006988a9f533b84711821cd524a80db9"><div class="ttname"><a href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">knncolle_annoy::custom_save_for_annoy_index</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_index()</div><div class="ttdef"><b>Definition</b> utils.hpp:74</div></div>
+<div class="ttc" id="anamespaceknncolle__annoy_html_a006988a9f533b84711821cd524a80db9"><div class="ttname"><a href="namespaceknncolle__annoy.html#a006988a9f533b84711821cd524a80db9">knncolle_annoy::custom_save_for_annoy_index</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_index()</div><div class="ttdef"><b>Definition</b> utils.hpp:78</div></div>
 <div class="ttc" id="anamespaceknncolle__annoy_html_a0f46fd7ab22d7976baec00c98c038bea"><div class="ttname"><a href="namespaceknncolle__annoy.html#a0f46fd7ab22d7976baec00c98c038bea">knncolle_annoy::get_distance_name</a></div><div class="ttdeci">const char * get_distance_name()</div><div class="ttdef"><b>Definition</b> utils.hpp:54</div></div>
-<div class="ttc" id="anamespaceknncolle__annoy_html_a7316f370cf35287d8f26edebe02df4ed"><div class="ttname"><a href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">knncolle_annoy::custom_save_for_annoy_distance</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_distance()</div><div class="ttdef"><b>Definition</b> utils.hpp:108</div></div>
-<div class="ttc" id="anamespaceknncolle__annoy_html_acf44a3fe6882f4a5acba1a78353812cd"><div class="ttname"><a href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">knncolle_annoy::custom_save_for_annoy_data</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_data()</div><div class="ttdef"><b>Definition</b> utils.hpp:91</div></div>
+<div class="ttc" id="anamespaceknncolle__annoy_html_a7316f370cf35287d8f26edebe02df4ed"><div class="ttname"><a href="namespaceknncolle__annoy.html#a7316f370cf35287d8f26edebe02df4ed">knncolle_annoy::custom_save_for_annoy_distance</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_distance()</div><div class="ttdef"><b>Definition</b> utils.hpp:120</div></div>
+<div class="ttc" id="anamespaceknncolle__annoy_html_acf44a3fe6882f4a5acba1a78353812cd"><div class="ttname"><a href="namespaceknncolle__annoy.html#acf44a3fe6882f4a5acba1a78353812cd">knncolle_annoy::custom_save_for_annoy_data</a></div><div class="ttdeci">std::function&lt; void(const std::string &amp;)&gt; &amp; custom_save_for_annoy_data()</div><div class="ttdef"><b>Definition</b> utils.hpp:99</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>