build/colt/doc/api/hep/aida/bin/MightyStaticBin1D.html (a20104a) - Rabbit simulation · Portfolio Code

MightyStaticBin1D.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
MightyStaticBin1D (Colt 1.2.0 - API Specification)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="MightyStaticBin1D (Colt 1.2.0 - API Specification)";
}
</SCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MightyStaticBin1D.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Colt 1.2.0
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../hep/aida/bin/DynamicBin1D.html" title="class in hep.aida.bin">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../hep/aida/bin/QuantileBin1D.html" title="class in hep.aida.bin">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="MightyStaticBin1D.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_cern.colt.PersistentObject">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

hep.aida.bin
 
Class MightyStaticBin1D</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../cern/colt/PersistentObject.html" title="class in cern.colt">cern.colt.PersistentObject</A>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../hep/aida/bin/AbstractBin.html" title="class in hep.aida.bin">hep.aida.bin.AbstractBin</A>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">hep.aida.bin.AbstractBin1D</A>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin">hep.aida.bin.StaticBin1D</A>
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by">hep.aida.bin.MightyStaticBin1D
</PRE>
<DL>
<DT>All Implemented Interfaces: <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A>, <A HREF="../../../cern/colt/buffer/DoubleBufferConsumer.html" title="interface in cern.colt.buffer">DoubleBufferConsumer</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD>
</DL>
<DL>
<DT>Direct Known Subclasses: <DD><A HREF="../../../hep/aida/bin/QuantileBin1D.html" title="class in hep.aida.bin">QuantileBin1D</A></DD>
</DL>
<HR>
<DL>
<DT>public class MightyStaticBin1D<DT>extends <A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin">StaticBin1D</A></DL>

Static and the same as its superclass, except that it can do more: Additionally computes moments of arbitrary integer order, harmonic mean, geometric mean, etc.
 
 Constructors need to be told what functionality is required for the given use case.
 Only maintains aggregate measures (incrementally) - the added elements themselves are not kept.

<DL>
<DT>Version:</DT>
 <DD>0.9, 03-Jul-99</DD>
<DT>See Also:<DD><A HREF="../../../serialized-form.html#hep.aida.bin.MightyStaticBin1D">Serialized Form</A></DL>
<HR>

<A NAME="field_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2>
Field Summary</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_cern.colt.PersistentObject"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Fields inherited from class cern.colt.<A HREF="../../../cern/colt/PersistentObject.html" title="class in cern.colt">PersistentObject</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../cern/colt/PersistentObject.html#serialVersionUID">serialVersionUID</A></CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2>
Constructor Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#MightyStaticBin1D()">MightyStaticBin1D</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs and returns an empty bin with limited functionality but good performance; equivalent to <tt>MightyStaticBin1D(false,false,4)</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#MightyStaticBin1D(boolean, boolean, int)">MightyStaticBin1D</A>(boolean&nbsp;hasSumOfLogarithms,
 boolean&nbsp;hasSumOfInversions,
 int&nbsp;maxOrderForSumOfPowers)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs and returns an empty bin with the given capabilities.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2>
Method Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#addAllOfFromTo(cern.colt.list.DoubleArrayList, int, int)">addAllOfFromTo</A>(<A HREF="../../../cern/colt/list/DoubleArrayList.html" title="class in cern.colt.list">DoubleArrayList</A>&nbsp;list,
 int&nbsp;from,
 int&nbsp;to)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the part of the specified list between indexes <tt>from</tt> (inclusive) and <tt>to</tt> (inclusive) to the receiver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#clone()">clone</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a deep copy of the receiver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#compareWith(hep.aida.bin.AbstractBin1D)">compareWith</A>(<A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A>&nbsp;other)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Computes the deviations from the receiver's measures to another bin's measures.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#geometricMean()">geometricMean</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the geometric mean, which is <tt>Product( x[i] )1.0/size()</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#getMaxOrderForSumOfPowers()">getMaxOrderForSumOfPowers</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the maximum order <tt>k</tt> for which sums of powers are retrievable, as specified upon instance construction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;int</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#getMinOrderForSumOfPowers()">getMinOrderForSumOfPowers</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the minimum order <tt>k</tt> for which sums of powers are retrievable, as specified upon instance construction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#harmonicMean()">harmonicMean</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the harmonic mean, which is <tt>size() / Sum( 1/x[i] )</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfInversions()">hasSumOfInversions</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether <tt>sumOfInversions()</tt> can return meaningful results.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfLogarithms()">hasSumOfLogarithms</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells whether <tt>sumOfLogarithms()</tt> can return meaningful results.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)">hasSumOfPowers</A>(int&nbsp;k)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tells whether <tt>sumOfPowers(k)</tt> can return meaningful results.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#kurtosis()">kurtosis</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the kurtosis (aka excess), which is <tt>-3 + moment(4,mean()) / standardDeviation()4</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#moment(int, double)">moment</A>(int&nbsp;k,
 double&nbsp;c)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the moment of <tt>k</tt>-th order with value <tt>c</tt>,
 which is <tt>Sum( (x[i]-c)k ) / size()</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#product()">product</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the product, which is <tt>Prod( x[i] )</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#skew()">skew</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the skew, which is <tt>moment(3,mean()) / standardDeviation()3</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfInversions()">sumOfInversions</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sum of inversions, which is <tt>Sum( 1 / x[i] )</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfLogarithms()">sumOfLogarithms</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sum of logarithms, which is <tt>Sum( Log(x[i]) )</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;double</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfPowers(int)">sumOfPowers</A>(int&nbsp;k)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the <tt>k-th</tt> order sum of powers, which is <tt>Sum( x[i]k )</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#toString()">toString</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a String representation of the receiver.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_hep.aida.bin.StaticBin1D"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from class hep.aida.bin.<A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin">StaticBin1D</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/bin/StaticBin1D.html#add(double)">add</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#clear()">clear</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#isRebinnable()">isRebinnable</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#max()">max</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#min()">min</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#size()">size</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#sum()">sum</A>, <A HREF="../../../hep/aida/bin/StaticBin1D.html#sumOfSquares()">sumOfSquares</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_hep.aida.bin.AbstractBin1D"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from class hep.aida.bin.<A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/bin/AbstractBin1D.html#addAllOf(cern.colt.list.DoubleArrayList)">addAllOf</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#buffered(int)">buffered</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#mean()">mean</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#rms()">rms</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#standardDeviation()">standardDeviation</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#standardError()">standardError</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#trimToSize()">trimToSize</A>, <A HREF="../../../hep/aida/bin/AbstractBin1D.html#variance()">variance</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_hep.aida.bin.AbstractBin"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from class hep.aida.bin.<A HREF="../../../hep/aida/bin/AbstractBin.html" title="class in hep.aida.bin">AbstractBin</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/bin/AbstractBin.html#center()">center</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#center(int)">center</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#error()">error</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#error(int)">error</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#offset()">offset</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#offset(int)">offset</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#value()">value</A>, <A HREF="../../../hep/aida/bin/AbstractBin.html#value(int)">value</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1>
Constructor Detail</TD>
</TR>
</TABLE>

<A NAME="MightyStaticBin1D()"></A><H3>
MightyStaticBin1D</H3>
<PRE>
public MightyStaticBin1D()</PRE>
<DL>
<DD>Constructs and returns an empty bin with limited functionality but good performance; equivalent to <tt>MightyStaticBin1D(false,false,4)</tt>.

</DL>
<HR>

<A NAME="MightyStaticBin1D(boolean, boolean, int)"></A><H3>
MightyStaticBin1D</H3>
<PRE>
public MightyStaticBin1D(boolean&nbsp;hasSumOfLogarithms,
 boolean&nbsp;hasSumOfInversions,
 int&nbsp;maxOrderForSumOfPowers)</PRE>
<DL>
<DD>Constructs and returns an empty bin with the given capabilities.

<DT>Parameters:<DD><CODE>hasSumOfLogarithms</CODE> - Tells whether <A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfLogarithms()"><CODE>sumOfLogarithms()</CODE></A> can return meaningful results.
 Set this parameter to <tt>false</tt> if measures of sum of logarithms, geometric mean and product are not required.
 <DD><CODE>hasSumOfInversions</CODE> - Tells whether <A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfInversions()"><CODE>sumOfInversions()</CODE></A> can return meaningful results.
 Set this parameter to <tt>false</tt> if measures of sum of inversions, harmonic mean and sumOfPowers(-1) are not required.
 <DD><CODE>maxOrderForSumOfPowers</CODE> - The maximum order <tt>k</tt> for which <A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfPowers(int)"><CODE>sumOfPowers(int)</CODE></A> can return meaningful results.
 Set this parameter to at least 3 if the skew is required, to at least 4 if the kurtosis is required.
 In general, if moments are required set this parameter at least as large as the largest required moment.
 This method always substitutes <tt>Math.max(2,maxOrderForSumOfPowers)</tt> for the parameter passed in.
 Thus, <tt>sumOfPowers(0..2)</tt> always returns meaningful results.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A>, 
<A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#moment(int, double)"><CODE>moment(int,double)</CODE></A></DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1>
Method Detail</TD>
</TR>
</TABLE>

<A NAME="addAllOfFromTo(cern.colt.list.DoubleArrayList, int, int)"></A><H3>
addAllOfFromTo</H3>
<PRE>
public void addAllOfFromTo(<A HREF="../../../cern/colt/list/DoubleArrayList.html" title="class in cern.colt.list">DoubleArrayList</A>&nbsp;list,
 int&nbsp;from,
 int&nbsp;to)</PRE>
<DL>
<DD>Adds the part of the specified list between indexes <tt>from</tt> (inclusive) and <tt>to</tt> (inclusive) to the receiver.

<DD><DL>
<DT>Overrides:<DD><CODE><A HREF="../../../hep/aida/bin/StaticBin1D.html#addAllOfFromTo(cern.colt.list.DoubleArrayList, int, int)">addAllOfFromTo</A></CODE> in class <CODE><A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin">StaticBin1D</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>list</CODE> - the list of which elements shall be added.<DD><CODE>from</CODE> - the index of the first element to be added (inclusive).<DD><CODE>to</CODE> - the index of the last element to be added (inclusive).
<DT>Throws:
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if <tt>list.size()&gt;0 && (from&lt;0 || from&gt;to || to&gt;=list.size())</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="clone()"></A><H3>
clone</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> clone()</PRE>
<DL>
<DD>Returns a deep copy of the receiver.

<DD><DL>
<DT>Overrides:<DD><CODE><A HREF="../../../cern/colt/PersistentObject.html#clone()">clone</A></CODE> in class <CODE><A HREF="../../../cern/colt/PersistentObject.html" title="class in cern.colt">PersistentObject</A></CODE></DL>
</DD>
<DD><DL>

<DT>Returns:<DD>a deep copy of the receiver.</DL>
</DD>
</DL>
<HR>

<A NAME="compareWith(hep.aida.bin.AbstractBin1D)"></A><H3>
compareWith</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> compareWith(<A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A>&nbsp;other)</PRE>
<DL>
<DD>Computes the deviations from the receiver's measures to another bin's measures.

<DD><DL>
<DT>Overrides:<DD><CODE><A HREF="../../../hep/aida/bin/AbstractBin1D.html#compareWith(hep.aida.bin.AbstractBin1D)">compareWith</A></CODE> in class <CODE><A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>other</CODE> - the other bin to compare with
<DT>Returns:<DD>a summary of the deviations.</DL>
</DD>
</DL>
<HR>

<A NAME="geometricMean()"></A><H3>
geometricMean</H3>
<PRE>
public double geometricMean()</PRE>
<DL>
<DD>Returns the geometric mean, which is <tt>Product( x[i] )1.0/size()</tt>.

This method tries to avoid overflows at the expense of an equivalent but somewhat inefficient definition:
 <tt>geoMean = exp( Sum( Log(x[i]) ) / size())</tt>.
 Note that for a geometric mean to be meaningful, the minimum of the data sequence must not be less or equal to zero.

<DD><DL>

<DT>Returns:<DD>the geometric mean; <tt>Double.NaN</tt> if <tt>!hasSumOfLogarithms()</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxOrderForSumOfPowers()"></A><H3>
getMaxOrderForSumOfPowers</H3>
<PRE>
public int getMaxOrderForSumOfPowers()</PRE>
<DL>
<DD>Returns the maximum order <tt>k</tt> for which sums of powers are retrievable, as specified upon instance construction.

<DD><DL>
<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A>, 
<A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfPowers(int)"><CODE>sumOfPowers(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getMinOrderForSumOfPowers()"></A><H3>
getMinOrderForSumOfPowers</H3>
<PRE>
public int getMinOrderForSumOfPowers()</PRE>
<DL>
<DD>Returns the minimum order <tt>k</tt> for which sums of powers are retrievable, as specified upon instance construction.

<DD><DL>
<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A>, 
<A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#sumOfPowers(int)"><CODE>sumOfPowers(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="harmonicMean()"></A><H3>
harmonicMean</H3>
<PRE>
public double harmonicMean()</PRE>
<DL>
<DD>Returns the harmonic mean, which is <tt>size() / Sum( 1/x[i] )</tt>.
 Remember: If the receiver contains at least one element of <tt>0.0</tt>, the harmonic mean is <tt>0.0</tt>.

<DD><DL>

<DT>Returns:<DD>the harmonic mean; <tt>Double.NaN</tt> if <tt>!hasSumOfInversions()</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfInversions()"><CODE>hasSumOfInversions()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="hasSumOfInversions()"></A><H3>
hasSumOfInversions</H3>
<PRE>
public boolean hasSumOfInversions()</PRE>
<DL>
<DD>Returns whether <tt>sumOfInversions()</tt> can return meaningful results.

<DD><DL>

<DT>Returns:<DD><tt>false</tt> if the bin was constructed with insufficient parametrization, <tt>true</tt> otherwise.
 See the constructors for proper parametrization.</DL>
</DD>
</DL>
<HR>

<A NAME="hasSumOfLogarithms()"></A><H3>
hasSumOfLogarithms</H3>
<PRE>
public boolean hasSumOfLogarithms()</PRE>
<DL>
<DD>Tells whether <tt>sumOfLogarithms()</tt> can return meaningful results.

<DD><DL>

<DT>Returns:<DD><tt>false</tt> if the bin was constructed with insufficient parametrization, <tt>true</tt> otherwise.
 See the constructors for proper parametrization.</DL>
</DD>
</DL>
<HR>

<A NAME="hasSumOfPowers(int)"></A><H3>
hasSumOfPowers</H3>
<PRE>
public boolean hasSumOfPowers(int&nbsp;k)</PRE>
<DL>
<DD>Tells whether <tt>sumOfPowers(k)</tt> can return meaningful results.
 Defined as <tt>hasSumOfPowers(k) <==> getMinOrderForSumOfPowers() <= k && k <= getMaxOrderForSumOfPowers()</tt>.
 A return value of <tt>true</tt> implies that <tt>hasSumOfPowers(k-1) .. hasSumOfPowers(0)</tt> will also return <tt>true</tt>.
 See the constructors for proper parametrization.
 
 Details: 
 <tt>hasSumOfPowers(0..2)</tt> will always yield <tt>true</tt>.
 <tt>hasSumOfPowers(-1) <==> hasSumOfInversions()</tt>.

<DD><DL>

<DT>Returns:<DD><tt>false</tt> if the bin was constructed with insufficient parametrization, <tt>true</tt> otherwise.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#getMinOrderForSumOfPowers()"><CODE>getMinOrderForSumOfPowers()</CODE></A>, 
<A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#getMaxOrderForSumOfPowers()"><CODE>getMaxOrderForSumOfPowers()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="kurtosis()"></A><H3>
kurtosis</H3>
<PRE>
public double kurtosis()</PRE>
<DL>
<DD>Returns the kurtosis (aka excess), which is <tt>-3 + moment(4,mean()) / standardDeviation()4</tt>.

<DD><DL>

<DT>Returns:<DD>the kurtosis; <tt>Double.NaN</tt> if <tt>!hasSumOfPowers(4)</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="moment(int, double)"></A><H3>
moment</H3>
<PRE>
public double moment(int&nbsp;k,
 double&nbsp;c)</PRE>
<DL>
<DD>Returns the moment of <tt>k</tt>-th order with value <tt>c</tt>,
 which is <tt>Sum( (x[i]-c)k ) / size()</tt>.

<DD><DL>
<DT>Parameters:<DD><CODE>k</CODE> - the order; must be greater than or equal to zero.<DD><CODE>c</CODE> - any number.
<DT>Returns:<DD><tt>Double.NaN</tt> if <tt>!hasSumOfPower(k)</tt>.
<DT>Throws:
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <tt>k < 0</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="product()"></A><H3>
product</H3>
<PRE>
public double product()</PRE>
<DL>
<DD>Returns the product, which is <tt>Prod( x[i] )</tt>.
 In other words: <tt>x[0]*x[1]*...*x[size()-1]</tt>.

<DD><DL>

<DT>Returns:<DD>the product; <tt>Double.NaN</tt> if <tt>!hasSumOfLogarithms()</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfLogarithms()"><CODE>hasSumOfLogarithms()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="skew()"></A><H3>
skew</H3>
<PRE>
public double skew()</PRE>
<DL>
<DD>Returns the skew, which is <tt>moment(3,mean()) / standardDeviation()3</tt>.

<DD><DL>

<DT>Returns:<DD>the skew; <tt>Double.NaN</tt> if <tt>!hasSumOfPowers(3)</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sumOfInversions()"></A><H3>
sumOfInversions</H3>
<PRE>
public double sumOfInversions()</PRE>
<DL>
<DD>Returns the sum of inversions, which is <tt>Sum( 1 / x[i] )</tt>.

<DD><DL>

<DT>Returns:<DD>the sum of inversions; <tt>Double.NaN</tt> if <tt>!hasSumOfInversions()</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfInversions()"><CODE>hasSumOfInversions()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sumOfLogarithms()"></A><H3>
sumOfLogarithms</H3>
<PRE>
public double sumOfLogarithms()</PRE>
<DL>
<DD>Returns the sum of logarithms, which is <tt>Sum( Log(x[i]) )</tt>.

<DD><DL>

<DT>Returns:<DD>the sum of logarithms; <tt>Double.NaN</tt> if <tt>!hasSumOfLogarithms()</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfLogarithms()"><CODE>hasSumOfLogarithms()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="sumOfPowers(int)"></A><H3>
sumOfPowers</H3>
<PRE>
public double sumOfPowers(int&nbsp;k)</PRE>
<DL>
<DD>Returns the <tt>k-th</tt> order sum of powers, which is <tt>Sum( x[i]k )</tt>.

<DD><DL>
<DT>Parameters:<DD><CODE>k</CODE> - the order of the powers.
<DT>Returns:<DD>the sum of powers; <tt>Double.NaN</tt> if <tt>!hasSumOfPowers(k)</tt>.<DT>See Also:<DD><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html#hasSumOfPowers(int)"><CODE>hasSumOfPowers(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="toString()"></A><H3>
toString</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> toString()</PRE>
<DL>
<DD>Returns a String representation of the receiver.

<DD><DL>
<DT>Overrides:<DD><CODE><A HREF="../../../hep/aida/bin/AbstractBin1D.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MightyStaticBin1D.html">Use</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Colt 1.2.0
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_cern.colt.PersistentObject">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>
Jump to the <a target=_top href=http://dsd.lbl.gov/~hoschek/colt >Colt Homepage</a>
</BODY>
</HTML>

Rabbit simulation

initial commit