Accumulating histogram of values. Specified bin resolution automatic generation of bins. More...
Public Member Functions | |
TypeName ("distribution") | |
Runtime type information. More... | |
distribution () | |
Construct null. More... | |
distribution (const scalar binWidth) | |
Construct from binWidth. More... | |
distribution (const distribution &) | |
Copy constructor. 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 (const label size=128) | |
Construct given initial size. More... | |
Map (Istream &is) | |
Construct from Istream. More... | |
Map (const Map< label > &map) | |
Copy constructor. More... | |
Map (Map< label > &&map) | |
Move constructor. More... | |
Map (HashTable< label, label, Hash< label >> &&map) | |
Move constructor. More... | |
Map (std::initializer_list< Tuple2< label, label >> map) | |
Construct from an initializer list. More... | |
void | operator= (const Map< label > &map) |
void | operator= (Map< label > &&map) |
Public Member Functions inherited from HashTable< T, Key, Hash > | |
HashTable (const label size=128) | |
Construct given initial table size. More... | |
HashTable (Istream &, const label size=128) | |
Construct from Istream. More... | |
HashTable (const HashTable< T, Key, Hash > &) | |
Copy constructor. More... | |
HashTable (HashTable< T, Key, Hash > &&) | |
Move constructor. More... | |
HashTable (std::initializer_list< Tuple2< Key, T >>) | |
Construct from an initializer list. More... | |
~HashTable () | |
Destructor. More... | |
label | capacity () const |
The size of the underlying table. More... | |
label | size () const |
Return number of elements in table. More... | |
bool | empty () const |
Return true if the hash table is empty. More... | |
bool | found (const Key &) const |
Return true if hashedEntry is found in table. More... | |
iterator | find (const Key &) |
Find and return an iterator set at the hashedEntry. More... | |
const_iterator | find (const Key &) const |
Find and return an const_iterator set at the hashedEntry. More... | |
List< Key > | toc () const |
Return the table of contents. More... | |
List< Key > | sortedToc () const |
Return the table of contents as a sorted list. More... | |
Ostream & | printInfo (Ostream &) const |
Print information. More... | |
bool | insert (const Key &, const T &newElmt) |
Insert a new hashedEntry. More... | |
bool | set (const Key &, const T &newElmt) |
Assign a new hashedEntry, overwriting existing entries. More... | |
bool | erase (const iterator &) |
Erase a hashedEntry specified by given iterator. More... | |
bool | erase (const Key &) |
Erase a hashedEntry specified by the given key. More... | |
label | erase (const UList< Key > &) |
Remove entries given by the listed keys from this HashTable. More... | |
template<class AnyType , class AnyHash > | |
label | erase (const HashTable< AnyType, Key, AnyHash > &) |
Remove entries given by the given keys from this HashTable. More... | |
void | resize (const label newSize) |
Resize the hash table for efficiency. More... | |
void | clear () |
Clear all entries from table. More... | |
void | clearStorage () |
Clear the table entries and the table itself. More... | |
void | shrink () |
Shrink the allocated table to approx. twice number of elements. More... | |
void | transfer (HashTable< T, Key, Hash > &) |
Transfer the contents of the argument table into this table. More... | |
T & | operator[] (const Key &) |
Find and return a hashedEntry. More... | |
const T & | operator[] (const Key &) const |
Find and return a hashedEntry. More... | |
T & | operator() (const Key &) |
Find and return a hashedEntry, create it null if not present. More... | |
void | operator= (const HashTable< T, Key, Hash > &) |
Assignment operator. More... | |
void | operator= (HashTable< T, Key, Hash > &&) |
Move assignment operator. More... | |
void | operator= (std::initializer_list< Tuple2< Key, T >>) |
Assignment to an initializer list. More... | |
bool | operator== (const HashTable< T, Key, Hash > &) const |
Equality. Hash tables are equal if the keys and values are equal. More... | |
bool | operator!= (const HashTable< T, Key, Hash > &) const |
The opposite of the equality operation. Takes linear time. More... | |
iterator | begin () |
Iterator set to the beginning of the HashTable. More... | |
const_iterator | cbegin () const |
const_iterator set to the beginning of the HashTable More... | |
const_iterator | begin () const |
const_iterator set to the beginning of the HashTable More... | |
template<class AnyType , class AnyHash > | |
Foam::label | erase (const HashTable< AnyType, Key, AnyHash > &rhs) |
Public Member Functions inherited from HashTableCore | |
HashTableCore () | |
Construct null. More... | |
ClassName ("HashTable") | |
Define template name and debug. 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) |
Return a canonical (power-of-two) size. More... | |
static iteratorEnd | cend () |
iteratorEnd set to beyond the end of any HashTable More... | |
static iteratorEnd | end () |
iteratorEnd set to beyond the end of any HashTable More... | |
Friends | |
Ostream & | operator<< (Ostream &, const distribution &) |
Additional Inherited Members | |
Public Types inherited from Map< label > | |
typedef HashTable< label, label, Hash< label > >::iterator | iterator |
typedef HashTable< label, label, Hash< label > >::const_iterator | const_iterator |
Public Types inherited from HashTable< T, Key, Hash > | |
typedef T | value_type |
Type of values the HashTable contains. More... | |
typedef T & | reference |
Type that can be used for storing into HashTable::value_type. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant. More... | |
typedef label | size_type |
The type that can represent the size of a HashTable. More... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable table size. More... | |
Accumulating histogram of values. Specified bin resolution automatic generation of bins.
Definition at line 58 of file distribution.H.
distribution | ( | ) |
Construct null.
Definition at line 55 of file distribution.C.
distribution | ( | const scalar | binWidth | ) |
Construct from binWidth.
Definition at line 62 of file distribution.C.
distribution | ( | const distribution & | d | ) |
Copy constructor.
Definition at line 69 of file distribution.C.
|
virtual |
Destructor.
Definition at line 78 of file distribution.C.
TypeName | ( | "distribution" | ) |
Runtime type information.
Foam::label totalEntries | ( | ) | const |
Definition at line 84 of file distribution.C.
References Foam::endl(), forAllConstIter(), and WarningInFunction.
Foam::scalar approxTotalEntries | ( | ) | const |
Definition at line 112 of file distribution.C.
References forAllConstIter().
Referenced by distribution::mean(), and distribution::normalised().
Foam::scalar mean | ( | ) | const |
Definition at line 125 of file distribution.C.
References distribution::approxTotalEntries(), forAll, k, and HashTable< T, Key, Hash >::toc().
Referenced by distribution::normalisedMinusMean().
Foam::scalar median | ( | ) |
Definition at line 148 of file distribution.C.
References UList< T >::first(), forAll, distribution::normalised(), and List< T >::size().
void add | ( | const scalar | valueToAdd | ) |
Add a value to the appropriate bin of the distribution.
Definition at line 212 of file distribution.C.
References Foam::abort(), HashTable< T, Key, Hash >::begin(), HashTableCore::end(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::find(), HashTable< T, Key, Hash >::insert(), n, and Foam::neg().
Referenced by distribution::add().
void add | ( | const label | valueToAdd | ) |
Definition at line 242 of file distribution.C.
References distribution::add().
void insertMissingKeys | ( | ) |
Definition at line 248 of file distribution.C.
References HashTable< T, Key, Hash >::begin(), HashTableCore::end(), HashTable< T, Key, Hash >::find(), HashTable< T, Key, Hash >::insert(), k, UList< T >::last(), List< T >::size(), Foam::sort(), and HashTable< T, Key, Hash >::toc().
Referenced by distribution::normalised(), and distribution::raw().
Foam::List< Foam::Pair< Foam::scalar > > normalised | ( | ) |
Definition at line 271 of file distribution.C.
References distribution::approxTotalEntries(), Foam::endl(), UList< T >::first(), forAll, Foam::Info, distribution::insertMissingKeys(), k, HashTable< T, Key, Hash >::size(), Foam::sort(), and HashTable< T, Key, Hash >::toc().
Referenced by distribution::median(), and distribution::normalisedShifted().
Foam::List< Foam::Pair< Foam::scalar > > normalisedMinusMean | ( | ) |
Definition at line 301 of file distribution.C.
References distribution::mean(), and distribution::normalisedShifted().
Foam::List< Foam::Pair< Foam::scalar > > normalisedShifted | ( | scalar | shiftValue | ) |
Definition at line 308 of file distribution.C.
References Foam::endl(), UList< T >::first(), forAll, Foam::Info, Foam::nl, distribution::normalised(), Foam::sign(), and List< T >::size().
Referenced by distribution::normalisedMinusMean().
Foam::List< Foam::Pair< Foam::scalar > > raw | ( | ) |
Definition at line 419 of file distribution.C.
References UList< T >::first(), forAll, distribution::insertMissingKeys(), k, HashTable< T, Key, Hash >::size(), Foam::sort(), and HashTable< T, Key, Hash >::toc().
|
inline |
Definition at line 28 of file distributionI.H.
Referenced by distribution::operator=().
void operator= | ( | const distribution & | rhs | ) |
Definition at line 444 of file distribution.C.
References Foam::abort(), distribution::binWidth(), Foam::FatalError, FatalErrorInFunction, and Map< T >::operator=().
|
friend |