| Current File : //usr/share/lib/java/javadoc/dtrace/api/org/opensolaris/os/dtrace/LinearDistribution.html |
<!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 -->
<title>LinearDistribution</title>
<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="LinearDistribution";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LinearDistribution.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/opensolaris/os/dtrace/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/LocalConsumer.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/LinearDistribution.html" target="_top">Frames</a></li>
<li><a href="LinearDistribution.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"><!--
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: </li>
<li><a href="#nested.classes.inherited.from.class.org.opensolaris.os.dtrace.Distribution">Nested</a> | </li>
<li>Field | </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>Field | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.opensolaris.os.dtrace</div>
<h2 title="Class LinearDistribution" class="title">Class LinearDistribution</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">org.opensolaris.os.dtrace.Distribution</a></li>
<li>
<ul class="inheritance">
<li>org.opensolaris.os.dtrace.LinearDistribution</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html" title="class in org.opensolaris.os.dtrace">LinearDistribution</a>>, java.lang.Iterable<<a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace">Distribution.Bucket</a>>, <a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">LinearDistribution</span>
extends <a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">Distribution</a>
implements java.io.Serializable, java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html" title="class in org.opensolaris.os.dtrace">LinearDistribution</a>></pre>
<div class="block">A linear frequency distribution aggregated by the DTrace <code>lquantize()</code> action. Aggregated values fall into consecutive ranges
bounded by the step parameter of the <code>lquantize()</code> action.
Each range, known as a bucket, begins at the <code>lquantize()</code>
lower bound, or base, plus a multiple of the <code>lquantize()</code>
step, unless it is the first bucket, which is the frequency of all
aggregated values less than the base. The last bucket counts all
aggregated values greater than or equal to the <code>lquantize()</code>
upper bound. For example
<pre> <code> @ = lquantize(n, 0, 100, 10);</code></pre>
results in a distribution with a base of 0, an upper bound of 100,
and a step of 10. It has twelve buckets starting with <code>n < 0</code>
and ending with <code>n >= 100</code>. The buckets in between are <code>0 .. 9</code>, <code>10 .. 19</code>, etc.
<p>
Immutable. Supports persistence using <code>XMLEncoder</code>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/opensolaris/os/dtrace/LogDistribution.html" title="class in org.opensolaris.os.dtrace"><code>LogDistribution</code></a>,
<a href="../../../../org/opensolaris/os/dtrace/Aggregation.html" title="class in org.opensolaris.os.dtrace"><code>Aggregation</code></a>,
<a href="../../../../serialized-form.html#org.opensolaris.os.dtrace.LinearDistribution">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.opensolaris.os.dtrace.Distribution">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class org.opensolaris.os.dtrace.<a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">Distribution</a></h3>
<code><a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace">Distribution.Bucket</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#LinearDistribution-long-long-java.util.List-">LinearDistribution</a></span>(long lowerBound,
long bucketStep,
java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace">Distribution.Bucket</a>> frequencies)</code>
<div class="block">Creates a linear distribution with the given base, step, and
frequencies.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#compareTo-org.opensolaris.os.dtrace.LinearDistribution-">compareTo</a></span>(<a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html" title="class in org.opensolaris.os.dtrace">LinearDistribution</a> d)</code>
<div class="block">Compares the <code>double</code> values of <a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#getValue--"><code>getValue()</code></a> for
overall magnitude, and if those are equal, compares the
frequencies at zero if the distributions include a bucket whose
range has a minimum of zero.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#getBase--">getBase</a></span>()</code>
<div class="block">Gets the lower bound of this distribution.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#getStep--">getStep</a></span>()</code>
<div class="block">Gets the difference between the lower bounds of consecutive
buckets after the first.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Number</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the numeric value of this distribution used to compare
distributions by overall magnitude, defined as the sum total of
each bucket's frequency times the minimum of its range.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#toString--">toString</a></span>()</code>
<div class="block">Gets a string representation of this linear distribution useful
for logging and not intended for display.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.opensolaris.os.dtrace.Distribution">
<!-- -->
</a>
<h3>Methods inherited from class org.opensolaris.os.dtrace.<a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">Distribution</a></h3>
<code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html#asList--">asList</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#get-int-">get</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#getBuckets--">getBuckets</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#getDisplayRange--">getDisplayRange</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#getTotal--">getTotal</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#hashCode--">hashCode</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#iterator--">iterator</a>, <a href="../../../../org/opensolaris/os/dtrace/Distribution.html#size--">size</a></code></li>
</ul>
<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, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Iterable</h3>
<code>forEach, spliterator</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LinearDistribution-long-long-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LinearDistribution</h4>
<pre>public LinearDistribution(long lowerBound,
long bucketStep,
java.util.List<<a href="../../../../org/opensolaris/os/dtrace/Distribution.Bucket.html" title="class in org.opensolaris.os.dtrace">Distribution.Bucket</a>> frequencies)</pre>
<div class="block">Creates a linear distribution with the given base, step, and
frequencies. Supports XML persistence.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lowerBound</code> - also known as the <i>base</i>; the minimum of
the second bucket in this distribution (the first bucket contains
the frequency of everything lower than the base)</dd>
<dd><code>bucketStep</code> - the distance between the lower bound of one
bucket and the lower bound of the next consecutive bucket
(excluding the first bucket)</dd>
<dd><code>frequencies</code> - list of frequencies in each bucket range</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if <code>frequencies</code> is <code>null</code></dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the given step is less than
one, or if any bucket does not have the expected range
(consecutive steps)</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getBase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBase</h4>
<pre>public long getBase()</pre>
<div class="block">Gets the lower bound of this distribution. In a linear
distribution, the first bucket holds the frequency of all values
less than the base, so the base is the minimum of the second
bucket's range.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lower bound of this distribution</dd>
</dl>
</li>
</ul>
<a name="getStep--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStep</h4>
<pre>public long getStep()</pre>
<div class="block">Gets the difference between the lower bounds of consecutive
buckets after the first.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the step between the lower bounds of consecutive buckets
after the first</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Number getValue()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html#getValue--">Distribution</a></code></span></div>
<div class="block">Gets the numeric value of this distribution used to compare
distributions by overall magnitude, defined as the sum total of
each bucket's frequency times the minimum of its range.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html#getValue--">getValue</a></code> in interface <code><a href="../../../../org/opensolaris/os/dtrace/AggregationValue.html" title="interface in org.opensolaris.os.dtrace">AggregationValue</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html#getValue--">getValue</a></code> in class <code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">Distribution</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>non-null numeric value</dd>
</dl>
</li>
</ul>
<a name="compareTo-org.opensolaris.os.dtrace.LinearDistribution-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public int compareTo(<a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html" title="class in org.opensolaris.os.dtrace">LinearDistribution</a> d)</pre>
<div class="block">Compares the <code>double</code> values of <a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html#getValue--"><code>getValue()</code></a> for
overall magnitude, and if those are equal, compares the
frequencies at zero if the distributions include a bucket whose
range has a minimum of zero.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/opensolaris/os/dtrace/LinearDistribution.html" title="class in org.opensolaris.os.dtrace">LinearDistribution</a>></code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Gets a string representation of this linear distribution useful
for logging and not intended for display. The exact details of
the representation are unspecified and subject to change, but the
following format may be regarded as typical:
<pre><code>
class-name[property1 = value1, property2 = value2]
</code></pre></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html#toString--">toString</a></code> in class <code><a href="../../../../org/opensolaris/os/dtrace/Distribution.html" title="class in org.opensolaris.os.dtrace">Distribution</a></code></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="../../../../org/opensolaris/os/dtrace/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LinearDistribution.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/opensolaris/os/dtrace/KernelSymbolRecord.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/opensolaris/os/dtrace/LocalConsumer.html" title="class in org.opensolaris.os.dtrace"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/opensolaris/os/dtrace/LinearDistribution.html" target="_top">Frames</a></li>
<li><a href="LinearDistribution.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"><!--
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: </li>
<li><a href="#nested.classes.inherited.from.class.org.opensolaris.os.dtrace.Distribution">Nested</a> | </li>
<li>Field | </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>Field | </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>