solr-4.5.1/docs/solr-core/org/apache/solr/util/stats/UniformSample.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:44:58 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>UniformSample (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="UniformSample (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/UniformSample.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../../org/apache/solr/util/stats/TimerContext.html" title="class in org.apache.solr.util.stats"><span class="strong">PREV CLASS</span></a></li>
  40 <li>NEXT CLASS</li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../../index.html?org/apache/solr/util/stats/UniformSample.html" target="_top">FRAMES</a></li>
  44 <li><a href="UniformSample.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <div>
  62 <ul class="subNavList">
  63 <li>SUMMARY:&nbsp;</li>
  64 <li>NESTED&nbsp;|&nbsp;</li>
  65 <li>FIELD&nbsp;|&nbsp;</li>
  66 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
  67 <li><a href="#method_summary">METHOD</a></li>
  68 </ul>
  69 <ul class="subNavList">
  70 <li>DETAIL:&nbsp;</li>
  71 <li>FIELD&nbsp;|&nbsp;</li>
  72 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
  73 <li><a href="#method_detail">METHOD</a></li>
  74 </ul>
  75 </div>
  76 <a name="skip-navbar_top">
  77 <!--   -->
  78 </a></div>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80 <!-- ======== START OF CLASS DATA ======== -->
  81 <div class="header">
  82 <p class="subTitle">org.apache.solr.util.stats</p>
  83 <h2 title="Class UniformSample" class="title">Class UniformSample</h2>
  84 </div>
  85 <div class="contentContainer">
  86 <ul class="inheritance">
  87 <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  88 <li>
  89 <ul class="inheritance">
  90 <li>org.apache.solr.util.stats.UniformSample</li>
  91 </ul>
  92 </li>
  93 </ul>
  94 <div class="description">
  95 <ul class="blockList">
  96 <li class="blockList">
  97 <dl>
  98 <dt>All Implemented Interfaces:</dt>
  99 <dd><a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></dd>
 100 </dl>
 101 <hr>
 102 <br>
 103 <pre>public class <strong>UniformSample</strong>
 104 extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
 105 implements <a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></pre>
 106 <div class="block">A random sample of a stream of <code>long</code>s. Uses Vitter's Algorithm R to produce a
 107  statistically representative sample.</div>
 108 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://www.cs.umd.edu/~samir/498/vitter.pdf">Random Sampling with a Reservoir</a></dd></dl>
 109 </li>
 110 </ul>
 111 </div>
 112 <div class="summary">
 113 <ul class="blockList">
 114 <li class="blockList">
 115 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 116 <ul class="blockList">
 117 <li class="blockList"><a name="constructor_summary">
 118 <!--   -->
 119 </a>
 120 <h3>Constructor Summary</h3>
 121 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 122 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 123 <tr>
 124 <th class="colOne" scope="col">Constructor and Description</th>
 125 </tr>
 126 <tr class="altColor">
 127 <td class="colOne"><code><strong><a href="../../../../../org/apache/solr/util/stats/UniformSample.html#UniformSample(int)">UniformSample</a></strong>(int&nbsp;reservoirSize)</code>
 128 <div class="block">Creates a new <a href="../../../../../org/apache/solr/util/stats/UniformSample.html" title="class in org.apache.solr.util.stats"><code>UniformSample</code></a>.</div>
 129 </td>
 130 </tr>
 131 </table>
 132 </li>
 133 </ul>
 134 <!-- ========== METHOD SUMMARY =========== -->
 135 <ul class="blockList">
 136 <li class="blockList"><a name="method_summary">
 137 <!--   -->
 138 </a>
 139 <h3>Method Summary</h3>
 140 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 141 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
 142 <tr>
 143 <th class="colFirst" scope="col">Modifier and Type</th>
 144 <th class="colLast" scope="col">Method and Description</th>
 145 </tr>
 146 <tr class="altColor">
 147 <td class="colFirst"><code>void</code></td>
 148 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/util/stats/UniformSample.html#clear()">clear</a></strong>()</code>
 149 <div class="block">Clears all recorded values.</div>
 150 </td>
 151 </tr>
 152 <tr class="rowColor">
 153 <td class="colFirst"><code><a href="../../../../../org/apache/solr/util/stats/Snapshot.html" title="class in org.apache.solr.util.stats">Snapshot</a></code></td>
 154 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/util/stats/UniformSample.html#getSnapshot()">getSnapshot</a></strong>()</code>
 155 <div class="block">Returns a snapshot of the sample's values.</div>
 156 </td>
 157 </tr>
 158 <tr class="altColor">
 159 <td class="colFirst"><code>int</code></td>
 160 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/util/stats/UniformSample.html#size()">size</a></strong>()</code>
 161 <div class="block">Returns the number of values recorded.</div>
 162 </td>
 163 </tr>
 164 <tr class="rowColor">
 165 <td class="colFirst"><code>void</code></td>
 166 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/util/stats/UniformSample.html#update(long)">update</a></strong>(long&nbsp;value)</code>
 167 <div class="block">Adds a new recorded value to the sample.</div>
 168 </td>
 169 </tr>
 170 </table>
 171 <ul class="blockList">
 172 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 173 <!--   -->
 174 </a>
 175 <h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 176 <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
 177 </ul>
 178 </li>
 179 </ul>
 180 </li>
 181 </ul>
 182 </div>
 183 <div class="details">
 184 <ul class="blockList">
 185 <li class="blockList">
 186 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 187 <ul class="blockList">
 188 <li class="blockList"><a name="constructor_detail">
 189 <!--   -->
 190 </a>
 191 <h3>Constructor Detail</h3>
 192 <a name="UniformSample(int)">
 193 <!--   -->
 194 </a>
 195 <ul class="blockListLast">
 196 <li class="blockList">
 197 <h4>UniformSample</h4>
 198 <pre>public&nbsp;UniformSample(int&nbsp;reservoirSize)</pre>
 199 <div class="block">Creates a new <a href="../../../../../org/apache/solr/util/stats/UniformSample.html" title="class in org.apache.solr.util.stats"><code>UniformSample</code></a>.</div>
 200 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>reservoirSize</code> - the number of samples to keep in the sampling reservoir</dd></dl>
 201 </li>
 202 </ul>
 203 </li>
 204 </ul>
 205 <!-- ============ METHOD DETAIL ========== -->
 206 <ul class="blockList">
 207 <li class="blockList"><a name="method_detail">
 208 <!--   -->
 209 </a>
 210 <h3>Method Detail</h3>
 211 <a name="clear()">
 212 <!--   -->
 213 </a>
 214 <ul class="blockList">
 215 <li class="blockList">
 216 <h4>clear</h4>
 217 <pre>public&nbsp;void&nbsp;clear()</pre>
 218 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html#clear()">Sample</a></code></strong></div>
 219 <div class="block">Clears all recorded values.</div>
 220 <dl>
 221 <dt><strong>Specified by:</strong></dt>
 222 <dd><code><a href="../../../../../org/apache/solr/util/stats/Sample.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></code></dd>
 223 </dl>
 224 </li>
 225 </ul>
 226 <a name="size()">
 227 <!--   -->
 228 </a>
 229 <ul class="blockList">
 230 <li class="blockList">
 231 <h4>size</h4>
 232 <pre>public&nbsp;int&nbsp;size()</pre>
 233 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html#size()">Sample</a></code></strong></div>
 234 <div class="block">Returns the number of values recorded.</div>
 235 <dl>
 236 <dt><strong>Specified by:</strong></dt>
 237 <dd><code><a href="../../../../../org/apache/solr/util/stats/Sample.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></code></dd>
 238 <dt><span class="strong">Returns:</span></dt><dd>the number of values recorded</dd></dl>
 239 </li>
 240 </ul>
 241 <a name="update(long)">
 242 <!--   -->
 243 </a>
 244 <ul class="blockList">
 245 <li class="blockList">
 246 <h4>update</h4>
 247 <pre>public&nbsp;void&nbsp;update(long&nbsp;value)</pre>
 248 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html#update(long)">Sample</a></code></strong></div>
 249 <div class="block">Adds a new recorded value to the sample.</div>
 250 <dl>
 251 <dt><strong>Specified by:</strong></dt>
 252 <dd><code><a href="../../../../../org/apache/solr/util/stats/Sample.html#update(long)">update</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></code></dd>
 253 <dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - a new recorded value</dd></dl>
 254 </li>
 255 </ul>
 256 <a name="getSnapshot()">
 257 <!--   -->
 258 </a>
 259 <ul class="blockListLast">
 260 <li class="blockList">
 261 <h4>getSnapshot</h4>
 262 <pre>public&nbsp;<a href="../../../../../org/apache/solr/util/stats/Snapshot.html" title="class in org.apache.solr.util.stats">Snapshot</a>&nbsp;getSnapshot()</pre>
 263 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html#getSnapshot()">Sample</a></code></strong></div>
 264 <div class="block">Returns a snapshot of the sample's values.</div>
 265 <dl>
 266 <dt><strong>Specified by:</strong></dt>
 267 <dd><code><a href="../../../../../org/apache/solr/util/stats/Sample.html#getSnapshot()">getSnapshot</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/solr/util/stats/Sample.html" title="interface in org.apache.solr.util.stats">Sample</a></code></dd>
 268 <dt><span class="strong">Returns:</span></dt><dd>a snapshot of the sample's values</dd></dl>
 269 </li>
 270 </ul>
 271 </li>
 272 </ul>
 273 </li>
 274 </ul>
 275 </div>
 276 </div>
 277 <!-- ========= END OF CLASS DATA ========= -->
 278 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 279 <div class="bottomNav"><a name="navbar_bottom">
 280 <!--   -->
 281 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 282 <!--   -->
 283 </a>
 284 <ul class="navList" title="Navigation">
 285 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 286 <li><a href="package-summary.html">Package</a></li>
 287 <li class="navBarCell1Rev">Class</li>
 288 <li><a href="class-use/UniformSample.html">Use</a></li>
 289 <li><a href="package-tree.html">Tree</a></li>
 290 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 291 <li><a href="../../../../../help-doc.html">Help</a></li>
 292 </ul>
 293 </div>
 294 <div class="subNav">
 295 <ul class="navList">
 296 <li><a href="../../../../../org/apache/solr/util/stats/TimerContext.html" title="class in org.apache.solr.util.stats"><span class="strong">PREV CLASS</span></a></li>
 297 <li>NEXT CLASS</li>
 298 </ul>
 299 <ul class="navList">
 300 <li><a href="../../../../../index.html?org/apache/solr/util/stats/UniformSample.html" target="_top">FRAMES</a></li>
 301 <li><a href="UniformSample.html" target="_top">NO FRAMES</a></li>
 302 </ul>
 303 <ul class="navList" id="allclasses_navbar_bottom">
 304 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
 305 </ul>
 306 <div>
 307 <script type="text/javascript"><!--
 308   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 309   if(window==top) {
 310     allClassesLink.style.display = "block";
 311   }
 312   else {
 313     allClassesLink.style.display = "none";
 314   }
 315   //-->
 316 </script>
 317 </div>
 318 <div>
 319 <ul class="subNavList">
 320 <li>SUMMARY:&nbsp;</li>
 321 <li>NESTED&nbsp;|&nbsp;</li>
 322 <li>FIELD&nbsp;|&nbsp;</li>
 323 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
 324 <li><a href="#method_summary">METHOD</a></li>
 325 </ul>
 326 <ul class="subNavList">
 327 <li>DETAIL:&nbsp;</li>
 328 <li>FIELD&nbsp;|&nbsp;</li>
 329 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
 330 <li><a href="#method_detail">METHOD</a></li>
 331 </ul>
 332 </div>
 333 <a name="skip-navbar_bottom">
 334 <!--   -->
 335 </a></div>
 336 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 337 <p class="legalCopy"><small>
 338           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 339           <script src='../../../../../prettify.js' type='text/javascript'></script>
 340           <script type='text/javascript'>
 341             (function(){
 342               var oldonload = window.onload;
 343               if (typeof oldonload != 'function') {
 344                 window.onload = prettyPrint;
 345               } else {
 346                 window.onload = function() {
 347                   oldonload();
 348                   prettyPrint();
 349                 }
 350               }
 351             })();
 352           </script>
 353         </small></p>
 354 </body>
 355 </html>