FreeFOAM The Cross-Platform CFD Toolkit
Histogram< List > Class Template Reference

Calculates the counts per bin of a list. More...

#include <OpenFOAM/Histogram.H>


Detailed Description

template<class List>
class Foam::Histogram< List >

Calculates the counts per bin of a list.

Source files

Definition at line 51 of file Histogram.H.

List of all members.

Public Member Functions

 Histogram (const List &bins, const List &l)
 Construct given bin values and input list.
 Histogram (const typename List::const_reference min, const typename List::const_reference max, const label nBins, const List &l)
 Construct given min, max, number of bins and input list.
const labelListcounts () const
 Return the counts per bin.
label nLow () const
 Return the number of elements <= bins[0].
label nHigh () const
 Return the number of elements > bins[bins.size()-1].

Constructor & Destructor Documentation

Histogram ( const List bins,
const List l 
)

Construct given bin values and input list.

Definition at line 71 of file Histogram.C.

Histogram ( const typename List::const_reference  min,
const typename List::const_reference  max,
const label  nBins,
const List l 
)

Construct given min, max, number of bins and input list.

Definition at line 79 of file Histogram.C.

References Foam::max(), and Foam::min().


Member Function Documentation

const labelList& counts ( ) const
inline

Return the counts per bin.

Definition at line 96 of file Histogram.H.

label nLow ( ) const
inline

Return the number of elements <= bins[0].

(so inclusive lowest bin value)

Definition at line 103 of file Histogram.H.

label nHigh ( ) const
inline

Return the number of elements > bins[bins.size()-1].

(so exclusive highest bin value)

Definition at line 110 of file Histogram.H.


The documentation for this class was generated from the following files: