Histogram< List > Class Template Reference

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

Public Member Functions

 Histogram (const List &bins, const List &l)
 Construct given bin values and input list. More...
 
 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. More...
 
const labelListcounts () const
 Return the counts per bin. More...
 
label nLow () const
 Return the number of elements <= bins[0]. More...
 
label nHigh () const
 Return the number of elements > bins[bins.size()-1]. More...
 

Detailed Description

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

Calculates the counts per bin of a list.

Source files

Definition at line 52 of file Histogram.H.

Constructor & Destructor Documentation

◆ Histogram() [1/2]

Histogram ( const List bins,
const List l 
)

Construct given bin values and input list.

Definition at line 73 of file Histogram.C.

◆ Histogram() [2/2]

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 80 of file Histogram.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ counts()

const labelList & counts ( ) const
inline

Return the counts per bin.

Definition at line 97 of file Histogram.H.

◆ nLow()

label nLow ( ) const
inline

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

(so inclusive lowest bin value)

Definition at line 104 of file Histogram.H.

◆ nHigh()

label nHigh ( ) const
inline

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

(so exclusive highest bin value)

Definition at line 111 of file Histogram.H.


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