MinMaxOps.H File Reference

Global functions and operators related to the MinMax class. Included by MinMax.H. More...

Include dependency graph for MinMaxOps.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	clampOp< T >
	Unary function for applying component-wise clamping. More...

Namespaces
namespace	Foam
	Namespace for OpenFOAM.

Functions
template<class T>
scalar	mag (const MinMax< T > &range)
	The mag() function for min/max range.
template<class T>
T	clip (const T &val, const MinMax< T > &range)
	Return the value after clamping by the min/max limiter.
template<class T>
MinMax< T >	minMax (const UList< T > &vals)
	Extract the min/max range from a list of values.
template<class T>
MinMax< T >	minMax (const T &x, const T &y)
	Combine two values to create a min/max range. Order is unimportant.
template<class T>
MinMax< T >	minMax (const MinMax< T > &x, const MinMax< T > &y)
	Combine two MinMax ranges (same as x + y).
scalarMinMax	minMaxMag (const scalar val)
	The magnitude of a single value.
template<class Form, class Cmpt, direction nCmpt>
scalarMinMax	minMaxMag (const VectorSpace< Form, Cmpt, nCmpt > &vs)
	The magnitude of a VectorSpace.
template<class T>
scalarMinMax	minMaxMag (const UList< T > &vals)
	The min/max magnitudes from a list of values.
template<class T>
scalarMinMax	minMaxMag (const MinMax< T > &range)
	The min/max magnitudes from a min/max range.
template<class T1, class T2>
scalarMinMax	minMaxMag (const T1 &x, const T2 &y)
	Combine the magitude of two values (similar or dissimilar types) to create a min/max range. Order is unimportant.
template<class T1, class T2>
scalarMinMax	minMaxMag (const MinMax< T1 > &x, const MinMax< T2 > &y)
	Scalar combine two MinMax ranges (same or dissimilar types).
template<class T>
MinMax< T >	operator+ (const MinMax< T > &x, const MinMax< T > &y)
	Combine two ranges.
template<class T>
MinMax< T >	operator* (const MinMax< T > &x, scalar s)
	Multiply range by scalar factor.
template<class T>
MinMax< T >	operator/ (const MinMax< T > &x, scalar s)
	Divide range by scalar factor.
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator< (const MinMax< T > &range, const U &val)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator<= (const MinMax< T > &range, const U &val)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator> (const MinMax< T > &range, const U &val)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator>= (const MinMax< T > &range, const U &val)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator< (const U &val, const MinMax< T > &range)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator<= (const U &val, const MinMax< T > &range)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator> (const U &val, const MinMax< T > &range)
template<class T, class U>
std::enable_if_t< std::is_convertible_v< U, T >, bool >	operator>= (const U &val, const MinMax< T > &range)

Detailed Description

Global functions and operators related to the MinMax class. Included by MinMax.H.

Original source file MinMaxOps.H

InNamespace Foam

Definition in file MinMaxOps.H.