cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>EstimatedHistogram (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <div class="topNav"><a name="navbar_top">  </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/EstimatedHistogram.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><a href="../../../../org/apache/cassandra/utils/DefaultInteger.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/EstimatedHistogram.html" target="_top">Frames</a></li> <li><a href="EstimatedHistogram.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.utils</div> <h2 title="Class EstimatedHistogram" class="title">Class EstimatedHistogram</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.utils.EstimatedHistogram</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">EstimatedHistogram</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils">EstimatedHistogram.EstimatedHistogramSerializer</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils">EstimatedHistogram.EstimatedHistogramSerializer</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#serializer">serializer</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#EstimatedHistogram()">EstimatedHistogram</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#EstimatedHistogram(int)">EstimatedHistogram</a></strong>(int bucketCount)</code> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#EstimatedHistogram(long[],%20long[])">EstimatedHistogram</a></strong>(long[] offsets, long[] bucketData)</code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_summary">  </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#add(long)">add</a></strong>(long n)</code> <div class="block">Increments the count of the bucket closest to n, rounding UP.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#count()">count</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#getBucketOffsets()">getBucketOffsets</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#getBuckets(boolean)">getBuckets</a></strong>(boolean reset)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#isOverflowed()">isOverflowed</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#log(org.slf4j.Logger)">log</a></strong>(org.slf4j.Logger log)</code> <div class="block">log.debug() every record in the histogram</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#max()">max</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#mean()">mean</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#min()">min</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.html#percentile(double)">percentile</a></strong>(double percentile)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">  </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="serializer">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>serializer</h4> <pre>public static final <a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils">EstimatedHistogram.EstimatedHistogramSerializer</a> serializer</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="EstimatedHistogram()">  </a> <ul class="blockList"> <li class="blockList"> <h4>EstimatedHistogram</h4> <pre>public EstimatedHistogram()</pre> </li> </ul> <a name="EstimatedHistogram(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>EstimatedHistogram</h4> <pre>public EstimatedHistogram(int bucketCount)</pre> </li> </ul> <a name="EstimatedHistogram(long[], long[])">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>EstimatedHistogram</h4> <pre>public EstimatedHistogram(long[] offsets, long[] bucketData)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getBucketOffsets()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getBucketOffsets</h4> <pre>public long[] getBucketOffsets()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the histogram values corresponding to each bucket index</dd></dl> </li> </ul> <a name="add(long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>add</h4> <pre>public void add(long n)</pre> <div class="block">Increments the count of the bucket closest to n, rounding UP.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - </dd></dl> </li> </ul> <a name="getBuckets(boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getBuckets</h4> <pre>public long[] getBuckets(boolean reset)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reset</code> - zero out buckets afterwards if true</dd> <dt><span class="strong">Returns:</span></dt><dd>a long[] containing the current histogram buckets</dd></dl> </li> </ul> <a name="min()">  </a> <ul class="blockList"> <li class="blockList"> <h4>min</h4> <pre>public long min()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the smallest value that could have been added to this histogram</dd></dl> </li> </ul> <a name="max()">  </a> <ul class="blockList"> <li class="blockList"> <h4>max</h4> <pre>public long max()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the largest value that could have been added to this histogram. If the histogram overflowed, returns Long.MAX_VALUE.</dd></dl> </li> </ul> <a name="percentile(double)">  </a> <ul class="blockList"> <li class="blockList"> <h4>percentile</h4> <pre>public long percentile(double percentile)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>percentile</code> - </dd> <dt><span class="strong">Returns:</span></dt><dd>estimated value at given percentile</dd></dl> </li> </ul> <a name="mean()">  </a> <ul class="blockList"> <li class="blockList"> <h4>mean</h4> <pre>public long mean()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the mean histogram value (average of bucket offsets, weighted by count)</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if any values were greater than the largest bucket threshold</dd></dl> </li> </ul> <a name="count()">  </a> <ul class="blockList"> <li class="blockList"> <h4>count</h4> <pre>public long count()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the total number of non-zero values</dd></dl> </li> </ul> <a name="isOverflowed()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isOverflowed</h4> <pre>public boolean isOverflowed()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if this histogram has overflowed -- that is, a value larger than our largest bucket could bound was added</dd></dl> </li> </ul> <a name="log(org.slf4j.Logger)">  </a> <ul class="blockList"> <li class="blockList"> <h4>log</h4> <pre>public void log(org.slf4j.Logger log)</pre> <div class="block">log.debug() every record in the histogram</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - </dd></dl> </li> </ul> <a name="equals(java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object o)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hashCode()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar_bottom">  </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/EstimatedHistogram.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><a href="../../../../org/apache/cassandra/utils/DefaultInteger.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/EstimatedHistogram.EstimatedHistogramSerializer.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/EstimatedHistogram.html" target="_top">Frames</a></li> <li><a href="EstimatedHistogram.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>