Google Git
Sign in
apache / datasketches-website / 4e83e51533ab0e89e82946dca92a6cde8a66ded4 / . / api / java / snapshot / apidocs / org / apache / datasketches / req / ReqDebug.html
blob: ff8ebde42453921bc83bf445e26dcbc7cd7a9070 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_302) on Wed Jan 26 15:15:51 PST 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ReqDebug (datasketches-java 3.1.0 API)</title>
<meta name="date" content="2022-01-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReqDebug (datasketches-java 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReqDebug.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/datasketches/req/ReqIterator.html" title="class in org.apache.datasketches.req"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/req/ReqDebug.html" target="_top">Frames</a></li>
<li><a href="ReqDebug.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.datasketches.req</div>
<h2 title="Interface ReqDebug" class="title">Interface ReqDebug</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ReqDebug</span></pre>
<div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor
while eliminating code clutter in the main classes. The implementation of this interface can be
found in the test tree.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitAdjSecSizeNumSec-byte-">emitAdjSecSizeNumSec</a></span>(byte&nbsp;lgWeight)</code>
<div class="block">Emit adjusting section size and number of sections.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitAllHorizList--">emitAllHorizList</a></span>()</code>
<div class="block">Emit all horizontal lists</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitCompactingStart-byte-">emitCompactingStart</a></span>(byte&nbsp;lgWeight)</code>
<div class="block">Emit Compaction Start.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitCompactionDetail-int-int-int-int-boolean-">emitCompactionDetail</a></span>(int&nbsp;compactionStart,
int&nbsp;compactionEnd,
int&nbsp;secsToCompact,
int&nbsp;promoteLen,
boolean&nbsp;coin)</code>
<div class="block">Emit Compaction details.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitCompactionDone-byte-">emitCompactionDone</a></span>(byte&nbsp;lgWeight)</code>
<div class="block">Emit compaction done and number of compactions so far.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitCompressDone--">emitCompressDone</a></span>()</code>
<div class="block">Emit compress done.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitMustAddCompactor--">emitMustAddCompactor</a></span>()</code>
<div class="block">Emit Must add compactor</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitNewCompactor-byte-">emitNewCompactor</a></span>(byte&nbsp;lgWeight)</code>
<div class="block">Emit new compactor configuration</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitStart-org.apache.datasketches.req.ReqSketch-">emitStart</a></span>(<a href="../../../../org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a>&nbsp;sk)</code>
<div class="block">Emit the start signal</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/req/ReqDebug.html#emitStartCompress--">emitStartCompress</a></span>()</code>
<div class="block">Emit Start Compress</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="emitStart-org.apache.datasketches.req.ReqSketch-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitStart</h4>
<pre>void&nbsp;emitStart(<a href="../../../../org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a>&nbsp;sk)</pre>
<div class="block">Emit the start signal</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sk</code> - the sketch</dd>
</dl>
</li>
</ul>
<a name="emitStartCompress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitStartCompress</h4>
<pre>void&nbsp;emitStartCompress()</pre>
<div class="block">Emit Start Compress</div>
</li>
</ul>
<a name="emitCompressDone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompressDone</h4>
<pre>void&nbsp;emitCompressDone()</pre>
<div class="block">Emit compress done.</div>
</li>
</ul>
<a name="emitAllHorizList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitAllHorizList</h4>
<pre>void&nbsp;emitAllHorizList()</pre>
<div class="block">Emit all horizontal lists</div>
</li>
</ul>
<a name="emitMustAddCompactor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitMustAddCompactor</h4>
<pre>void&nbsp;emitMustAddCompactor()</pre>
<div class="block">Emit Must add compactor</div>
</li>
</ul>
<a name="emitCompactingStart-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompactingStart</h4>
<pre>void&nbsp;emitCompactingStart(byte&nbsp;lgWeight)</pre>
<div class="block">Emit Compaction Start.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgWeight</code> - compactor lgWeight or height</dd>
</dl>
</li>
</ul>
<a name="emitNewCompactor-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitNewCompactor</h4>
<pre>void&nbsp;emitNewCompactor(byte&nbsp;lgWeight)</pre>
<div class="block">Emit new compactor configuration</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgWeight</code> - the log weight</dd>
</dl>
</li>
</ul>
<a name="emitAdjSecSizeNumSec-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitAdjSecSizeNumSec</h4>
<pre>void&nbsp;emitAdjSecSizeNumSec(byte&nbsp;lgWeight)</pre>
<div class="block">Emit adjusting section size and number of sections.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgWeight</code> - the log weight</dd>
</dl>
</li>
</ul>
<a name="emitCompactionDetail-int-int-int-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompactionDetail</h4>
<pre>void&nbsp;emitCompactionDetail(int&nbsp;compactionStart,
int&nbsp;compactionEnd,
int&nbsp;secsToCompact,
int&nbsp;promoteLen,
boolean&nbsp;coin)</pre>
<div class="block">Emit Compaction details.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>compactionStart</code> - the offset of compaction start</dd>
<dd><code>compactionEnd</code> - the offset of compaction end</dd>
<dd><code>secsToCompact</code> - the number of sections to compact</dd>
<dd><code>promoteLen</code> - the length of the promotion field</dd>
<dd><code>coin</code> - the state of the random coin.</dd>
</dl>
</li>
</ul>
<a name="emitCompactionDone-byte-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>emitCompactionDone</h4>
<pre>void&nbsp;emitCompactionDone(byte&nbsp;lgWeight)</pre>
<div class="block">Emit compaction done and number of compactions so far.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgWeight</code> - the log weight</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReqDebug.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/datasketches/req/ReqIterator.html" title="class in org.apache.datasketches.req"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/req/ReqDebug.html" target="_top">Frames</a></li>
<li><a href="ReqDebug.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>