Deploying to gh-pages from @ cd6ccd0 🚀

Author: LTLA

docs/Annoy_8hpp_source.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:419</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:424</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>
@@ -125,13 +125,13 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <div class="line">an_opts.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">num_trees</a> = 100;</div>
 <div class="line">an_opts.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5">search_mult</a> = 200; <span class="comment">// used to compute search_k.</span></div>
 <div class="line"><a class="code hl_class" href="classknncolle__annoy_1_1AnnoyBuilder.html">knncolle_annoy::AnnoyBuilder&lt;int, double, double, Annoy::Euclidean&gt;</a> an_builder2(an_opts);</div>
-<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html">knncolle_annoy::AnnoyOptions</a></div><div class="ttdoc">Options for AnnoyBuilder().</div><div class="ttdef"><b>Definition</b> Annoy.hpp:28</div></div>
-<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html_a4acbbbebaf5b5eb0d2496faefe7ee932"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">knncolle_annoy::AnnoyOptions::num_trees</a></div><div class="ttdeci">int num_trees</div><div class="ttdef"><b>Definition</b> Annoy.hpp:33</div></div>
-<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html_a7e917640043724d3933318a4504e65a5"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5">knncolle_annoy::AnnoyOptions::search_mult</a></div><div class="ttdeci">double search_mult</div><div class="ttdef"><b>Definition</b> Annoy.hpp:40</div></div>
+<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html">knncolle_annoy::AnnoyOptions</a></div><div class="ttdoc">Options for AnnoyBuilder().</div><div class="ttdef"><b>Definition</b> Annoy.hpp:33</div></div>
+<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html_a4acbbbebaf5b5eb0d2496faefe7ee932"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html#a4acbbbebaf5b5eb0d2496faefe7ee932">knncolle_annoy::AnnoyOptions::num_trees</a></div><div class="ttdeci">int num_trees</div><div class="ttdef"><b>Definition</b> Annoy.hpp:38</div></div>
+<div class="ttc" id="astructknncolle__annoy_1_1AnnoyOptions_html_a7e917640043724d3933318a4504e65a5"><div class="ttname"><a href="structknncolle__annoy_1_1AnnoyOptions.html#a7e917640043724d3933318a4504e65a5">knncolle_annoy::AnnoyOptions::search_mult</a></div><div class="ttdeci">double search_mult</div><div class="ttdef"><b>Definition</b> Annoy.hpp:45</div></div>
 </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:438</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:443</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>
@@ -235,7 +235,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 <div class="line"><span class="keyword">auto</span> custom_index = custom_builder.<a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/classknncolle_1_1Builder.html#a93cac638de3e4ad31919bc5d677d16b7">build_unique</a>(mat);</div>
 <div class="line">custom_index.save(custom_prefix);</div>
 <div class="line"><span class="keyword">auto</span> custom_reloaded = knncolle::load_prebuilt(custom_prefix);</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 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:93</div></div>
 <div class="ttc" id="anamespaceknncolle_html_a83e38fc963fa7d735ef8f0d11f1f5a4b"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a83e38fc963fa7d735ef8f0d11f1f5a4b">knncolle::quick_load_as_string</a></div><div class="ttdeci">std::string quick_load_as_string(const std::string &amp;path)</div></div>
 <div class="ttc" id="anamespaceknncolle_html_afc954146b2f7fe5cbd1c7f3a5610ba94"><div class="ttname"><a href="https://knncolle.github.io/knncolle/namespaceknncolle.html#afc954146b2f7fe5cbd1c7f3a5610ba94">knncolle::quick_save</a></div><div class="ttdeci">void quick_save(const std::string &amp;path, const Input_ *const contents, const Length_ length)</div></div>
 </div><!-- fragment --><h1><a class="anchor" id="autotoc_md5"></a>

docs/index.html

@@ -120,12 +120,12 @@
 <div class="foldopen" id="foldopen00049" data-start="{" data-end="}">
 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a57a33c712b732200c7b46d36f13bfb78">   49</a></span><span class="keyword">inline</span> <a class="code hl_struct" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html">AnnoyPrebuiltTypes</a> <a class="code hl_function" href="namespaceknncolle__annoy.html#a57a33c712b732200c7b46d36f13bfb78">load_annoy_prebuilt_types</a>(<span class="keyword">const</span> std::string&amp; prefix) {</div>
 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>    <a class="code hl_enumerationRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a9aa73a4ad540791a911eb9fa64b51de3">knncolle::NumericType</a> types[2];</div>
-<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#ac5079c0b39b7f9e10bd97341ccfad46c">knncolle::quick_load</a>(prefix + <span class="stringliteral">&quot;types&quot;</span>, types, 2);</div>
+<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#ac5079c0b39b7f9e10bd97341ccfad46c">knncolle::quick_load</a>(prefix + <span class="stringliteral">&quot;TYPES&quot;</span>, types, 2);</div>
 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>    <a class="code hl_struct" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html">AnnoyPrebuiltTypes</a> config;</div>
 <div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>    config.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#ad0be50f762bae2c3fe87218ce7b0abeb">index</a> = types[0];</div>
 <div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>    config.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#af7828040b51e6091600af403d19b0acc">data</a> = types[1];</div>
-<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>    config.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a06aaf2f6d1337bf71175ffc35a45ded2">distance</a> = <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a83e38fc963fa7d735ef8f0d11f1f5a4b">knncolle::quick_load_as_string</a>(prefix + <span class="stringliteral">&quot;distance&quot;</span>);</div>
+<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>    config.<a class="code hl_variable" href="structknncolle__annoy_1_1AnnoyPrebuiltTypes.html#a06aaf2f6d1337bf71175ffc35a45ded2">distance</a> = <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#a83e38fc963fa7d735ef8f0d11f1f5a4b">knncolle::quick_load_as_string</a>(prefix + <span class="stringliteral">&quot;DISTANCE&quot;</span>);</div>
 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <span class="keywordflow">return</span> config;</div>
 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>}</div>
@@ -144,7 +144,7 @@
 <div class="foldopen" id="foldopen00106" data-start="{" data-end="}">
 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">  106</a></span><span class="keyword">auto</span> <a class="code hl_function" href="namespaceknncolle__annoy.html#a480d8350b6c83729f140253ee3ca64cb">load_annoy_prebuilt</a>(<span class="keyword">const</span> std::string&amp; prefix) {</div>
 <div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>    std::size_t ndim;</div>
-<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#ac5079c0b39b7f9e10bd97341ccfad46c">knncolle::quick_load</a>(prefix + <span class="stringliteral">&quot;num_dim&quot;</span>, &amp;ndim, 1);</div>
+<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    <a class="code hl_functionRef" href="https://knncolle.github.io/knncolle/namespaceknncolle.html#ac5079c0b39b7f9e10bd97341ccfad46c">knncolle::quick_load</a>(prefix + <span class="stringliteral">&quot;NUM_DIM&quot;</span>, &amp;ndim, 1);</div>
 <div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    <span class="keywordflow">return</span> <span class="keyword">new</span> AnnoyPrebuilt&lt;Index_, Data_, Distance_, AnnoyDistance_, AnnoyIndex_, AnnoyData_, AnnoyRng_, AnnoyThreadPolicy_&gt;(prefix, ndim);</div>
 <div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>}</div>
 </div>