Deploying to gh-pages from @ aa8a895 🚀

docs/Options_8hpp_source.html

@@ -101,12 +101,12 @@
 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Index_&gt;</div>
 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structtatami_1_1Oracle.html">   62</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structtatami_1_1Oracle.html">Oracle</a> {</div>
 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>    <span class="keyword">virtual</span> <a class="code hl_struct" href="structtatami_1_1Oracle.html">~Oracle</a>() = <span class="keywordflow">default</span>;</div>
-<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">   80</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">predict</a>(Index_* predicted, <span class="keywordtype">size_t</span> number) = 0;</div>
-<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>};</div>
-<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
-<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>}</div>
-<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span> </div>
-<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">   81</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">predict</a>(Index_* predicted, <span class="keywordtype">size_t</span> number) = 0;</div>
+<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>};</div>
+<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
+<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>}</div>
+<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
+<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="anamespacetatami_html"><div class="ttname"><a href="namespacetatami.html">tatami</a></div><div class="ttdoc">Flexible representations for matrix data.</div><div class="ttdef"><b>Definition:</b> Extractor.hpp:20</div></div>
 <div class="ttc" id="anamespacetatami_html_a0a2ecaf58e2b69bb4a808e814aeb16a1"><div class="ttname"><a href="namespacetatami.html#a0a2ecaf58e2b69bb4a808e814aeb16a1">tatami::DimensionSelectionType</a></div><div class="ttdeci">DimensionSelectionType</div><div class="ttdef"><b>Definition:</b> Options.hpp:22</div></div>
 <div class="ttc" id="astructtatami_1_1Options_html"><div class="ttname"><a href="structtatami_1_1Options.html">tatami::Options</a></div><div class="ttdoc">Options for iteration and extraction.</div><div class="ttdef"><b>Definition:</b> Options.hpp:27</div></div>

docs/Oracles_8hpp_source.html

@@ -149,37 +149,38 @@
 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>        <span class="keywordflow">if</span> (used == predictions.size()) {</div>
 <div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>            predictions.resize(100); <span class="comment">// take up to 100 predictions at a time.</span></div>
 <div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>            used = 0;</div>
-<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>            <span class="keyword">auto</span> filled = oracle-&gt;predict(predictions.data(), predictions.size());</div>
-<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>            <span class="keywordflow">if</span> (filled == 0) {</div>
-<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
-<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>            }</div>
-<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>            predictions.resize(filled);</div>
-<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>        }</div>
-<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span> </div>
-<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>        prediction = predictions[used];</div>
-<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>        ++used;</div>
-<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
-<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>    }</div>
-<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
-<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">  150</a></span>    <span class="keywordtype">bool</span> <a class="code hl_function" href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">back</a>() {</div>
-<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>        <span class="comment">// Easy to see that, in next(), any successful call leaves us with used &gt; 0.</span></div>
-<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>        <span class="comment">// So at least one invocation of unwind() will be successful.</span></div>
-<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>        <span class="keywordflow">if</span> (!used) {</div>
-<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
-<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>        }</div>
-<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>        --used;</div>
-<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>        <span class="keywordflow">return</span> <span class="keyword">true</span>; </div>
-<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>    }</div>
-<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span> </div>
-<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="keyword">private</span>:</div>
-<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>    std::unique_ptr&lt;Oracle&lt;Index_&gt; &gt; oracle;</div>
-<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    std::vector&lt;Index_&gt; predictions;</div>
-<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>    <span class="keywordtype">size_t</span> used = 0;</div>
-<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>};</div>
-<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span> </div>
-<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>}</div>
-<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span> </div>
-<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span> </div>
+<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>            <span class="keyword">auto</span> filled = oracle-&gt;predict(predictions.data(), predictions.size());</div>
+<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>            predictions.resize(filled);</div>
+<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>            <span class="keywordflow">if</span> (filled == 0) {</div>
+<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
+<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>            }</div>
+<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>        }</div>
+<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span> </div>
+<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>        prediction = predictions[used];</div>
+<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>        ++used;</div>
+<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
+<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>    }</div>
+<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span> </div>
+<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"><a class="line" href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">  151</a></span>    <span class="keywordtype">bool</span> <a class="code hl_function" href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">back</a>() {</div>
+<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>        <span class="comment">// Easy to see that, in next(), any successful call leaves us with used &gt; 0.</span></div>
+<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>        <span class="comment">// So at least one invocation of unwind() will be successful.</span></div>
+<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>        <span class="keywordflow">if</span> (!used) {</div>
+<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
+<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>        }</div>
+<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>        --used;</div>
+<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>        <span class="keywordflow">return</span> <span class="keyword">true</span>; </div>
+<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>    }</div>
+<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span> </div>
+<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="keyword">private</span>:</div>
+<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>    std::unique_ptr&lt;Oracle&lt;Index_&gt; &gt; oracle;</div>
+<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>    std::vector&lt;Index_&gt; predictions;</div>
+<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    <span class="keywordtype">size_t</span> used = 0;</div>
+<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>};</div>
+<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span> </div>
+<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>}</div>
+<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span> </div>
+<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="anamespacetatami_html"><div class="ttname"><a href="namespacetatami.html">tatami</a></div><div class="ttdoc">Flexible representations for matrix data.</div><div class="ttdef"><b>Definition:</b> Extractor.hpp:20</div></div>
 <div class="ttc" id="astructtatami_1_1ConsecutiveOracle_html"><div class="ttname"><a href="structtatami_1_1ConsecutiveOracle.html">tatami::ConsecutiveOracle</a></div><div class="ttdoc">Predict future accesses of a consecutive sequence.</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:54</div></div>
 <div class="ttc" id="astructtatami_1_1ConsecutiveOracle_html_a4e896a9ad264a7a88e28fd1c4bce76c3"><div class="ttname"><a href="structtatami_1_1ConsecutiveOracle.html#a4e896a9ad264a7a88e28fd1c4bce76c3">tatami::ConsecutiveOracle::ConsecutiveOracle</a></div><div class="ttdeci">ConsecutiveOracle(Index_ s, Index_ l)</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:59</div></div>
@@ -190,7 +191,7 @@
 <div class="ttc" id="astructtatami_1_1OracleStream_html"><div class="ttname"><a href="structtatami_1_1OracleStream.html">tatami::OracleStream</a></div><div class="ttdoc">Stream predictions from the oracle.</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:90</div></div>
 <div class="ttc" id="astructtatami_1_1OracleStream_html_a293c82567a7c94b9dc86e39110b30688"><div class="ttname"><a href="structtatami_1_1OracleStream.html#a293c82567a7c94b9dc86e39110b30688">tatami::OracleStream::OracleStream</a></div><div class="ttdeci">OracleStream()=default</div></div>
 <div class="ttc" id="astructtatami_1_1OracleStream_html_a370450d2c7194730cd61a8cc8f8ec390"><div class="ttname"><a href="structtatami_1_1OracleStream.html#a370450d2c7194730cd61a8cc8f8ec390">tatami::OracleStream::next</a></div><div class="ttdeci">bool next(Index_ &amp;prediction)</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:125</div></div>
-<div class="ttc" id="astructtatami_1_1OracleStream_html_a3ce855b3a8ffa7887b20f489faf1a68e"><div class="ttname"><a href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">tatami::OracleStream::back</a></div><div class="ttdeci">bool back()</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:150</div></div>
+<div class="ttc" id="astructtatami_1_1OracleStream_html_a3ce855b3a8ffa7887b20f489faf1a68e"><div class="ttname"><a href="structtatami_1_1OracleStream.html#a3ce855b3a8ffa7887b20f489faf1a68e">tatami::OracleStream::back</a></div><div class="ttdeci">bool back()</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:151</div></div>
 <div class="ttc" id="astructtatami_1_1OracleStream_html_aa870c1926cb411c6de10be96956459ea"><div class="ttname"><a href="structtatami_1_1OracleStream.html#aa870c1926cb411c6de10be96956459ea">tatami::OracleStream::set</a></div><div class="ttdeci">void set(std::unique_ptr&lt; Oracle&lt; Index_ &gt; &gt; o)</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:112</div></div>
 <div class="ttc" id="astructtatami_1_1OracleStream_html_abac31a84479939fec89f7037a5dd8f06"><div class="ttname"><a href="structtatami_1_1OracleStream.html#abac31a84479939fec89f7037a5dd8f06">tatami::OracleStream::OracleStream</a></div><div class="ttdeci">OracleStream(std::unique_ptr&lt; Oracle&lt; Index_ &gt; &gt; o)</div><div class="ttdef"><b>Definition:</b> Oracles.hpp:99</div></div>
 <div class="ttc" id="astructtatami_1_1Oracle_html"><div class="ttname"><a href="structtatami_1_1Oracle.html">tatami::Oracle</a></div><div class="ttdoc">Predict future access requests.</div><div class="ttdef"><b>Definition:</b> Options.hpp:62</div></div>

docs/structtatami_1_1ConsecutiveOracle.html

@@ -213,7 +213,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ed7501a227b2ee9b96e7873
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. If no more predictions are available, this method should return zero. </dd></dl>
 
 <p>Implements <a class="el" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">tatami::Oracle&lt; Index_ &gt;</a>.</p>
 

docs/structtatami_1_1FixedOracle.html

@@ -213,7 +213,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a931ccde93f123c8c718f808e
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. If no more predictions are available, this method should return zero. </dd></dl>
 
 <p>Implements <a class="el" href="structtatami_1_1Oracle.html#a32ab54d21fc982580f18bea802d89f48">tatami::Oracle&lt; Index_ &gt;</a>.</p>
 

docs/structtatami_1_1Oracle.html

@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a32ab54d21fc982580f18bea8
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>Number of indices that were predicted. This is guaranteed to be no greater than <code>number</code>. If no more predictions are available, this method should return zero. </dd></dl>
 
 <p>Implemented in <a class="el" href="structtatami_1_1ConsecutiveOracle.html#a6ed7501a227b2ee9b96e78733f166f16">tatami::ConsecutiveOracle&lt; Index_ &gt;</a>, and <a class="el" href="structtatami_1_1FixedOracle.html#a931ccde93f123c8c718f808e89cf8f36">tatami::FixedOracle&lt; Index_ &gt;</a>.</p>