| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StatCalculator (Apache JMeter dist API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.jorphan.math, class: StatCalculator"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/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="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache JMeter</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jorphan.math</a></div> |
| <h1 title="Class StatCalculator" class="title">Class StatCalculator<T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> & <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><? super T>></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jorphan.math.StatCalculator<T></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - type parameter for the calculator</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="StatCalculatorInteger.html" title="class in org.apache.jorphan.math">StatCalculatorInteger</a></code>, <code><a href="StatCalculatorLong.html" title="class in org.apache.jorphan.math">StatCalculatorLong</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">StatCalculator<T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> & <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><? super T>></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">This class serves as a way to calculate the median, max, min etc. of a list of values. |
| It is not threadsafe.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(T,T,T)" class="member-name-link">StatCalculator</a><wbr>(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> zero, |
| <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> min, |
| <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> max)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This constructor is used to set up particular values for the generic class instance.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAll(org.apache.jorphan.math.StatCalculator)" class="member-name-link">addAll</a><wbr>(<a href="StatCalculator.html" title="class in org.apache.jorphan.math">StatCalculator</a><<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a>> calc)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addBytes(long)" class="member-name-link">addBytes</a><wbr>(long newValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add to received bytes</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addSentBytes(long)" class="member-name-link">addSentBytes</a><wbr>(long newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add to sent bytes</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addValue(T)" class="member-name-link">addValue</a><wbr>(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a single value (normally elapsed time)</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addValue(T,long)" class="member-name-link">addValue</a><wbr>(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| long sampleCount)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Update the calculator with the value for an aggregated sample.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#divide(T,int)" class="member-name-link">divide</a><wbr>(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| int n)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#divide(T,long)" class="member-name-link">divide</a><wbr>(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| long n)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCount()" class="member-name-link">getCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDistribution()" class="member-name-link">getDistribution</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the distribution of the values in the list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMax()" class="member-name-link">getMax</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMean()" class="member-name-link">getMean</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMedian()" class="member-name-link">getMedian</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMin()" class="member-name-link">getMin</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPercentPoint(double)" class="member-name-link">getPercentPoint</a><wbr>(double percent)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the value which %percent% of the values are less than.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPercentPoint(float)" class="member-name-link">getPercentPoint</a><wbr>(float percent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the value which %percent% of the values are less than.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStandardDeviation()" class="member-name-link">getStandardDeviation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSum()" class="member-name-link">getSum</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotalBytes()" class="member-name-link">getTotalBytes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotalSentBytes()" class="member-name-link">getTotalSentBytes</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(T,T,T)"> |
| <h3 id="<init>(java.lang.Number,java.lang.Number,java.lang.Number)">StatCalculator</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">StatCalculator</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> zero, |
| <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> min, |
| <a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> max)</span></div> |
| <div class="block">This constructor is used to set up particular values for the generic class instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>zero</code> - - value to return for Median and PercentPoint if there are no values</dd> |
| <dd><code>min</code> - - value to return for minimum if there are no values</dd> |
| <dd><code>max</code> - - value to return for maximum if there are no values</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addBytes(long)"> |
| <h3>addBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addBytes</span><wbr><span class="parameters">(long newValue)</span></div> |
| <div class="block">Add to received bytes</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - number of newly received bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSentBytes(long)"> |
| <h3>addSentBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSentBytes</span><wbr><span class="parameters">(long newValue)</span></div> |
| <div class="block">Add to sent bytes</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>newValue</code> - number of newly sent bytes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAll(org.apache.jorphan.math.StatCalculator)"> |
| <h3>addAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAll</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="class in org.apache.jorphan.math">StatCalculator</a><<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a>> calc)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMedian()"> |
| <h3>getMedian</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">getMedian</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotalBytes()"> |
| <h3>getTotalBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTotalBytes</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotalSentBytes()"> |
| <h3>getTotalSentBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getTotalSentBytes</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPercentPoint(float)"> |
| <h3>getPercentPoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">getPercentPoint</span><wbr><span class="parameters">(float percent)</span></div> |
| <div class="block">Get the value which %percent% of the values are less than. This works |
| just like median (where median represents the 50% point). A typical |
| desire is to see the 90% point - the value that 90% of the data points |
| are below, the remaining 10% are above.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>percent</code> - number representing the wished percent (between <code>0</code> |
| and <code>1.0</code>)</dd> |
| <dt>Returns:</dt> |
| <dd>number of values less than the percentage</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPercentPoint(double)"> |
| <h3>getPercentPoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">getPercentPoint</span><wbr><span class="parameters">(double percent)</span></div> |
| <div class="block">Get the value which %percent% of the values are less than. This works |
| just like median (where median represents the 50% point). A typical |
| desire is to see the 90% point - the value that 90% of the data points |
| are below, the remaining 10% are above.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>percent</code> - number representing the wished percent (between <code>0</code> |
| and <code>1.0</code>)</dd> |
| <dt>Returns:</dt> |
| <dd>the value which %percent% of the values are less than</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDistribution()"> |
| <h3>getDistribution</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>[]></span> <span class="element-name">getDistribution</span>()</div> |
| <div class="block">Returns the distribution of the values in the list.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>map containing either Integer or Long keys; entries are a Number array containing the key and the [Integer] count. |
| TODO - why is the key value also stored in the entry array? See Bug 53825</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMean()"> |
| <h3>getMean</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getMean</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStandardDeviation()"> |
| <h3>getStandardDeviation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getStandardDeviation</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMin()"> |
| <h3>getMin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">getMin</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMax()"> |
| <h3>getMax</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">getMax</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCount()"> |
| <h3>getCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getCount</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSum()"> |
| <h3>getSum</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getSum</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="divide(T,int)"> |
| <h3 id="divide(java.lang.Number,int)">divide</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">divide</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| int n)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="divide(T,long)"> |
| <h3 id="divide(java.lang.Number,long)">divide</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="StatCalculator.html" title="type parameter in StatCalculator">T</a></span> <span class="element-name">divide</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| long n)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addValue(T,long)"> |
| <h3 id="addValue(java.lang.Number,long)">addValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addValue</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val, |
| long sampleCount)</span></div> |
| <div class="block">Update the calculator with the value for an aggregated sample.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the aggregate value, normally the elapsed time</dd> |
| <dd><code>sampleCount</code> - the number of samples contributing to the aggregate value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addValue(T)"> |
| <h3 id="addValue(java.lang.Number)">addValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addValue</span><wbr><span class="parameters">(<a href="StatCalculator.html" title="type parameter in StatCalculator">T</a> val)</span></div> |
| <div class="block">Add a single value (normally elapsed time)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the value to add, which should correspond with a single sample</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#addValue(T,long)"><code>addValue(Number, long)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
