Public Member Functions | List of all members
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...
 
 Histogram (const Histogram &)=delete
 Disallow default bitwise copy construction. More...
 
const labelList & counts () 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...
 
void operator= (const Histogram &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

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

Calculates the counts per bin of a list.

Source files

Definition at line 50 of file Histogram.H.

Constructor & Destructor Documentation

◆ Histogram() [1/3]

Histogram ( const List &  bins,
const List &  l 
)

Construct given bin values and input list.

Definition at line 71 of file Histogram.C.

References Foam::count().

Here is the call graph for this function:

◆ Histogram() [2/3]

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

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

Here is the call graph for this function:

◆ Histogram() [3/3]

Histogram ( const Histogram< List > &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ counts()

const labelList& counts ( ) const
inline

Return the counts per bin.

Definition at line 92 of file Histogram.H.

◆ nLow()

label nLow ( ) const
inline

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

(so inclusive lowest bin value)

Definition at line 99 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 106 of file Histogram.H.

◆ operator=()

void operator= ( const Histogram< List > &  )
delete

Disallow default bitwise assignment.

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