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 &) | |
| 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 () | |
| Default construct with default table capacity. More... | |
| Map (const label size) | |
| Construct with given initial table capacity. More... | |
| Map (Istream &is) | |
| Construct from Istream with default table capacity. More... | |
| Map (const this_type &map) | |
| Copy construct. More... | |
| Map (this_type &&map) | |
| Move construct. More... | |
| Map (std::initializer_list< std::pair< label, label > > map) | |
| Construct from an initializer list. 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 () | |
| Default construct with default (128) table capacity. More... | |
| HashTable (const label size) | |
| Construct given initial table capacity. More... | |
| HashTable (Istream &is, const label size=128) | |
| Construct from Istream with default table capacity. More... | |
| HashTable (const this_type &ht) | |
| Copy construct. More... | |
| HashTable (this_type &&rhs) | |
| Move construct. More... | |
| HashTable (std::initializer_list< std::pair< Key, T > > list) | |
| Construct from an initializer list. More... | |
| ~HashTable () | |
| Destructor. More... | |
| label | capacity () const noexcept |
| The size of the underlying table. More... | |
| label | size () const noexcept |
| The number of elements in table. More... | |
| bool | empty () const noexcept |
| True if the hash table is empty. 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 | found (const Key &key) const |
| Return true if hashed entry is 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 |
| template<class UnaryPredicate > | |
| List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| template<class UnaryPredicate > | |
| List< Key > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| template<class BinaryPredicate > | |
| List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| UPtrList< const node_type > | csorted () const |
| UPtrList< const node_type > | sorted () const |
| UPtrList< node_type > | sorted () |
| 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 | resize (const label sz) |
| 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 | swap (HashTable< T, Key, Hash > &rhs) |
| Swap contents into this table. More... | |
| void | transfer (HashTable< T, Key, Hash > &rhs) |
| Transfer contents into this table. 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 |
| 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 |
| 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 ()=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< zero::null, typenamestd::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type | node_type |
| 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... | |
| Protected Member Functions inherited from HashTable< T, Key, Hash > | |
| bool | iterator_erase (node_type *&entry, label &index) |
| Low-level entry erasure using iterator internals. More... | |
Accumulating histogram of values. Specified bin resolution automatic generation of bins.
Definition at line 61 of file distribution.H.
| distribution | ( | ) |
Construct null.
Definition at line 58 of file distribution.C.
| distribution | ( | const scalar | binWidth | ) |
Construct from binWidth.
Definition at line 65 of file distribution.C.
| distribution | ( | const distribution & | d | ) |
Construct as copy.
Definition at line 72 of file distribution.C.
|
virtual |
Destructor.
Definition at line 81 of file distribution.C.
| TypeName | ( | "distribution" | ) |
Runtime type information.
Write to file.
Definition at line 41 of file distribution.C.
References forAll, Foam::nl, and os().
| Foam::label totalEntries | ( | ) | const |
Definition at line 87 of file distribution.C.
References Foam::endl(), forAllConstIters, and WarningInFunction.
| Foam::scalar approxTotalEntries | ( | ) | const |
Definition at line 115 of file distribution.C.
References forAllConstIters.
| Foam::scalar mean | ( | ) | const |
Definition at line 128 of file distribution.C.
| Foam::scalar median | ( | ) |
Definition at line 151 of file distribution.C.
References UList< T >::first(), forAll, Foam::normalised(), and UList< T >::size().
| void add | ( | const scalar | valueToAdd | ) |
Add a value to the appropriate bin of the distribution.
Definition at line 215 of file distribution.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, insert(), n, and Foam::neg().
| void add | ( | const label | valueToAdd | ) |
Definition at line 245 of file distribution.C.
References Foam::add().
| void insertMissingKeys | ( | ) |
Definition at line 251 of file distribution.C.
References insert(), k, UList< T >::last(), and UList< T >::size().
| Foam::List< Foam::Pair< Foam::scalar > > normalised | ( | ) |
Definition at line 266 of file distribution.C.
References Foam::endl(), UList< T >::first(), forAll, Foam::Info, and k.
| Foam::List< Foam::Pair< Foam::scalar > > normalisedMinusMean | ( | ) |
Definition at line 293 of file distribution.C.
| Foam::List< Foam::Pair< Foam::scalar > > normalisedShifted | ( | scalar | shiftValue | ) |
Definition at line 299 of file distribution.C.
References Foam::endl(), UList< T >::first(), forAll, Foam::Info, Foam::nl, Foam::normalised(), Foam::sign(), and UList< T >::size().
| Foam::List< Foam::Pair< Foam::scalar > > raw | ( | ) |
Definition at line 411 of file distribution.C.
References UList< T >::first(), forAll, and k.
|
inline |
Definition at line 30 of file distributionI.H.
Referenced by distribution::operator=().
| void operator= | ( | const distribution & | rhs | ) |
Definition at line 433 of file distribution.C.
References distribution::binWidth(), and Map< T >::operator=().
|
friend |
1.9.5 