blob: 16c3823f8041fb0e1e29f5fcb8a6370d8bbe4b45 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ReqDebug (datasketches-java 4.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReqDebug (datasketches-java 4.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.datasketches.req</a></div>
<h2 title="Interface ReqDebug" class="title">Interface ReqDebug</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<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 =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitAdjSecSizeNumSec(byte)">emitAdjSecSizeNumSec</a></span>&#8203;(byte&nbsp;lgWeight)</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitAllHorizList()">emitAllHorizList</a></span>()</code></th>
<td class="colLast">
<div class="block">Emit all horizontal lists</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitCompactingStart(byte)">emitCompactingStart</a></span>&#8203;(byte&nbsp;lgWeight)</code></th>
<td class="colLast">
<div class="block">Emit Compaction Start.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitCompactionDetail(int,int,int,int,boolean)">emitCompactionDetail</a></span>&#8203;(int&nbsp;compactionStart,
int&nbsp;compactionEnd,
int&nbsp;secsToCompact,
int&nbsp;promoteLen,
boolean&nbsp;coin)</code></th>
<td class="colLast">
<div class="block">Emit Compaction details.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitCompactionDone(byte)">emitCompactionDone</a></span>&#8203;(byte&nbsp;lgWeight)</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitCompressDone()">emitCompressDone</a></span>()</code></th>
<td class="colLast">
<div class="block">Emit compress done.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitMustAddCompactor()">emitMustAddCompactor</a></span>()</code></th>
<td class="colLast">
<div class="block">Emit Must add compactor</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitNewCompactor(byte)">emitNewCompactor</a></span>&#8203;(byte&nbsp;lgWeight)</code></th>
<td class="colLast">
<div class="block">Emit new compactor configuration</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitStart(org.apache.datasketches.req.ReqSketch)">emitStart</a></span>&#8203;(<a href="ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a>&nbsp;sk)</code></th>
<td class="colLast">
<div class="block">Emit the start signal</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emitStartCompress()">emitStartCompress</a></span>()</code></th>
<td class="colLast">
<div class="block">Emit Start Compress</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="emitStart(org.apache.datasketches.req.ReqSketch)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitStart</h4>
<pre class="methodSignature">void&nbsp;emitStart&#8203;(<a href="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 id="emitStartCompress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitStartCompress</h4>
<pre class="methodSignature">void&nbsp;emitStartCompress()</pre>
<div class="block">Emit Start Compress</div>
</li>
</ul>
<a id="emitCompressDone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompressDone</h4>
<pre class="methodSignature">void&nbsp;emitCompressDone()</pre>
<div class="block">Emit compress done.</div>
</li>
</ul>
<a id="emitAllHorizList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitAllHorizList</h4>
<pre class="methodSignature">void&nbsp;emitAllHorizList()</pre>
<div class="block">Emit all horizontal lists</div>
</li>
</ul>
<a id="emitMustAddCompactor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitMustAddCompactor</h4>
<pre class="methodSignature">void&nbsp;emitMustAddCompactor()</pre>
<div class="block">Emit Must add compactor</div>
</li>
</ul>
<a id="emitCompactingStart(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompactingStart</h4>
<pre class="methodSignature">void&nbsp;emitCompactingStart&#8203;(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 id="emitNewCompactor(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitNewCompactor</h4>
<pre class="methodSignature">void&nbsp;emitNewCompactor&#8203;(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 id="emitAdjSecSizeNumSec(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitAdjSecSizeNumSec</h4>
<pre class="methodSignature">void&nbsp;emitAdjSecSizeNumSec&#8203;(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 id="emitCompactionDetail(int,int,int,int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emitCompactionDetail</h4>
<pre class="methodSignature">void&nbsp;emitCompactionDetail&#8203;(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 id="emitCompactionDone(byte)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>emitCompactionDone</h4>
<pre class="methodSignature">void&nbsp;emitCompactionDone&#8203;(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>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>