unintegrableForNonZeroQ Class Reference
Inheritance diagram for unintegrableForNonZeroQ:
Collaboration diagram for unintegrableForNonZeroQ:

Public Member Functions

 unintegrable (const word &name, const dictionary &dict, Random &rndGen, const label sampleQ)
 Inherit constructors. More...
 
 unintegrable (Random &rndGen, const label Q, const label sampleQ, const label n)
 Inherit constructors. More...
 
 unintegrable (const unintegrable &d, const label sampleQ)
 Inherit constructors. More...
 
- Public Member Functions inherited from unintegrable
 unintegrable (const word &name, const dictionary &dict, Random &rndGen, const label sampleQ)
 Construct from a dictionary. More...
 
 unintegrable (Random &rndGen, const label Q, const label sampleQ, const label n)
 Construct from components. More...
 
 unintegrable (const unintegrable &d, const label sampleQ)
 Construct copy. More...
 
virtual ~unintegrable ()
 Destructor. More...
 
scalar sample () const
 Sample the distribution. More...
 
virtual scalar mean () const
 Return the mean value. More...
 
virtual tmp< scalarFieldPDF (const scalarField &x) const
 Return the distribution probability density function. More...
 
virtual scalar sample () const=0
 Sample the distribution. More...
 
virtual tmp< scalarFieldsample (const label n) const=0
 Sample the distribution. More...
 
virtual tmp< scalarFieldx (const label n) const
 Return coordinates to plot across the range of the distribution. More...
 
- Public Member Functions inherited from distribution
 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 &)
 
 TypeName ("distribution")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, distribution, dictionary,(const dictionary &dict, Random &rndGen, const label sampleQ),(dict, rndGen, sampleQ))
 Declare runtime constructor selection table. More...
 
 distribution (const word &name, const dictionary &dict, Random &rndGen, const label sampleQ)
 Construct from dictionary. More...
 
 distribution (Random &rndGen, const label Q, const label sampleQ)
 Construct from components. More...
 
 distribution (const distribution &d, const label sampleQ)
 Construct copy. More...
 
virtual autoPtr< distributionclone (const label sampleQ) const =0
 Construct and return a clone. More...
 
autoPtr< distributionclone () const
 Construct and return a clone. More...
 
virtual ~distribution ()
 Destructor. More...
 
virtual tmp< scalarFieldsample (const label n) const =0
 Sample the distribution. More...
 
virtual scalar min () const =0
 Return the minimum value. More...
 
virtual scalar max () const =0
 Return the maximum value. More...
 
void report () const
 Report. More...
 
virtual tmp< scalarFieldx (const label n) const
 Return coordinates to plot across the range of the distribution. More...
 
- 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 initialiser 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 initialiser 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...
 
OstreamprintInfo (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...
 
Toperator[] (const Key &)
 Find and return a hashedEntry. More...
 
const Toperator[] (const Key &) const
 Find and return a hashedEntry. More...
 
Toperator() (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 initialiser 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...
 

Protected Member Functions

virtual Pair< scalar > Phi01 (const label q) const
 Return values of the un-normalised CDF at the minimum and maximum. More...
 
virtual Pair< scalar > Phi01 (const label q) const
 Access cached values of the un-normalised CDF at the minimum and. More...
 
const Pair< scalar > & Phi01 () const
 Access cached values of the un-normalised CDF at the minimum and. More...
 
- Protected Member Functions inherited from unintegrable
virtual tmp< scalarFieldphi (const label q, const scalarField &x) const =0
 Return values of the un-normalised PDF for the given size exponent. More...
 
virtual tmp< scalarFieldPhi (const label q, const scalarField &x) const
 Return values of the un-normalised CDF for the given size exponent. More...
 
const Pair< scalar > & Phi01 () const
 Access cached values of the un-normalised CDF at the minimum and. More...
 
- Protected Member Functions inherited from distribution
virtual void validateBounds (const dictionary &dict) const
 Validate that the bounds are monotonic. More...
 
virtual void validatePositive (const dictionary &dict) const
 Validate that the lower bound is positive. More...
 
tmp< scalarFieldclipPDF (const scalarField &x, const tmp< scalarField > &pdf) const
 Clip the PDF values to zero outside the bounds. More...
 
label q () const
 Return the effective distribution size exponent. More...
 

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 Treference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const Tconst_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 Member Functions inherited from unintegrable
static tmp< scalarFieldintegrate (const scalarField &x, const scalarField &y)
 Integrate the values y with respect to the coordinates x. More...
 
static tmp< scalarFieldintegrateX (const scalarField &x, const scalarField &y)
 Integrate the values x*y with respect to the coordinates x. More...
 
static scalar sampleInterval (const Pair< scalar > &x, const Pair< scalar > &Phi, const scalar s)
 Sample an interval, given the interval's bounding x-coordinates,. More...
 
static scalar sampleInterval (const Pair< scalar > &x, const Pair< scalar > &phi, const Pair< scalar > &Phi, const scalar s)
 Sample an interval, given the interval's bounding x-coordinates,. More...
 
static scalar sample (const scalarField &x, const scalarField &Phi, const scalar s)
 Sample a discretised distribution, given the x-coordinates,. More...
 
static scalar sample (const scalarField &x, const scalarField &phi, const scalarField &Phi, const scalar s)
 Sample a discretised distribution, given the x-coordinates, values. More...
 
- Static Public Member Functions inherited from distribution
static void write (const fileName &file, const List< Pair< scalar >> &pairs)
 Write to file. More...
 
static autoPtr< distributionNew (const dictionary &dict, Random &rndGen, const label sampleQ)
 Selector. 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...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 
- Protected Attributes inherited from distribution
RandomrndGen_
 Reference to a random number generator. More...
 
const label Q_
 Distribution size exponent. More...
 
const label sampleQ_
 Sample size exponent. More...
 

Detailed Description

Definition at line 235 of file unintegrable.H.

Member Function Documentation

◆ Phi01() [1/3]

Foam::Pair< Foam::scalar > Phi01 ( const label  q) const
protectedvirtual

Return values of the un-normalised CDF at the minimum and maximum.

x-coordinates for the given size exponent.

Reimplemented from unintegrable.

Definition at line 273 of file unintegrable.C.

References UList< T >::first(), UList< T >::last(), Foam::max(), Foam::min(), unintegrable::Phi01(), and x.

Here is the call graph for this function:

◆ Phi01() [2/3]

Foam::Pair< Foam::scalar > Phi01
protected

Access cached values of the un-normalised CDF at the minimum and.

maximum x-coordinates.

Definition at line 115 of file unintegrable.C.

References f().

Here is the call graph for this function:

◆ Phi01() [3/3]

const Foam::Pair< Foam::scalar > & Phi01
protected

Access cached values of the un-normalised CDF at the minimum and.

maximum x-coordinates.

Definition at line 119 of file unintegrable.C.

◆ unintegrable() [1/3]

Inherit constructors.

Definition at line 187 of file unintegrable.C.

◆ unintegrable() [2/3]

Inherit constructors.

Definition at line 196 of file unintegrable.C.

References Foam::max().

Here is the call graph for this function:

◆ unintegrable() [3/3]

Inherit constructors.

Definition at line 205 of file unintegrable.C.


The documentation for this class was generated from the following files: