Accumulating histogram of values. Specified bin resolution automatic generation of bins. More...

Inheritance diagram for distribution:

Collaboration diagram for distribution:

Public Member Functions
	TypeName ("distribution")
	Runtime type information. More...

	distribution ()
	Construct null. More...

	distribution (const scalar binWidth)
	Construct from binWidth. More...

	distribution (const distribution &)
	Construct as copy. More...

virtual	~distribution ()
	Destructor. More...

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. More...

void	add (const label valueToAdd)

void	insertMissingKeys ()

List< Pair< scalar > >	normalised ()

List< Pair< scalar > >	normalisedMinusMean ()

List< Pair< scalar > >	normalisedShifted (scalar shiftValue)

List< Pair< scalar > >	raw ()

scalar	binWidth () const

void	operator= (const distribution &)

Public Member Functions inherited from Map< label >
	Map () noexcept=default
	Default construct: empty without allocation (capacity=0) More...

	Map (const Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	Map (const label initialCapacity)
	Construct empty with given initial table capacity. More...

	Map (Istream &is)
	Construct from Istream (with default initial table capacity) More...

	Map (const this_type &map)
	Copy construct. More...

	Map (this_type &&map) noexcept
	Move construct. More...

	Map (std::initializer_list< std::pair< label, label >> map)
	Construct from pairs of values. More...

void	operator= (const this_type &rhs)
	Copy assignment. More...

void	operator= (this_type &&rhs)
	Move assignment. More...

Public Member Functions inherited from HashTable< T, Key, Hash >
	HashTable () noexcept
	Default construct: empty without allocation (capacity=0) More...

	HashTable (const Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	HashTable (const label initialCapacity)
	Construct empty with initial table capacity. More...

	HashTable (Istream &is)
	Construct from Istream. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs) noexcept
	Move construct. More...

	HashTable (std::initializer_list< std::pair< Key, T >> list)
	Construct from an initializer list. More...

	~HashTable ()
	Destructor. More...

bool	empty () const noexcept
	True if the hash table is empty. More...

label	size () const noexcept
	The number of elements in table. More...

label	capacity () const noexcept
	The size of the underlying table (the number of buckets) More...

T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	contains (const Key &key) const
	True if hashed key is contained (found) in table. More...

iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< Key >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

template<class Compare >
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator. More...

template<class UnaryPredicate >
List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the keys. More...

template<class UnaryPredicate >
List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the values. More...

template<class BinaryPredicate >
List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More...

UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys). More...

UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys). More...

template<class UnaryPredicate >
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...

template<class UnaryPredicate >
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...

template<class BinaryPredicate >
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...

template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries. More...

bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries. More...

bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries. More...

bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries. More...

bool	set (const Key &key, T &&obj)
	Move assign a new entry, overwriting existing entries. More...

bool	erase (const iterator &iter)
	Erase an entry specified by given iterator. More...

bool	erase (const Key &key)
	Erase an entry specified by the given key. More...

template<class AnyType , class AnyHash >
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table. More...

label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys. More...

template<class InputIter >
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...

template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys. More...

label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys. More...

template<class AnyType , class AnyHash >
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

template<class UnaryPredicate >
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...

template<class UnaryPredicate >
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...

template<class BinaryPredicate >
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...

void	clear ()
	Remove all entries from table. More...

void	clearStorage ()
	Remove all entries from table and the table itself. More...

void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets). More...

void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...

void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...

void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table. More...

void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table. More...

void	merge (HashTable< T, Key, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	merge (HashTable< T, Key, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

T &	operator() (const Key &key)
	Return existing entry or create a new entry. More...

T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry. More...

void	operator= (const this_type &rhs)
	Copy assign. More...

void	operator= (std::initializer_list< std::pair< Key, T >> rhs)
	Copy assign from an initializer list. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable. More...

const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys. More...

iterator	begin ()
	iterator set to the beginning of the HashTable More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

iterator	end () noexcept
	iterator to signal the end (for any HashTable) More...

const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable) More...

constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable) More...

Ostream &	printInfo (Ostream &os) const
	Print information. More...

Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen. More...

bool	found (const Key &key) const
	Same as contains() More...

UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

template<class Compare >
Foam::List< Key >	sortedToc (const Compare &comp) const

template<class UnaryPredicate >
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

template<class InputIter>
Foam::label	erase (InputIter first, InputIter last)

template<unsigned N>
Foam::label	erase (const FixedList< Key, N > &keys)

template<class AnyType, class AnyHash >
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)

template<class AnyType , class AnyHash >
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)

template<class UnaryPredicate >
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

template<class UnaryPredicate >
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

template<class BinaryPredicate >
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

Public Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch) More...

	HashTableCore () noexcept=default
	Default construct. More...

Static Public Member Functions
static void	write (const fileName &file, const List< Pair< scalar >> &pairs)
	Write to file. More...

Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label requested_size)
	Return a canonical (power-of-two) of the requested size. More...

Friends
Ostream &	operator<< (Ostream &, const distribution &)

Additional Inherited Members
Public Types inherited from Map< label >
typedef Map< label >	this_type
	The template instance used for this Map. More...

typedef HashTable< label, label, Hash< label > >	parent_type
	The template instance used for the parent HashTable. More...

using	iterator = typename parent_type::iterator

using	const_iterator = typename parent_type::const_iterator

Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable. More...

typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...

typedef Key	key_type
	The second template parameter, type of keys used. More...

typedef T	mapped_type
	The first template parameter, type of objects contained. More...

typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Hash	hasher
	The third template parameter, the hash index method. More...

typedef T *	pointer
	Pointer type for storing into value_type objects. More...

typedef T &	reference
	Reference to the stored value_type. More...

typedef const T *	const_pointer
	Const pointer type for the stored value_type. More...

typedef const T &	const_reference
	Const reference to the stored value_type. More...

typedef label	difference_type
	The type to represent the difference between two iterators. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

using	key_iterator = key_iterator_base< iterator >
	Forward iterator returning the key. More...

using	const_key_iterator = key_iterator_base< const_iterator >
	Forward const iterator returning the key. More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable internal table size. Approximately labelMax/4. More...

Detailed Description

Accumulating histogram of values. Specified bin resolution automatic generation of bins.

Source files

Definition at line 57 of file distribution.H.

Constructor & Destructor Documentation

◆ distribution() [1/3]

distribution ( )

Construct null.

Definition at line 51 of file distribution.C.

◆ distribution() [2/3]

distribution ( const scalar binWidth )

Construct from binWidth.

Definition at line 58 of file distribution.C.

◆ distribution() [3/3]

distribution ( const distribution & d )

Construct as copy.

Definition at line 65 of file distribution.C.

◆ ~distribution()

~distribution ( )

virtual

Destructor.

Definition at line 74 of file distribution.C.

Member Function Documentation

◆ TypeName()

TypeName ( "distribution" )

Runtime type information.

◆ write()

void write	(	const fileName &	file,
		const List< Pair< scalar >> &	pairs
	)

static

Write to file.

Definition at line 35 of file distribution.C.

References forAll, Foam::nl, and os().

Here is the call graph for this function:

◆ totalEntries()

Foam::label totalEntries ( ) const

Definition at line 80 of file distribution.C.

References Foam::endl(), forAllConstIters(), and WarningInFunction.

Here is the call graph for this function:

◆ approxTotalEntries()

Foam::scalar approxTotalEntries ( ) const

Definition at line 108 of file distribution.C.

References forAllConstIters().

Here is the call graph for this function:

◆ mean()

Foam::scalar mean ( ) const

Definition at line 121 of file distribution.C.

References forAll, k, Foam::glTF::key(), and Foam::BitOps::toc().

Here is the call graph for this function:

◆ median()

Foam::scalar median ( )

Definition at line 144 of file distribution.C.

References UList< T >::first(), forAll, Foam::normalised(), and UList< T >::size().

Here is the call graph for this function:

◆ add() [1/2]

void add ( const scalar valueToAdd )

Add a value to the appropriate bin of the distribution.

Definition at line 208 of file distribution.C.

References Foam::abort(), stdFoam::begin(), stdFoam::end(), Foam::FatalError, FatalErrorInFunction, Foam::ListOps::find(), insert(), n, and Foam::neg().

Here is the call graph for this function:

◆ add() [2/2]

void add ( const label valueToAdd )

Definition at line 238 of file distribution.C.

References Foam::add().

Here is the call graph for this function:

◆ insertMissingKeys()

void insertMissingKeys ( )

Definition at line 244 of file distribution.C.

References insert(), k, UList< T >::last(), UList< T >::size(), and Foam::BitOps::sortedToc().

Here is the call graph for this function:

◆ normalised()

Foam::List< Foam::Pair< Foam::scalar > > normalised ( )

Definition at line 259 of file distribution.C.

References Foam::ensightOutput::debug, Foam::endl(), UList< T >::first(), forAll, Foam::Info, k, Foam::glTF::key(), and Foam::BitOps::sortedToc().

Here is the call graph for this function:

◆ normalisedMinusMean()

Foam::List< Foam::Pair< Foam::scalar > > normalisedMinusMean ( )

Definition at line 286 of file distribution.C.

◆ normalisedShifted()

Foam::List< Foam::Pair< Foam::scalar > > normalisedShifted ( scalar shiftValue )

Definition at line 293 of file distribution.C.

References Foam::ensightOutput::debug, Foam::endl(), UList< T >::first(), forAll, Foam::Info, Foam::nl, Foam::normalised(), Foam::sign(), and UList< T >::size().

Here is the call graph for this function:

◆ raw()

Foam::List< Foam::Pair< Foam::scalar > > raw ( )

Definition at line 404 of file distribution.C.

References UList< T >::first(), forAll, k, Foam::glTF::key(), and Foam::BitOps::sortedToc().

Here is the call graph for this function:

◆ binWidth()

Foam::scalar binWidth ( ) const

inline

Definition at line 23 of file distributionI.H.

Referenced by distribution::operator=().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const distribution & rhs )

Definition at line 426 of file distribution.C.

References distribution::binWidth(), and Map< T >::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const distribution &
	)

friend

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ distribution() [1/3]

◆ distribution() [2/3]

◆ distribution() [3/3]

◆ ~distribution()

Member Function Documentation

◆ TypeName()

◆ write()

◆ totalEntries()

◆ approxTotalEntries()

◆ mean()

◆ median()

◆ add() [1/2]

◆ add() [2/2]

◆ insertMissingKeys()

◆ normalised()

◆ normalisedMinusMean()

◆ normalisedShifted()

◆ raw()

◆ binWidth()

◆ operator=()

Friends And Related Function Documentation

◆ operator<<