Accumulating histogram of component values. Specified bin resolution, automatic generation of bins. More...
#include <Distribution.H>
Public Types | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. | |
| Public Types inherited from List< List< scalar > > | |
| typedef SubList< T > | subList |
| Declare type of subList. | |
| Public Types inherited from UList< T > | |
| typedef T | value_type |
| The value type the list contains. | |
| typedef T * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const T * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef T & | reference |
| The type used for storing into value_type objects. | |
| typedef const T & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef T * | iterator |
| Random access iterator for traversing a UList. | |
| typedef const T * | const_iterator |
| Random access iterator for traversing a UList. | |
| typedef label | size_type |
| The type to represent the size of a UList. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access). | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access). | |
| using | is_List = void |
| Have unique tag. | |
Public Member Functions | |
| Distribution () | |
| Construct null. | |
| Distribution (const Type &binWidth) | |
| Construct from separate binWidth for each component. | |
| Distribution (const Distribution &d) | |
| Construct as copy. | |
| ~Distribution () | |
| Destructor. | |
| scalar | totalWeight (direction cmpt) const |
| Sum the total weight added to the component in the. | |
| List< label > | keys (direction cmpt) const |
| label | index (direction cmpt, label n) |
| Return the appropriate List index for the given bin index. | |
| Pair< label > | validLimits (direction cmpt) const |
| Returns the indices of the first and last non-zero entries. | |
| Type | mean () const |
| Type | median () const |
| void | add (const Type &valueToAdd, const Type &weight=pTraits< Type >::one) |
| Add a value to the distribution, optionally specifying a weight. | |
| List< List< Pair< scalar > > > | normalised () const |
| Return the normalised distribution (probability density). | |
| List< List< Pair< scalar > > > | raw () const |
| Return the distribution of the total bin weights. | |
| List< List< Pair< scalar > > > | cumulativeNormalised () const |
| Return the cumulative normalised distribution and. | |
| List< List< Pair< scalar > > > | cumulativeRaw () const |
| Return the cumulative total bin weights and integration. | |
| void | clear () |
| Resets the Distribution by clearing the stored lists. | |
| const Type & | binWidth () const |
| Return the bin width. | |
| const List< label > & | listStarts () const |
| Return the List start bin indices. | |
| void | write (const fileName &filePrefix) const |
| Write the distribution to file: key normalised raw. | |
| void | operator= (const Distribution< Type > &) |
| Public Member Functions inherited from List< List< scalar > > | |
| void | resize (const label len) |
| autoPtr< List< T > > | clone () const |
| Clone. | |
| ~List () | |
| Destructor. | |
| void | clear () |
| Clear the list, i.e. set size to zero. | |
| void | resize_copy (label count, const label len) |
| Change allocated size of list, retaining the first count elements. | |
| void | resize_fill (const label len, const List< scalar > &val) |
| Adjust allocated size of list and set val for all elements. | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. | |
| void | transfer (List< T > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| List< scalar > & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. | |
| List< scalar > & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. | |
| void | push_back (const List< scalar > &val) |
| Append an element at the end of the list. | |
| label | push_uniq (const List< scalar > &val) |
| Append an element if not already in the list. | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. | |
| void | operator= (const UList< T > &list) |
| Assignment to UList operator. Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. | |
| void | shallowCopy (const UList< T > &)=delete |
| No shallowCopy permitted. | |
| bool | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. | |
| void | append (const List< scalar > &val) |
| Append an element at the end of the list. | |
| label | appendUniq (const List< scalar > &val) |
| Same as push_uniq(). | |
| void | setSize (label n) |
| Alias for resize(). | |
| Public Member Functions inherited from UList< T > | |
| UList (const UList< T > &) noexcept=default | |
| Copy construct, shallow copy. | |
| UList (UList< T > &&) noexcept=default | |
| Move construct, shallow copy. | |
| UList< T > & | operator= (const UList< T > &)=delete |
| No copy assignment (default: shallow copy). | |
| UList< T > & | operator= (UList< T > &&) noexcept=default |
| Move assignment, shallow copy. | |
| constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. | |
| UList (T *__restrict__ ptr, const label len) noexcept | |
| Construct from components. | |
| UList (SubList< T > &&) noexcept | |
| Move construct from a SubList, shallow copy. | |
| label | fcIndex (const label i) const noexcept |
| The forward circular index. The next index in the list which returns to the first at the end of the list. | |
| label | rcIndex (const label i) const noexcept |
| The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. | |
| const T & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| T & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list). | |
| const T & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| T & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list). | |
| const T * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| T * | data () noexcept |
| Return pointer to the underlying array serving as data storage. | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| T & | front () |
| Access first element of the list, position [0]. | |
| const T & | front () const |
| Access first element of the list. | |
| T & | back () |
| Access last element of the list, position [size()-1]. | |
| const T & | back () const |
| Access last element of the list, position [size()-1]. | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const T &val) const |
| True if the value is contained in the list. | |
| bool | contains (const T &val, label pos, label len=-1) const |
| Is the value contained in the list? | |
| label | find (const T &val) const |
| Find index of the first occurrence of the value. | |
| label | find (const T &val, label pos, label len=-1) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const T &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | moveFirst (const label i) |
| Move element to the first position. | |
| void | moveLast (const label i) |
| Move element to the last position. | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. | |
| void | shallowCopy (T *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. | |
| void | shallowCopy (std::nullptr_t) noexcept |
| Copy nullptr and zero size. | |
| void | shallowCopy (const UList< T > &list) noexcept |
| Copy the pointer and size held by the given UList. | |
| void | deepCopy (const UList< T > &list) |
| Copy elements of the given UList. Sizes must match! | |
| template<class Addr> | |
| void | deepCopy (const IndirectListBase< T, Addr > &list) |
| Copy elements of the given indirect list. Sizes must match! | |
| SubList< T > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. | |
| const SubList< T > | slice (const label pos, label len=-1) const |
| Return SubList slice (const access) - no range checking. | |
| SubList< T > | slice (const labelRange &range) |
| Return SubList slice (non-const access) - with range checking. | |
| const SubList< T > | slice (const labelRange &range) const |
| Return SubList slice (const access) - with range checking. | |
| T & | operator[] (const label i) |
| Return element of UList. | |
| const T & | operator[] (const label i) const |
| Return element of constant UList. | |
| operator const Foam::List< T > & () const | |
| Allow cast to a const List<T>&. | |
| void | operator= (const T &val) |
| Assignment of all entries to the given value. | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. | |
| iterator | begin (const label i) noexcept |
| Return iterator at offset i from begin, clamped to [0,size] range. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | end () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| const_iterator | cbegin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. | |
| const_iterator | begin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero). | |
| label | size () const noexcept |
| The number of elements in the container. | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| void | swap (UList< T > &list) noexcept |
| Swap content with another UList of the same type in constant time. | |
| bool | operator== (const UList< T > &list) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UList< T > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const UList< T > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator> (const UList< T > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator<= (const UList< T > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const UList< T > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the List as a dictionary entry with keyword. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | all () const |
| True if all entries are 'true' or if the list is empty. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | any () const |
| True if any entries are 'true'. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | none () const |
| True if no entries are 'true'. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>> | |
| bool | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. | |
| template<class TypeT = T, class = std::enable_if_t<stdFoam::is_char_v<TypeT>>> | |
| std::string_view | view () const |
| Return a string_view of the charList. Content is non-modifiable. | |
| T & | first () |
| Access first element of the list, position [0]. | |
| const T & | first () const |
| Access first element of the list. | |
| T & | last () |
| Access last element of the list, position [size()-1]. | |
| const T & | last () const |
| Access last element of the list, position [size()-1]. | |
| bool | found (const T &val, label pos=0) const |
| Same as contains(). | |
| auto | expr () const |
| Wrap value as expression. | |
| template<typename E> | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
Friends | |
| Istream & | operator>> (Istream &, Distribution< Type > &) |
| Ostream & | operator<< (Ostream &, const Distribution< Type > &) |
Additional Inherited Members | |
| Static Public Member Functions inherited from List< List< scalar > > | |
| static const List< T > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. | |
| Protected Member Functions inherited from UList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. | |
| void | size (const label n) |
| Older name for setAddressableSize. | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. | |
| labelRange | validateRange (const labelRange &requestedRange) const |
| Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. | |
| void | fill_uniform (const T &val) |
| Assign all entries to the given value. | |
| void | fill_uniform (Foam::zero) |
| Assign all entries to zero. | |
Accumulating histogram of component values. Specified bin resolution, automatic generation of bins.
Definition at line 60 of file Distribution.H.
Component type.
Definition at line 82 of file Distribution.H.
| Distribution | ( | ) |
Construct null.
Definition at line 29 of file Distribution.C.
Referenced by Distribution(), operator<<, operator=(), and operator>>.
| Distribution | ( | const Type & | binWidth | ) |
Construct from separate binWidth for each component.
Definition at line 38 of file Distribution.C.
References binWidth().
| Distribution | ( | const Distribution< Type > & | d | ) |
| ~Distribution | ( | ) |
Destructor.
Definition at line 58 of file Distribution.C.
| Foam::scalar totalWeight | ( | direction | cmpt | ) | const |
Sum the total weight added to the component in the.
argument
Definition at line 65 of file Distribution.C.
References forAll.
Referenced by mean(), and normalised().
| Foam::List< Foam::label > keys | ( | direction | cmpt | ) | const |
Definition at line 81 of file Distribution.C.
References Foam::identity(), and UList< T >::size().
Referenced by mean(), normalised(), and raw().
| Foam::label index | ( | direction | cmpt, |
| label | n ) |
Return the appropriate List index for the given bin index.
Resizes the List if required
Definition at line 88 of file Distribution.C.
References UList< T >::empty(), forAll, index(), n, List< T >::setSize(), UList< T >::size(), and Foam::Zero.
Referenced by add(), and index().
| Foam::Pair< Foam::label > validLimits | ( | direction | cmpt | ) | const |
Returns the indices of the first and last non-zero entries.
Definition at line 154 of file Distribution.C.
References forAll, and limits.
Referenced by normalised(), and raw().
| Type mean | ( | ) | const |
Definition at line 186 of file Distribution.C.
References Foam::component(), forAll, k, keys(), Foam::setComponent(), totalWeight(), and Foam::Zero.
| Type median | ( | ) | const |
Definition at line 215 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, Foam::mag(), Foam::normalised(), Foam::setComponent(), UList< T >::size(), and Foam::Zero.
Add a value to the distribution, optionally specifying a weight.
Definition at line 301 of file Distribution.C.
References Foam::component(), index(), n, and Foam::neg().
| Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > normalised | ( | ) | const |
Return the normalised distribution (probability density).
and bins
Definition at line 324 of file Distribution.C.
References Foam::component(), UList< T >::empty(), UList< T >::first(), k, keys(), limits, List< T >::setSize(), totalWeight(), and validLimits().
| Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > raw | ( | ) | const |
Return the distribution of the total bin weights.
Definition at line 372 of file Distribution.C.
References Foam::component(), UList< T >::empty(), UList< T >::first(), k, keys(), limits, List< T >::setSize(), and validLimits().
Referenced by cumulativeRaw(), and write().
| Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > cumulativeNormalised | ( | ) | const |
Return the cumulative normalised distribution and.
integration locations (at end of bins)
Definition at line 414 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, Foam::normalised(), and Foam::sum().
Referenced by write().
| Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > cumulativeRaw | ( | ) | const |
Return the cumulative total bin weights and integration.
locations (at end of bins)
Definition at line 450 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, raw(), and Foam::sum().
Referenced by write().
| void clear | ( | ) |
Resets the Distribution by clearing the stored lists.
Leaves the same number of them and the same binWidth.
Definition at line 481 of file Distribution.C.
|
inline |
Return the bin width.
Definition at line 25 of file DistributionI.H.
Referenced by Distribution().
|
inline |
Return the List start bin indices.
Definition at line 33 of file DistributionI.H.
| void write | ( | const fileName & | filePrefix | ) | const |
Write the distribution to file: key normalised raw.
Produces a separate file for each component.
Definition at line 493 of file Distribution.C.
References cumulativeNormalised(), cumulativeRaw(), Foam::endl(), UList< T >::first(), forAll, Foam::nl, Foam::normalised(), os(), and raw().
| void operator= | ( | const Distribution< Type > & | rhs | ) |
Definition at line 549 of file Distribution.C.
References Distribution(), and Foam::rhs().
|
friend |
References Distribution().
|
friend |
References Distribution().
1.16.1 
