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

Histogram1D.html

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

<HTML>
<HEAD>

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

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="Histogram1D (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/Histogram1D.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/ref/FixedAxis.html" title="class in hep.aida.ref">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../hep/aida/ref/Histogram2D.html" title="class in hep.aida.ref">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="Histogram1D.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;FIELD&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.ref
 
Class Histogram1D</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">hep.aida.ref.Histogram
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by">hep.aida.ref.AbstractHistogram1D
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by">hep.aida.ref.Histogram1D
</PRE>
<DL>
<DT>All Implemented Interfaces: <DD><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A>, <A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</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>
<HR>
<DL>
<DT>public class Histogram1D<DT>extends hep.aida.ref.AbstractHistogram1D<DT>implements <A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></DL>

A reference implementation of hep.aida.IHistogram1D.
The goal is to provide a clear implementation rather than the most efficient implementation.
However, performance seems fine - filling 1.2 * 10^6 points/sec, both using FixedAxis or VariableAxis.

<DL>
<DT>Version:</DT>
 <DD>1.0, 23/03/2000</DD>
<DT>See Also:<DD><A HREF="../../../serialized-form.html#hep.aida.ref.Histogram1D">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_hep.aida.IHistogram"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Fields inherited from interface hep.aida.<A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/IHistogram.html#OVERFLOW">OVERFLOW</A>, <A HREF="../../../hep/aida/IHistogram.html#serialVersionUID">serialVersionUID</A>, <A HREF="../../../hep/aida/IHistogram.html#UNDERFLOW">UNDERFLOW</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/ref/Histogram1D.html#Histogram1D(java.lang.String, double[])">Histogram1D</A>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 double[]&nbsp;edges)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a variable-width histogram.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/ref/Histogram1D.html#Histogram1D(java.lang.String, hep.aida.IAxis)">Histogram1D</A>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 <A HREF="../../../hep/aida/IAxis.html" title="interface in hep.aida">IAxis</A>&nbsp;axis)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a histogram with the given axis binning.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/ref/Histogram1D.html#Histogram1D(java.lang.String, int, double, double)">Histogram1D</A>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 int&nbsp;bins,
 double&nbsp;min,
 double&nbsp;max)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a fixed-width histogram.</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;int</CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/ref/Histogram1D.html#allEntries()">allEntries</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of all entries in all (both in-range and under/overflow) bins in the histogram.</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/ref/Histogram1D.html#binEntries(int)">binEntries</A>(int&nbsp;index)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of entries in the corresponding bin (ie the number of times fill was called for this bin).</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/ref/Histogram1D.html#binError(int)">binError</A>(int&nbsp;index)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The error on this bin.</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/ref/Histogram1D.html#binHeight(int)">binHeight</A>(int&nbsp;index)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Total height of the corresponding bin (ie the sum of the weights in this bin).</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/ref/Histogram1D.html#dimensions()">dimensions</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.</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/ref/Histogram1D.html#entries()">entries</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of in-range entries in the histogram.</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/ref/Histogram1D.html#equivalentBinEntries()">equivalentBinEntries</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of equivalent entries.</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/ref/Histogram1D.html#extraEntries()">extraEntries</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of under and overflow entries in the histogram.</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/ref/Histogram1D.html#fill(double)">fill</A>(double&nbsp;x)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fill histogram with weight 1.</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/ref/Histogram1D.html#fill(double, double)">fill</A>(double&nbsp;x,
 double&nbsp;weight)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Fill histogram with specified weight.</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/ref/Histogram1D.html#mean()">mean</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the mean of the whole histogram as calculated on filling-time.</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/ref/Histogram1D.html#minMaxBins()">minMaxBins</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.</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/ref/Histogram1D.html#reset()">reset</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset contents; as if just constructed.</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/ref/Histogram1D.html#rms()">rms</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the rms of the whole histogram as calculated on filling-time.</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/ref/Histogram1D.html#sumAllBinHeights()">sumAllBinHeights</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sum of all (both in-range and under/overflow) bin heights in the histogram.</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/ref/Histogram1D.html#sumBinHeights()">sumBinHeights</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sum of in-range bin heights in the histogram.</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/ref/Histogram1D.html#sumExtraBinHeights()">sumExtraBinHeights</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sum of under/overflow bin heights in the histogram.</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/ref/Histogram1D.html#title()">title</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Title of the histogram (will be set only in the constructor).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../hep/aida/IAxis.html" title="interface in hep.aida">IAxis</A></CODE></TD>
<TD><CODE><A HREF="../../../hep/aida/ref/Histogram1D.html#xAxis()">xAxis</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the X Axis.</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <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#toString()" title="class or interface in java.lang">toString</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="methods_inherited_from_class_hep.aida.IHistogram1D"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from interface hep.aida.<A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#minMaxBins()">minMaxBins</A>, <A HREF="../../../hep/aida/IHistogram1D.html#xAxis()">xAxis</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_hep.aida.IHistogram"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD>Methods inherited from interface hep.aida.<A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../hep/aida/IHistogram.html#dimensions()">dimensions</A>, <A HREF="../../../hep/aida/IHistogram.html#entries()">entries</A>, <A HREF="../../../hep/aida/IHistogram.html#extraEntries()">extraEntries</A>, <A HREF="../../../hep/aida/IHistogram.html#sumAllBinHeights()">sumAllBinHeights</A>, <A HREF="../../../hep/aida/IHistogram.html#sumBinHeights()">sumBinHeights</A>, <A HREF="../../../hep/aida/IHistogram.html#sumExtraBinHeights()">sumExtraBinHeights</A>, <A HREF="../../../hep/aida/IHistogram.html#title()">title</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="Histogram1D(java.lang.String, double[])"></A><H3>
Histogram1D</H3>
<PRE>
public Histogram1D(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 double[]&nbsp;edges)</PRE>
<DL>
<DD>Creates a variable-width histogram.
 Example: <tt>edges = (0.2, 1.0, 5.0)</tt> yields an axis with 2 in-range bins <tt>[0.2,1.0), [1.0,5.0)</tt> and 2 extra bins <tt>[-inf,0.2), [5.0,inf]</tt>.

<DT>Parameters:<DD><CODE>title</CODE> - The histogram title.<DD><CODE>edges</CODE> - the bin boundaries the axis shall have;
 must be sorted ascending and must not contain multiple identical elements.
<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>edges.length < 1</tt>.</DL>
<HR>

<A NAME="Histogram1D(java.lang.String, int, double, double)"></A><H3>
Histogram1D</H3>
<PRE>
public Histogram1D(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 int&nbsp;bins,
 double&nbsp;min,
 double&nbsp;max)</PRE>
<DL>
<DD>Creates a fixed-width histogram.

<DT>Parameters:<DD><CODE>title</CODE> - The histogram title.<DD><CODE>bins</CODE> - The number of bins.<DD><CODE>min</CODE> - The minimum value on the X axis.<DD><CODE>max</CODE> - The maximum value on the X axis.</DL>
<HR>

<A NAME="Histogram1D(java.lang.String, hep.aida.IAxis)"></A><H3>
Histogram1D</H3>
<PRE>
public Histogram1D(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;title,
 <A HREF="../../../hep/aida/IAxis.html" title="interface in hep.aida">IAxis</A>&nbsp;axis)</PRE>
<DL>
<DD>Creates a histogram with the given axis binning.

<DT>Parameters:<DD><CODE>title</CODE> - The histogram title.<DD><CODE>axis</CODE> - The axis description to be used for binning.</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="allEntries()"></A><H3>
allEntries</H3>
<PRE>
public int allEntries()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Number of all entries in all (both in-range and under/overflow) bins in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#allEntries()">allEntries</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="binEntries(int)"></A><H3>
binEntries</H3>
<PRE>
public int binEntries(int&nbsp;index)</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#binEntries(int)">binEntries</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>index</CODE> - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.</DL>
</DD>
</DL>
<HR>

<A NAME="binError(int)"></A><H3>
binError</H3>
<PRE>
public double binError(int&nbsp;index)</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>The error on this bin.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#binError(int)">binError</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>index</CODE> - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.</DL>
</DD>
</DL>
<HR>

<A NAME="binHeight(int)"></A><H3>
binHeight</H3>
<PRE>
public double binHeight(int&nbsp;index)</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Total height of the corresponding bin (ie the sum of the weights in this bin).

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#binHeight(int)">binHeight</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>index</CODE> - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.</DL>
</DD>
</DL>
<HR>

<A NAME="equivalentBinEntries()"></A><H3>
equivalentBinEntries</H3>
<PRE>
public double equivalentBinEntries()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Number of equivalent entries.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#equivalentBinEntries()">equivalentBinEntries</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>

<DT>Returns:<DD><tt>SUM[ weight ] ^ 2 / SUM[ weight^2 ]</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="fill(double)"></A><H3>
fill</H3>
<PRE>
public void fill(double&nbsp;x)</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Fill histogram with weight 1.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#fill(double)">fill</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="fill(double, double)"></A><H3>
fill</H3>
<PRE>
public void fill(double&nbsp;x,
 double&nbsp;weight)</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Fill histogram with specified weight.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#fill(double, double)">fill</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="mean()"></A><H3>
mean</H3>
<PRE>
public double mean()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Returns the mean of the whole histogram as calculated on filling-time.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#mean()">mean</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="reset()"></A><H3>
reset</H3>
<PRE>
public void reset()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Reset contents; as if just constructed.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="rms()"></A><H3>
rms</H3>
<PRE>
public double rms()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Returns the rms of the whole histogram as calculated on filling-time.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#rms()">rms</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="dimensions()"></A><H3>
dimensions</H3>
<PRE>
public int dimensions()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#dimensions()">dimensions</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="entries()"></A><H3>
entries</H3>
<PRE>
public int entries()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Number of in-range entries in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#entries()">entries</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="extraEntries()"></A><H3>
extraEntries</H3>
<PRE>
public int extraEntries()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Number of under and overflow entries in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#extraEntries()">extraEntries</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="minMaxBins()"></A><H3>
minMaxBins</H3>
<PRE>
public int[] minMaxBins()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#minMaxBins()">minMaxBins</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>

<DT>Returns:<DD><tt>{minBin,maxBin}</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="sumAllBinHeights()"></A><H3>
sumAllBinHeights</H3>
<PRE>
public double sumAllBinHeights()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Sum of all (both in-range and under/overflow) bin heights in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#sumAllBinHeights()">sumAllBinHeights</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="sumBinHeights()"></A><H3>
sumBinHeights</H3>
<PRE>
public double sumBinHeights()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Sum of in-range bin heights in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#sumBinHeights()">sumBinHeights</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="sumExtraBinHeights()"></A><H3>
sumExtraBinHeights</H3>
<PRE>
public double sumExtraBinHeights()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Sum of under/overflow bin heights in the histogram.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#sumExtraBinHeights()">sumExtraBinHeights</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="xAxis()"></A><H3>
xAxis</H3>
<PRE>
public <A HREF="../../../hep/aida/IAxis.html" title="interface in hep.aida">IAxis</A> xAxis()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DD>
<DD>Returns the X Axis.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram1D.html#xAxis()">xAxis</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram1D.html" title="interface in hep.aida">IHistogram1D</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="title()"></A><H3>
title</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> title()</PRE>
<DL>
<DD>Description copied from interface: <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</A></CODE></DD>
<DD>Title of the histogram (will be set only in the constructor).

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../hep/aida/IHistogram.html#title()">title</A></CODE> in interface <CODE><A HREF="../../../hep/aida/IHistogram.html" title="interface in hep.aida">IHistogram</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/Histogram1D.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;FIELD&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