distribution Class Reference

Inheritance diagram for distribution:

[legend]

Collaboration diagram for distribution:

[legend]

List of all members.

Public Member Functions
	distribution ()
	Construct null.
	distribution (const scalar binWidth)
	Construct from binWidth.
	distribution (const distribution &)
	Construct as copy.
	~distribution ()
label	totalEntries () const
scalar	approxTotalEntries () const
scalar	mean () const
scalar	median ()
void	add (const scalar valueToAdd)
	Add a value to the appropriate bin of the distribution.
void	add (const label valueToAdd)
void	insertMissingKeys ()
List< Pair< scalar > >	normalised ()
List< Pair< scalar > >	normalisedMinusMean ()
List< Pair< scalar > >	normalisedShifted (const scalar shiftValue)
List< Pair< scalar > >	raw ()
scalar	binWidth () const
void	operator= (const distribution &)
Friends
Ostream &	operator<< (Ostream &, const distribution &)

---

Detailed Description

Source files

• distribution.H
• distributionI.H
• distribution.C

Definition at line 45 of file distribution.H.

---

Constructor & Destructor Documentation

distribution

(

)

Construct null.

Definition at line 25 of file distribution.C.

distribution

(

const scalar

binWidth

)

Construct from binWidth.

Definition at line 32 of file distribution.C.

distribution

(

const distribution &

d

)

Construct as copy.

Definition at line 39 of file distribution.C.

~distribution

(

)

Definition at line 48 of file distribution.C.

---

Member Function Documentation

label totalEntries

(

)

const

Definition at line 54 of file distribution.C.

scalar approxTotalEntries

(

)

const

Definition at line 82 of file distribution.C.

scalar mean

(

)

const

Definition at line 95 of file distribution.C.

scalar median

(

)

Definition at line 118 of file distribution.C.

void add

(

const scalar

valueToAdd

)

Add a value to the appropriate bin of the distribution.

Definition at line 182 of file distribution.C.

void add

(

const label

valueToAdd

)

Definition at line 212 of file distribution.C.

void insertMissingKeys

(

)

Definition at line 218 of file distribution.C.

List< Pair< scalar > > normalised

(

)

Definition at line 241 of file distribution.C.

References HashTable< label, label, Hash< label > >::insert(), and k().

Here is the call graph for this function:

List< Pair< scalar > > normalisedMinusMean

(

)

Definition at line 266 of file distribution.C.

List< Pair< scalar > > normalisedShifted

(

const scalar

shiftValue

)

Definition at line 272 of file distribution.C.

List< Pair< scalar > > raw

(

)

Definition at line 375 of file distribution.C.

Foam::scalar binWidth

(

)

const [inline]

Definition at line 20 of file distributionI.H.

void operator=

(

const distribution &

rhs

)

Definition at line 400 of file distribution.C.

---

Friends And Related Function Documentation

Ostream& operator<<	(	Ostream &	os,
		const distribution &	d
	)			[friend]

Definition at line 418 of file distribution.C.

---

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

• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.H
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distribution.C
• src/lagrangian/molecularDynamics/molecularMeasurements/distribution/distributionI.H