Accumulating histogram of component values. Specified bin resolution, automatic generation of bins. More...
Public Types | |
typedef pTraits< Type >::cmptType | cmptType |
Component type. More... | |
![]() | |
typedef SubList< List< scalar > > | subList |
Declare type of subList. More... | |
![]() | |
typedef T | value_type |
Type of values the UList contains. More... | |
typedef T & | reference |
Type that can be used for storing into. More... | |
typedef const T & | const_reference |
Type that can be used for storing into. More... | |
typedef label | difference_type |
The type that can represent the difference between any two. More... | |
typedef label | size_type |
The type that can represent the size of a UList. More... | |
typedef T * | iterator |
Random access iterator for traversing UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing UList. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of UList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. More... | |
Public Member Functions | |
Distribution () | |
Construct null. More... | |
Distribution (const Type &binWidth) | |
Construct from separate binWidth for each component. More... | |
Distribution (const Distribution &d) | |
Copy constructor. More... | |
Distribution (Distribution &&d) | |
Move constructor. More... | |
~Distribution () | |
Destructor. More... | |
scalar | totalWeight (direction cmpt) const |
Sum the total weight added to the component in the. More... | |
List< label > | keys (direction cmpt) const |
label | index (direction cmpt, label n) |
Return the appropriate List index for the given bin index. More... | |
Pair< label > | validLimits (direction cmpt) const |
Returns the indices of the first and last non-zero entries. More... | |
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. More... | |
List< List< Pair< scalar > > > | normalised () const |
Return the normalised distribution (probability density) More... | |
List< List< Pair< scalar > > > | raw () const |
Return the distribution of the total bin weights. More... | |
List< List< Pair< scalar > > > | cumulativeNormalised () const |
Return the cumulative normalised distribution and. More... | |
List< List< Pair< scalar > > > | cumulativeRaw () const |
Return the cumulative total bin weights and integration. More... | |
void | clear () |
Resets the Distribution by clearing the stored lists. More... | |
const Type & | binWidth () const |
Return the bin width. More... | |
const List< label > & | listStarts () const |
Return the List start bin indices. More... | |
void | write (const fileName &filePrefix) const |
Write the distribution to file: key normalised raw. More... | |
void | operator= (const Distribution< Type > &) |
void | operator= (Distribution< Type > &&) |
![]() | |
List () | |
Null constructor. More... | |
List (const label) | |
Construct with given size. More... | |
List (const label, const List< scalar > &) | |
Construct with given size and value for all elements. More... | |
List (const label, const zero) | |
Construct with given size initialising all elements to zero. More... | |
List (const List< List< scalar > > &) | |
Copy constructor. More... | |
List (const UList< T2 > &) | |
Copy constructor from list containing another type. More... | |
List (List< List< scalar > > &&) | |
Move constructor. More... | |
List (List< List< scalar > > &, bool reuse) | |
Construct as copy or reuse as specified. More... | |
List (const UList< List< scalar > > &, const labelUList &mapAddressing) | |
Construct as subset. More... | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. More... | |
List (const FixedList< List< scalar >, Size > &) | |
Construct as copy of FixedList<T, Size> More... | |
List (const PtrList< List< scalar > > &) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< List< scalar > > &) | |
Construct as copy of SLList<T> More... | |
List (const UIndirectList< List< scalar > > &) | |
Construct as copy of UIndirectList<T> More... | |
List (const BiIndirectList< List< scalar > > &) | |
Construct as copy of BiIndirectList<T> More... | |
List (std::initializer_list< List< scalar > >) | |
Construct from an initialiser list. More... | |
List (Istream &) | |
Construct from Istream. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
autoPtr< List< List< scalar > > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | resize (const label, const List< scalar > &) |
Alias for setSize(const label, const T&) More... | |
void | setSize (const label) |
Reset size of List. More... | |
void | setSize (const label, const List< scalar > &) |
Reset size of List and value for new elements. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | append (const List< scalar > &) |
Append an element at the end of the list. More... | |
void | append (const UList< List< scalar > > &) |
Append a List at the end of this list. More... | |
void | append (const UIndirectList< List< scalar > > &) |
Append a UIndirectList at the end of this list. More... | |
void | transfer (List< List< scalar > > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (DynamicList< List< scalar >, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (SortableList< List< scalar > > &) |
Transfer the contents of the argument List into this list. More... | |
List< scalar > & | newElmt (const label) |
Return subscript-checked element of UList. More... | |
void | shallowCopy (const UList< List< scalar > > &)=delete |
Disallow implicit shallowCopy. More... | |
void | operator= (const UList< List< scalar > > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< List< scalar > > &) |
Assignment operator. Takes linear time. More... | |
void | operator= (List< List< scalar > > &&) |
Move assignment operator. More... | |
void | operator= (const SLList< List< scalar > > &) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const UIndirectList< List< scalar > > &) |
Assignment to UIndirectList operator. Takes linear time. More... | |
void | operator= (const BiIndirectList< List< scalar > > &) |
Assignment to BiIndirectList operator. Takes linear time. More... | |
void | operator= (std::initializer_list< List< scalar > >) |
Assignment to an initialiser list. More... | |
void | operator= (const List< scalar > &) |
Assignment of all entries to the given value. More... | |
void | operator= (const zero) |
Assignment of all entries to zero. More... | |
![]() | |
UList () | |
Null constructor. More... | |
UList (T *__restrict__ v, label size) | |
Construct from components. More... | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. More... | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. More... | |
std::streamsize | byteSize () const |
Return the binary size in number of characters of the UList. More... | |
const T * | cdata () const |
Return a const pointer to the first data element,. More... | |
T * | data () |
Return a pointer to the first data element,. More... | |
T & | first () |
Return the first element of the list. More... | |
const T & | first () const |
Return first element of the list. More... | |
T & | last () |
Return the last element of the list. More... | |
const T & | last () const |
Return the last element of the list. More... | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1) More... | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size) More... | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1) More... | |
void | shallowCopy (const UList< T > &) |
Copy the pointer held by the given UList. More... | |
void | deepCopy (const UList< T > &) |
Copy elements of the given UList. More... | |
T & | operator[] (const label) |
Return element of UList. More... | |
const T & | operator[] (const label) const |
Return element of constant UList. More... | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. More... | |
void | operator= (const T &) |
Assignment of all entries to the given value. More... | |
void | operator= (const zero) |
Assignment of all entries to zero. More... | |
iterator | begin () |
Return an iterator to begin traversing the UList. More... | |
iterator | end () |
Return an iterator to end traversing the UList. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
label | max_size () const |
Return size of the largest possible UList. More... | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero) More... | |
void | swap (UList< T > &) |
Swap two ULists of the same type in constant time. More... | |
bool | operator== (const UList< T > &) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &) const |
Return true if !(a < b). Takes linear time. More... | |
const bool & | operator[] (const label i) const |
Friends | |
Istream & | operator>> (Istream &, Distribution< Type > &) |
Ostream & | operator (Ostream &, const Distribution< Type > &) |
Additional Inherited Members | |
![]() | |
static const List< List< scalar > > & | null () |
Return a null List. More... | |
![]() | |
static const UList< T > & | null () |
Return a null UList. More... | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. More... | |
Accumulating histogram of component values. Specified bin resolution, automatic generation of bins.
Definition at line 62 of file Distribution.H.
Component type.
Definition at line 78 of file Distribution.H.
Construct null.
Definition at line 33 of file Distribution.C.
Distribution | ( | const Type & | binWidth | ) |
Construct from separate binWidth for each component.
Definition at line 42 of file Distribution.C.
Distribution | ( | const Distribution< Type > & | d | ) |
Copy constructor.
Distribution | ( | Distribution< Type > && | d | ) |
Move constructor.
Destructor.
Definition at line 71 of file Distribution.C.
Foam::scalar totalWeight | ( | direction | cmpt | ) | const |
Sum the total weight added to the component in the.
argument
Definition at line 78 of file Distribution.C.
References forAll.
Foam::List< Foam::label > keys | ( | direction | cmpt | ) | const |
Definition at line 94 of file Distribution.C.
References forAll, Foam::identityMap(), and k.
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 108 of file Distribution.C.
References UList< T >::empty(), forAll, n, List< T >::setSize(), and List< T >::size().
Foam::Pair< Foam::label > validLimits | ( | direction | cmpt | ) | const |
Returns the indices of the first and last non-zero entries.
Definition at line 174 of file Distribution.C.
References Pair< Type >::first(), forAll, and Pair< Type >::second().
Type mean |
Definition at line 206 of file Distribution.C.
References Foam::component(), forAll, k, Foam::setComponent(), and Foam::Zero.
Type median |
Definition at line 235 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, Foam::mag(), Foam::normalised(), Foam::second(), Foam::setComponent(), List< T >::size(), and Foam::Zero.
Add a value to the distribution, optionally specifying a weight.
Definition at line 321 of file Distribution.C.
References Foam::component(), n, and Foam::neg().
Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > normalised |
Return the normalised distribution (probability density)
and bins
Definition at line 344 of file Distribution.C.
References Foam::component(), UList< T >::empty(), UList< T >::first(), Pair< Type >::first(), k, Pair< Type >::second(), and List< T >::setSize().
Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > raw |
Return the distribution of the total bin weights.
Definition at line 392 of file Distribution.C.
References Foam::component(), UList< T >::empty(), UList< T >::first(), Pair< Type >::first(), k, Pair< Type >::second(), and List< T >::setSize().
Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > cumulativeNormalised |
Return the cumulative normalised distribution and.
integration locations (at end of bins)
Definition at line 434 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, Foam::normalised(), and Foam::sum().
Foam::List< Foam::List< Foam::Pair< Foam::scalar > > > cumulativeRaw |
Return the cumulative total bin weights and integration.
locations (at end of bins)
Definition at line 470 of file Distribution.C.
References Foam::component(), UList< T >::first(), forAll, and Foam::sum().
void clear |
Resets the Distribution by clearing the stored lists.
Leaves the same number of them and the same binWidth.
Definition at line 501 of file Distribution.C.
|
inline |
Return the bin width.
Definition at line 30 of file DistributionI.H.
|
inline |
Return the List start bin indices.
Definition at line 38 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 513 of file Distribution.C.
References Foam::endl(), UList< T >::first(), forAll, Foam::nl, and Foam::normalised().
void operator= | ( | const Distribution< Type > & | rhs | ) |
Definition at line 570 of file Distribution.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
void operator= | ( | Distribution< Type > && | rhs | ) |
Definition at line 592 of file Distribution.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
friend |
|
friend |