A min/max value pair with additional methods. In addition to conveniently storing values, it can be used for logic operations or to modify data. A few global functions and functors are also provided. More...
Public Types | |
typedef T | value_type |
The value type the MinMax represents. More... | |
typedef pTraits< T >::cmptType | cmptType |
Component type. More... | |
Public Member Functions | |
MinMax () | |
Construct inverted range. More... | |
MinMax (const T &minVal, const T &maxVal) | |
Copy construct from components. More... | |
MinMax (const std::pair< T, T > &range) | |
Copy construct from components. More... | |
MinMax (const Pair< T > &range) | |
Copy construct from components. More... | |
MinMax (const Foam::zero) | |
Construct with a single zero value. More... | |
MinMax (const T &val) | |
Construct with a single initial value. More... | |
MinMax (const UList< T > &vals) | |
Construct from list of values. More... | |
const T & | min () const noexcept |
The min value (first) More... | |
T & | min () noexcept |
The min value (first) More... | |
const T & | max () const noexcept |
The max value (second) More... | |
T & | max () noexcept |
The max value (second) More... | |
T | centre () const |
The min/max average value. More... | |
T | span () const |
The min to max span. Zero if the range is invalid. More... | |
scalar | mag () const |
The magnitude of the min to max span. Zero if the range is invalid. More... | |
bool | empty () const |
Range is empty if it is inverted. More... | |
bool | valid () const |
Range is valid if it is not inverted. More... | |
void | clear () |
Reset to an invalid, inverted range. More... | |
bool | intersect (const MinMax< T > &b) |
Intersect (union) with the second range. More... | |
bool | overlaps (const MinMax< T > &b) const |
Test if the ranges overlap. More... | |
int | compare (const T &val) const |
Compares the min/max range with the specified value. More... | |
bool | contains (const T &val) const |
True if the value is within the range. More... | |
const T & | clip (const T &val) const |
bool | inplaceClip (T &val) const |
Inplace clip value by the min/max limits. More... | |
MinMax< T > & | add (const MinMax &other) |
Extend the range to include the other min/max range. More... | |
MinMax< T > & | add (const T &val) |
Include the value into the range. More... | |
MinMax< T > & | add (const UList< T > &vals) |
Include the values into the range. More... | |
bool | operator() (const T &val) const |
Identical to contains(), for use as a predicate. More... | |
MinMax< T > & | operator+= (const MinMax< T > &b) |
Extend min/max range to include other range. More... | |
MinMax< T > & | operator+= (const T &val) |
Extend min/max range to include value. More... | |
MinMax< T > & | operator+= (const UList< T > &vals) |
Extend min/max range to include all values. More... | |
MinMax< T > & | operator*= (const scalar &s) |
Multiply range by scalar factor. More... | |
MinMax< T > & | operator/= (const scalar &s) |
Divide range by scalar factor. More... | |
Static Public Member Functions | |
static MinMax< T > | ge (const T &minVal) |
A semi-infinite range from minVal to the type max. More... | |
static MinMax< T > | le (const T &maxVal) |
A semi-infinite range from type min to maxVal. More... | |
static MinMax< T > | zero_one () |
A 0-1 range corresponding to the pTraits zero, one. More... | |
A min/max value pair with additional methods. In addition to conveniently storing values, it can be used for logic operations or to modify data. A few global functions and functors are also provided.
Determine min/max limits from a List of values:
List<scalar> values = ...; // on construction MinMax<scalar> range(values); range.clear(); range += val; // global minMax() function Info<< minMax(values) << nl;
General comparison operations
scalar val; if (val < range) ... value is below range min if (range.contains(val)) ... value within range if (range.compare(val) > 0) ... value is above range max if (range(val)) ... value within range - as predicate
Since the range has a predicate form, it can be used as a filter method. For example,
Info<< "values in range: " << subsetList(values, range) << nl; boolList mask = ListOps::create<bool>(values, range); Info<< "values values in range " << mask << nl;
One particular advantage offered by MinMax is to clip or limit values to a particular range. For example,
scalarMinMax range(lower, upper); scalar val; val = range.clip(val) .. return clip values // vs. val = min(max(value, lower, upper))
Or when working on lists, the values can be limited in a single pass of the data without intermediate memory allocation.
scalarField values = ...; for (scalar& val : values) { range.inplaceClip(val); } // vs. values = min(max(values, lower, upper))
typedef T value_type |
|
inlineexplicit |
|
inlinestatic |
A semi-infinite range from minVal to the type max.
Definition at line 31 of file MinMaxI.H.
Referenced by electrostaticDepositionFvPatchScalarField::electrostaticDepositionFvPatchScalarField(), writeFile::read(), log::read(), heatTransferCoeff::read(), electricPotential::read(), externalCoupled::read(), and STDMD::read().
|
inlinestatic |
|
inlinestatic |
A 0-1 range corresponding to the pTraits zero, one.
Definition at line 45 of file MinMaxI.H.
Referenced by lumpedPointMovement::readDict().
|
inlinenoexcept |
The min value (first)
Definition at line 107 of file MinMaxI.H.
Referenced by MinMax< scalar >::add(), MinMax< scalar >::overlaps(), and GeometricField< Type, fvPatchField, volMesh >::writeMinMax().
|
inlinenoexcept |
The max value (second)
Definition at line 121 of file MinMaxI.H.
Referenced by MinMax< scalar >::add(), and MinMax< scalar >::overlaps().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Extend the range to include the other min/max range.
Definition at line 263 of file MinMaxI.H.
Referenced by PDRblock::location::edgeLimits(), Foam::minMax(), Foam::minMaxMag(), minMaxOp< T >::operator()(), and Foam::operator+().
|
inline |
|
inline |
Identical to contains(), for use as a predicate.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |