\section{A\-I\-D\-A\-:\-:I\-Histogram Class Reference}
\label{classAIDA_1_1IHistogram}\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}}


User level interface to Histogram.  




{\ttfamily \#include $<$I\-Histogram.\-h$>$}

Inheritance diagram for A\-I\-D\-A\-:\-:I\-Histogram\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4.000000cm]{classAIDA_1_1IHistogram}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-I\-Histogram} ()\label{classAIDA_1_1IHistogram_a84287bef7dce2983cad9d1f6fe6fc986}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual int {\bf all\-Entries} () const =0
\begin{DoxyCompactList}\small\item\em Sum of the entries in all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins, i.\-e in-\/range bins, U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W. \end{DoxyCompactList}\item 
virtual int {\bf extra\-Entries} () const =0
\begin{DoxyCompactList}\small\item\em Number of entries in the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. \end{DoxyCompactList}\item 
virtual double {\bf sum\-Bin\-Heights} () const =0
\begin{DoxyCompactList}\small\item\em Number of equivalent entries, i.\-e. \end{DoxyCompactList}\item 
virtual double {\bf sum\-All\-Bin\-Heights} () const =0
\begin{DoxyCompactList}\small\item\em Sum of the heights of all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins, i.\-e in-\/range bins, U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W. \end{DoxyCompactList}\item 
virtual double {\bf sum\-Extra\-Bin\-Heights} () const =0
\begin{DoxyCompactList}\small\item\em Sum of heights in the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. \end{DoxyCompactList}\item 
virtual double {\bf min\-Bin\-Height} () const =0
\begin{DoxyCompactList}\small\item\em Minimum height of the in-\/range bins, i.\-e. \end{DoxyCompactList}\item 
virtual double {\bf max\-Bin\-Height} () const =0
\begin{DoxyCompactList}\small\item\em Maximum height of the in-\/range bins, i.\-e. \end{DoxyCompactList}\item 
virtual bool {\bf scale} (double scale\-Factor)=0
\begin{DoxyCompactList}\small\item\em Scale the weights and the errors of all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins (in-\/range and out-\/of-\/range ones) by a given scale factor. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
User level interface to Histogram. 

\begin{DoxyAuthor}{Author}
The \doxyref{A\-I\-D\-A}{p.}{namespaceAIDA} team ({\tt http\-://aida.\-freehep.\-org/}) 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!all\-Entries@{all\-Entries}}
\index{all\-Entries@{all\-Entries}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{all\-Entries}]{\setlength{\rightskip}{0pt plus 5cm}virtual int A\-I\-D\-A\-::\-I\-Histogram\-::all\-Entries (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_ac9bd90045820a21a9809c7763b41ebc4}


Sum of the entries in all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins, i.\-e in-\/range bins, U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W. 

This is equivalent to the number of times the method fill was invoked. \begin{DoxyReturn}{Returns}
The sum of all the entries. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a4e4b50032fa6a73b1924845e0d81cb36}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_a32afca22485e812e9561471ce74e8f26}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a3162d3b285ac8abb73d41875150abe57}.

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!extra\-Entries@{extra\-Entries}}
\index{extra\-Entries@{extra\-Entries}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{extra\-Entries}]{\setlength{\rightskip}{0pt plus 5cm}virtual int A\-I\-D\-A\-::\-I\-Histogram\-::extra\-Entries (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_a5376c34c0481f8507a19498f353f037d}


Number of entries in the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. 

\begin{DoxyReturn}{Returns}
The number of entries outside the range of the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a493ae9554357b2714305bf13926671bd}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_aceab4e9636dea0f1a4d0339129505a1a}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a70904a546a497bbceb865f144ff0cf1c}.

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!max\-Bin\-Height@{max\-Bin\-Height}}
\index{max\-Bin\-Height@{max\-Bin\-Height}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{max\-Bin\-Height}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram\-::max\-Bin\-Height (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_a66de00003558ace7614d19184519de83}


Maximum height of the in-\/range bins, i.\-e. 

not considering the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. \begin{DoxyReturn}{Returns}
The maximum height among the in-\/range bins. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_af7eae32f72b18ff14a22ad559f3f3d14}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_a64d4d631b02647c8d4aa645bc46be74c}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_ac7c93958f279a8e8ad958ec794147e1a}.

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!min\-Bin\-Height@{min\-Bin\-Height}}
\index{min\-Bin\-Height@{min\-Bin\-Height}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{min\-Bin\-Height}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram\-::min\-Bin\-Height (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_ad76c6fe57962f7a5c5a9affce27c7cfb}


Minimum height of the in-\/range bins, i.\-e. 

not considering the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. \begin{DoxyReturn}{Returns}
The minimum height among the in-\/range bins. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a0d3c082341b7ca7c3a846fe9e5c3ef51}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_a7a912e2d73c66c07b7cb074683170bcb}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a785264b8000d2af3cb348ea6661f7f76}.

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!scale@{scale}}
\index{scale@{scale}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{scale}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Histogram\-::scale (
\begin{DoxyParamCaption}
\item[{double}]{scale\-Factor}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_a130d979ac39be5cddf8ed97878bdf131}


Scale the weights and the errors of all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins (in-\/range and out-\/of-\/range ones) by a given scale factor. 


\begin{DoxyParams}{Parameters}
{\em scale\-Factor} & The scale factor. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the scale factor is negative. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_aada44e244af1d967c253292e192ab15a}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_accee9b414a513322b0d1435c6a00b007}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_aaa543090a760d0e6260a2552e64daead}.



Referenced by A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::scale(), A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T\-::scale(), and A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T\-::scale().

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!sum\-All\-Bin\-Heights@{sum\-All\-Bin\-Heights}}
\index{sum\-All\-Bin\-Heights@{sum\-All\-Bin\-Heights}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{sum\-All\-Bin\-Heights}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram\-::sum\-All\-Bin\-Heights (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_a4ec5b1ff96f011c496b3e30ae0211cd0}


Sum of the heights of all the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}'s bins, i.\-e in-\/range bins, U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W. 

\begin{DoxyReturn}{Returns}
The sum of all the bins heights. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a69e7a02bd3d1a06bd962169c6137188a}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_afefc31ea23a1431ee24b53ff6ca399a1}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a3da0029c74f5e1c77c5595e9f3a61572}.



Referenced by A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::sum\-Of\-Weights(), A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T\-::sum\-Of\-Weights(), and A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T\-::sum\-Of\-Weights().

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!sum\-Bin\-Heights@{sum\-Bin\-Heights}}
\index{sum\-Bin\-Heights@{sum\-Bin\-Heights}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{sum\-Bin\-Heights}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram\-::sum\-Bin\-Heights (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_ac05bc2c2dc807958ce43ada41adb4238}


Number of equivalent entries, i.\-e. 

{\ttfamily S\-U\-M[ weight ] $^\wedge$ 2 / S\-U\-M[ weight$^\wedge$2 ]} \begin{DoxyReturn}{Returns}
The number of equivalent entries.\-virtual double equivalent\-Bin\-Entries() const = 0; Sum of in-\/range bin heights in the \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}, U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins are excluded. 

The sum of the in-\/range bins heights. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a870a75e7b23a25d1c700ad255617ca6a}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_a41a21bf11adf16e4017e1589f1989f4b}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a55041307d014db566595e1829004e665}.

\index{A\-I\-D\-A\-::\-I\-Histogram@{A\-I\-D\-A\-::\-I\-Histogram}!sum\-Extra\-Bin\-Heights@{sum\-Extra\-Bin\-Heights}}
\index{sum\-Extra\-Bin\-Heights@{sum\-Extra\-Bin\-Heights}!AIDA::IHistogram@{A\-I\-D\-A\-::\-I\-Histogram}}
\subsubsection[{sum\-Extra\-Bin\-Heights}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram\-::sum\-Extra\-Bin\-Heights (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram_a2e76e736ca1b3ad7e5c1c41810ee9e28}


Sum of heights in the U\-N\-D\-E\-R\-F\-L\-O\-W and O\-V\-E\-R\-F\-L\-O\-W bins. 

\begin{DoxyReturn}{Returns}
The sum of the heights of the out-\/of-\/range bins. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram3DROOT_a52f9aa8de522b597865baec210eb6733}, {\bf A\-I\-D\-A\-::\-I\-Histogram2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram2DROOT_a0bb31e8b8094650701d98d9bb3a45cdf}, and {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_aed8a5d991eaf83c9aa3e793e3da94a0b}.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
I\-Histogram.\-h\end{DoxyCompactItemize}
