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

package-summary.html

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

<HTML>
<HEAD>

<TITLE>
hep.aida.bin (Colt 1.2.0 - API Specification)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="hep.aida.bin (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Package&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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/package-summary.html">PREV PACKAGE</A>&nbsp;
&nbsp;<A HREF="../../../hep/aida/ref/package-summary.html">NEXT PACKAGE</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="package-summary.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>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>
<H2>
Package hep.aida.bin
</H2>
Multisets (bags) with efficient statistics operations defined upon; This package 
 requires the Colt distribution.

See:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description">Description</A>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2>
Interface Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/BinBinFunction1D.html" title="interface in hep.aida.bin">BinBinFunction1D</A></TD>
<TD>Interface that represents a function object: a function that takes 
 two bins as arguments and returns a single value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/BinFunction1D.html" title="interface in hep.aida.bin">BinFunction1D</A></TD>
<TD>Interface that represents a function object: a function that takes 
 two bins as arguments and returns a single value.</TD>
</TR>
</TABLE>
&nbsp;

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2>
Class Summary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/AbstractBin.html" title="class in hep.aida.bin">AbstractBin</A></TD>
<TD>Abstract base class for all arbitrary-dimensional bins consumes <tt>double</tt> elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin">AbstractBin1D</A></TD>
<TD>Abstract base class for all 1-dimensional bins consumes <tt>double</tt> elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/BinFunctions1D.html" title="class in hep.aida.bin">BinFunctions1D</A></TD>
<TD>Function objects computing dynamic bin aggregations; to be passed to generic methods.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/DynamicBin1D.html" title="class in hep.aida.bin">DynamicBin1D</A></TD>
<TD>1-dimensional rebinnable bin holding <tt>double</tt> elements;
 Efficiently computes advanced statistics of data sequences.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/MightyStaticBin1D.html" title="class in hep.aida.bin">MightyStaticBin1D</A></TD>
<TD>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/QuantileBin1D.html" title="class in hep.aida.bin">QuantileBin1D</A></TD>
<TD>1-dimensional non-rebinnable bin holding <tt>double</tt> elements with scalable quantile operations defined upon;
Using little main memory, quickly computes approximate quantiles over very large data sequences with and even without a-priori knowledge of the number of elements to be filled;
Conceptually a strongly lossily compressed multiset (or bag);
Guarantees to respect the worst case approximation error specified upon instance construction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin">StaticBin1D</A></TD>
<TD>1-dimensional non-rebinnable bin consuming <tt>double</tt> elements;
 Efficiently computes basic statistics of data sequences.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="package_description"></A><H2>
Package hep.aida.bin Description
</H2>

Multisets (bags) with efficient statistics operations defined upon; This package 
 requires the Colt distribution.
Bins contain information about the data filled into them. They can be asked 
 for various descriptive statistical measures, such as the minimum, maximum, 
 size, mean, rms, variance, etc. 
<H4>Static vs. Dynamic bins and their space-time-functionality trade-offs</H4>

Bins come in two flavours: Dynamic and Static. Dynamic bins preserve 
 all the values filled into them and can return these exact values, when asked 
 to do so. They are rebinnable. 
 Static bins do not preserve the values filled into them. They merely collect 
 basic statistics incrementally while they are being filled. They immediately 
 forget about the filled values and keep only the derived statistics. They are 
 not rebinnable. 
 The data filled into static bins is not preserved. As a consequence infinitely 
 many elements can be added to such bins. As a further consequence such bins 
 cannot compute more than basic statistics. They are also not rebinnable. If 
 these drawbacks matter, consider to use a <A HREF="../../../hep/aida/bin/DynamicBin1D.html" title="class in hep.aida.bin"><CODE>DynamicBin1D</CODE></A>, 
 which overcomes them at the expense of increased memory requirements. 

The data filled into dynamic bins is fully preserved.
Technically speaking, they are k-dimensional multisets (or bags) with efficient statistics operations defined upon.
As a consequence such bins can compute more than only basic statistics.
They are also rebinnable.
On the other hand side, if many elements are filled into them, one may quickly run out of memory (each <tt>double</tt> element takes 8 bytes).
If these drawbacks matter, consider to use a <A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin"><CODE>StaticBin1D</CODE></A>, 
which overcomes them at the expense of limited functionality.

<H4>Available bin types</H4>

All bins are derived from a common abstract base class <A HREF="../../../hep/aida/bin/AbstractBin.html" title="class in hep.aida.bin"><CODE>AbstractBin</CODE></A>. 
This base class is extended by <A HREF="../../../hep/aida/bin/AbstractBin1D.html" title="class in hep.aida.bin"><CODE>AbstractBin1D</CODE></A>, the common 
abstract base class for 1-dimensional bins. 
 Static 1-dimensional bins currently offered are: <A HREF="../../../hep/aida/bin/StaticBin1D.html" title="class in hep.aida.bin"><CODE>StaticBin1D</CODE></A>, 
 <A HREF="../../../hep/aida/bin/MightyStaticBin1D.html" title="class in hep.aida.bin"><CODE>MightyStaticBin1D</CODE></A> and <A HREF="../../../hep/aida/bin/QuantileBin1D.html" title="class in hep.aida.bin"><CODE>QuantileBin1D</CODE></A>. 
 
 Dynamic 1-dimensional bins currently offered are: <A HREF="../../../hep/aida/bin/DynamicBin1D.html" title="class in hep.aida.bin"><CODE>DynamicBin1D</CODE></A>. 
<h4> Advanced statistics on dynamic bins</h4>
In case not each and every statistics measure needed is directly provided by 
 methods of bins one can use dynamic bins and retrieve their filled elements. 
 From these elements, one can compute whatever necessary, either by using a statistics 
 library or self written functions. Use methods like <A HREF="../../../hep/aida/bin/DynamicBin1D.html#elements()"><CODE>DynamicBin1D.elements()</CODE></A> 
 and, for example, the descriptive statistics library <A HREF="../../../cern/jet/stat/Descriptive.html" title="class in cern.jet.stat"><CODE>Descriptive</CODE></A>.

<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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Package&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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>
</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