Histogram< List > Class Template Reference

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

#include <Histogram.H>

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 labelList &	counts () 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].

Detailed Description

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

Calculates the counts per bin of a list.

Source files

• Histogram.H
• Histogram.C

Definition at line 48 of file Histogram.H.

Constructor & Destructor Documentation

Histogram() [1/2]

template<class List>

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

Construct given bin values and input list.

Definition at line 66 of file Histogram.C.

Histogram() [2/2]

template<class 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.

Definition at line 73 of file Histogram.C.

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

Here is the call graph for this function:

Member Function Documentation

counts()

template<class List>

const labelList & counts ( ) const

inline

Return the counts per bin.

Definition at line 109 of file Histogram.H.

nLow()

template<class List>

label nLow ( ) const

inline

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

(so inclusive lowest bin value)

Definition at line 119 of file Histogram.H.

nHigh()

template<class List>

label nHigh ( ) const

inline

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

(so exclusive highest bin value)

Definition at line 129 of file Histogram.H.

---

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

• src/OpenFOAM/containers/Lists/Histogram/Histogram.H
• src/OpenFOAM/containers/Lists/Histogram/Histogram.C