A list of unary predicates (tests) on scalars. Includes a number of standard comparison predicates (eg, "less", "greater", ...) More...

Inheritance diagram for scalars:

[legend]

Collaboration diagram for scalars:

[legend]

Public Types
enum	opType { EQUAL, NOT_EQUAL, LESS, LESS_EQUAL, GREATER, GREATER_EQUAL, ALWAYS, NEVER, LESS_EQ = LESS_EQUAL, GREATER_EQ = GREATER_EQUAL }
	Enumerations for some standard comparison predicates. More...

typedef std::function< bool(Foam::scalar)>	unary
	The unary function type for testing a scalar. More...

Public Types inherited from List< std::function< bool(Foam::scalar)> >
typedef SubList< std::function< bool(Foam::scalar)> >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

typedef T *	iterator
	Random access iterator for traversing a UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Public Member Functions
	scalars (std::initializer_list< std::pair< word, scalar >> entries)
	Construct from an initializer list of (opName opValue) tuples. More...

	scalars (const UList< Tuple2< word, scalar >> &entries)
	Copy construct from a list of (opName opValue) tuples. More...

	scalars (Istream &is)
	Construct from Istream, from list of (opName opValue) tuples. More...

	~scalars ()=default
	Destructor. More...

void	assign (std::initializer_list< std::pair< word, scalar >> entries)
	Assign new predicates from an initializer list of (opName opValue) tuples. More...

void	assign (const UList< Tuple2< word, scalar >> &entries)
	Assign new predicates from a list of (opName opValue) tuples. More...

label	find (const scalar value, label pos=0) const
	Index of the first matching test for the value. More...

label	rfind (const scalar value, label pos=-1) const
	Index of the last match for the value. More...

bool	contains (const scalar value, label pos=0) const
	Matches any condition in the list after the offset position. More...

bool	match (const scalar value) const
	Matches any condition in the list. More...

bool	matchAny (const scalar value) const
	Matches any condition in the list. More...

bool	matchAll (const scalar value) const
	Matches all conditions in the list. More...

labelList	matching (const scalar value) const
	Extract list indices for all matches. More...

labelList	matching (const UList< scalar > &input, const bool invert=false) const
	Extract list indices for all matches. More...

bool	operator() (const scalar value) const
	Identical to contains(), match(), for use as a predicate. More...

bool	found (const scalar value, label pos=0) const
	Same as contains() More...

Public Member Functions inherited from List< std::function< bool(Foam::scalar)> >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const std::function< bool(Foam::scalar)> &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const std::function< bool(Foam::scalar)> &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, std::function< bool(Foam::scalar)> &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< std::function< bool(Foam::scalar)> > &list)
	Copy construct from list. More...

	List (const UList< std::function< bool(Foam::scalar)> > &list)
	Copy construct contents from list. More...

	List (List< std::function< bool(Foam::scalar)> > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< std::function< bool(Foam::scalar)> > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< std::function< bool(Foam::scalar)> > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< std::function< bool(Foam::scalar)>, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< std::function< bool(Foam::scalar)> > &list)
	Construct as copy of PtrList<T> More...

	List (const IndirectListBase< std::function< bool(Foam::scalar)>, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< std::function< bool(Foam::scalar)> > list)
	Construct from an initializer list. More...

	List (List< std::function< bool(Foam::scalar)> > &&list) noexcept
	Move construct from List. More...

	List (DynamicList< std::function< bool(Foam::scalar)>, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (Istream &is)
	Construct from Istream. More...

	List (const SLList< std::function< bool(Foam::scalar)> > &list)
	Copy construct from SLList. More...

autoPtr< List< std::function< bool(Foam::scalar)> > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const std::function< bool(Foam::scalar)> &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_fill (const label len, const std::function< bool(Foam::scalar)> &val)
	Adjust allocated size of list and set val for all elements. More...

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	resize_unsafe (const label len) noexcept
	Change the addressed list size directly without affecting any memory management (advanced usage). More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const std::function< bool(Foam::scalar)> &val)
	Alias for resize() More...

void	transfer (List< std::function< bool(Foam::scalar)> > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

void	transfer (DynamicList< std::function< bool(Foam::scalar)>, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

std::function< bool(Foam::scalar)> &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required. More...

std::function< bool(Foam::scalar)> &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element. More...

void	push_back (const std::function< bool(Foam::scalar)> &val)
	Append an element at the end of the list. More...

void	push_back (std::function< bool(Foam::scalar)> &&val)
	Move append an element at the end of the list. More...

void	push_back (const UList< std::function< bool(Foam::scalar)> > &list)
	Append a List to the end of this list. More...

void	push_back (const IndirectListBase< std::function< bool(Foam::scalar)>, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	push_uniq (const std::function< bool(Foam::scalar)> &val)
	Append an element if not already in the list. More...

void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...

void	operator= (const UList< std::function< bool(Foam::scalar)> > &list)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< std::function< bool(Foam::scalar)> > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const IndirectListBase< std::function< bool(Foam::scalar)>, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< std::function< bool(Foam::scalar)>, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< std::function< bool(Foam::scalar)> > list)
	Assignment to an initializer list. More...

void	operator= (const std::function< bool(Foam::scalar)> &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< std::function< bool(Foam::scalar)> > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< std::function< bool(Foam::scalar)>, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (const SLList< std::function< bool(Foam::scalar)> > &list)
	Copy assign from SLList in linear time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

void	shallowCopy (const UList< std::function< bool(Foam::scalar)> > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

void	append (const std::function< bool(Foam::scalar)> &val)
	Append an element at the end of the list. More...

void	append (std::function< bool(Foam::scalar)> &&val)
	Move append an element at the end of the list. More...

void	append (const UList< std::function< bool(Foam::scalar)> > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< std::function< bool(Foam::scalar)>, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const std::function< bool(Foam::scalar)> &val)
	Same as push_uniq() More...

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

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. More...

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. More...

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	front ()
	Access first element of the list, position [0]. More...

const T &	front () const
	Access first element of the list. More...

T &	back ()
	Access last element of the list, position [size()-1]. More...

const T &	back () const
	Access last element of the list, position [size()-1]. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

bool	contains (const T &val) const
	True if the value is contained in the list. More...

bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list? More...

label	find (const T &val) const
	Find index of the first occurrence of the value. More...

label	find (const T &val, label pos, label len=-1) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (T *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size. More...

void	shallowCopy (const UList< T > &list) noexcept
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

T &	operator[] (const label i)
	Return element of UList. More...

const T &	operator[] (const label i) 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 &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...

const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. 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...

bool	empty () const noexcept
	True if List is empty (ie, size() is zero) More...

label	size () const noexcept
	The number of elements in the container. More...

label	capacity () const noexcept
	Size of the underlying storage. More...

void	swap (UList< T > &list) noexcept
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< T > &list) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &list) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &list) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &list) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access. More...

T &	first ()
	Access first element of the list, position [0]. More...

const T &	first () const
	Access first element of the list. More...

T &	last ()
	Access last element of the list, position [size()-1]. More...

const T &	last () const
	Access last element of the list, position [size()-1]. More...

bool	found (const T &val, label pos=0) const
	Same as contains() More...

template<>
const bool &	operator[] (const label i) const

template<>
UPstream::commsStruct &	operator[] (const label procID)

template<>
const UPstream::commsStruct &	operator[] (const label procID) const

template<>
Foam::UPstream::commsStruct &	operator[] (const label procID)

template<>
const Foam::UPstream::commsStruct &	operator[] (const label procID) const

Static Public Member Functions
static unary	equalOp (const scalar opVal, const scalar tol=VSMALL)
	Compare for equality, with specified tolerance (non-negative) More...

static unary	notEqualOp (const scalar opVal, const scalar tol=VSMALL)
	Compare for inequality, with specified tolerance (non-negative) More...

static unary	lessOp (const scalar opVal)
	Test if value is 'less' than prescribed. More...

static unary	lessEqualOp (const scalar opVal)
	Test if value is 'less_equal' to prescribed. More...

static unary	greaterOp (const scalar opVal)
	Test if value is 'greater' than prescribed Compare scalar values for inequality. More...

static unary	greaterEqualOp (const scalar opVal)
	Test if value is 'greater_equal' to prescribed. More...

static unary	trueOp ()
	Predicate that always returns true. More...

static unary	falseOp ()
	Predicate that always returns false. More...

static unary	andOp (const unary &test1, const unary &test2)
	Combine unary tests as an AND operation. More...

static unary	orOp (const unary &test1, const unary &test2)
	Combine unary tests as an OR operation. More...

static unary	operation (const opType op, const scalar opVal, const scalar tol=VSMALL)
	Standard comparison method by type. More...

static unary	operation (const word &opName, const scalar opVal, const scalar tol=VSMALL)
	Standard comparison method by name. More...

static unary	operation (const Tuple2< word, scalar > &op, const scalar tol=VSMALL)
	Standard comparison method by (name, value) More...

static unary	operation (const std::pair< word, scalar > &op, const scalar tol=VSMALL)
	Standard comparison method by (name, value) More...

Static Public Member Functions inherited from List< std::function< bool(Foam::scalar)> >
static const List< std::function< bool(Foam::scalar)> > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Static Public Attributes
static const Enum< opType >	opNames
	Names for the opType enumeration. More...

Additional Inherited Members
Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

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. More...

void	fill_uniform (const T &val)
	Assign all entries to the given value. More...

void	fill_uniform (const Foam::zero)
	Assign all entries to zero. More...

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

template<>
void	writeEntry (Ostream &os) const
	Character list writeEntry. More...

template<>
void	operator= (const Foam::zero)
	Character list assign zero - avoids Foam::zero casting ambiguities. More...

template<>
void	writeEntry (Ostream &os) const

template<>
void	operator= (const Foam::zero)

Detailed Description

A list of unary predicates (tests) on scalars. Includes a number of standard comparison predicates (eg, "less", "greater", ...)

Note: This class is still subject to larger changes (2018-11) as it matures.

See also: Foam::scalarRange, Foam::scalarRanges

Source files

Definition at line 62 of file scalarPredicates.H.

Member Typedef Documentation

◆ unary

typedef std::function<bool(Foam::scalar)> unary

The unary function type for testing a scalar.

Definition at line 73 of file scalarPredicates.H.

Member Enumeration Documentation

◆ opType

enum opType

Enumerations for some standard comparison predicates.

Enumerator
EQUAL	"eq", "equal"
NOT_EQUAL	"neq", "notEqual"
LESS	"lt", "less"
LESS_EQUAL	"le", "lessEqual", "lessEq"
GREATER	"gt", "greater"
GREATER_EQUAL	"ge", "greaterEqual", "greaterEq"
ALWAYS	Always matches.
NEVER	Never matches.
LESS_EQ
GREATER_EQ

Definition at line 78 of file scalarPredicates.H.

Constructor & Destructor Documentation

◆ scalars() [1/3]

scalars ( std::initializer_list< std::pair< word, scalar >> entries )

explicit

Construct from an initializer list of (opName opValue) tuples.

Definition at line 177 of file scalarPredicates.C.

References Foam::FieldOps::assign().

Here is the call graph for this function:

◆ scalars() [2/3]

scalars ( const UList< Tuple2< word, scalar >> & entries )

explicit

Copy construct from a list of (opName opValue) tuples.

Definition at line 186 of file scalarPredicates.C.

References Foam::FieldOps::assign().

Here is the call graph for this function:

◆ scalars() [3/3]

scalars ( Istream & is )

explicit

Construct from Istream, from list of (opName opValue) tuples.

Definition at line 194 of file scalarPredicates.C.

◆ ~scalars()

~scalars ( )

default

Destructor.

Member Function Documentation

◆ equalOp()

static unary equalOp	(	const scalar	opVal,
		const scalar	tol = `VSMALL`
	)

inlinestatic

Compare for equality, with specified tolerance (non-negative)

Definition at line 106 of file scalarPredicates.H.

References Foam::mag().

Here is the call graph for this function:

◆ notEqualOp()

static unary notEqualOp	(	const scalar	opVal,
		const scalar	tol = `VSMALL`
	)

inlinestatic

Compare for inequality, with specified tolerance (non-negative)

Definition at line 122 of file scalarPredicates.H.

References Foam::mag().

Here is the call graph for this function:

◆ lessOp()

static unary lessOp ( const scalar opVal )

inlinestatic

Test if value is 'less' than prescribed.

Definition at line 137 of file scalarPredicates.H.

◆ lessEqualOp()

static unary lessEqualOp ( const scalar opVal )

inlinestatic

Test if value is 'less_equal' to prescribed.

Definition at line 149 of file scalarPredicates.H.

◆ greaterOp()

static unary greaterOp ( const scalar opVal )

inlinestatic

Test if value is 'greater' than prescribed Compare scalar values for inequality.

Definition at line 162 of file scalarPredicates.H.

◆ greaterEqualOp()

static unary greaterEqualOp ( const scalar opVal )

inlinestatic

Test if value is 'greater_equal' to prescribed.

Definition at line 174 of file scalarPredicates.H.

◆ trueOp()

static unary trueOp ( )

inlinestatic

Predicate that always returns true.

Definition at line 188 of file scalarPredicates.H.

◆ falseOp()

static unary falseOp ( )

inlinestatic

Predicate that always returns false.

Definition at line 196 of file scalarPredicates.H.

◆ andOp()

static unary andOp	(	const unary &	test1,
		const unary &	test2
	)

inlinestatic

Combine unary tests as an AND operation.

Definition at line 207 of file scalarPredicates.H.

◆ orOp()

static unary orOp	(	const unary &	test1,
		const unary &	test2
	)

inlinestatic

Combine unary tests as an OR operation.

Definition at line 218 of file scalarPredicates.H.

◆ operation() [1/4]

static unary operation	(	const opType	op,
		const scalar	opVal,
		const scalar	tol = `VSMALL`
	)

static

Standard comparison method by type.

Referenced by scalars::assign().

Here is the caller graph for this function:

◆ operation() [2/4]

Foam::predicates::scalars::unary operation	(	const word &	opName,
		const scalar	opVal,
		const scalar	tol = `VSMALL`
	)

inlinestatic

Standard comparison method by name.

Definition at line 24 of file scalarPredicatesI.H.

◆ operation() [3/4]

Foam::predicates::scalars::unary operation	(	const Tuple2< word, scalar > &	op,
		const scalar	tol = `VSMALL`
	)

inlinestatic

Standard comparison method by (name, value)

Definition at line 35 of file scalarPredicatesI.H.

References Tuple2< T1, T2 >::first(), and Tuple2< T1, T2 >::second().

Here is the call graph for this function:

◆ operation() [4/4]

Foam::predicates::scalars::unary operation	(	const std::pair< word, scalar > &	op,
		const scalar	tol = `VSMALL`
	)

inlinestatic

Standard comparison method by (name, value)

Definition at line 45 of file scalarPredicatesI.H.

◆ assign() [1/2]

void assign ( std::initializer_list< std::pair< word, scalar >> entries )

Assign new predicates from an initializer list of (opName opValue) tuples.

Definition at line 203 of file scalarPredicates.C.

References stdFoam::begin(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::hasBadEntries(), scalars::operation(), and Foam::printBadEntries().

Referenced by Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assign() [2/2]

void assign ( const UList< Tuple2< word, scalar >> & entries )

Assign new predicates from a list of (opName opValue) tuples.

Definition at line 233 of file scalarPredicates.C.

References stdFoam::begin(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::hasBadEntries(), scalars::operation(), and Foam::printBadEntries().

Here is the call graph for this function:

◆ find()

Foam::label find	(	const scalar	value,
		label	pos = `0`
	)		const

Index of the first matching test for the value.

Any occurrences before the start pos are ignored. Linear search.

Returns: position in list or -1 if not found.

Definition at line 263 of file scalarPredicates.C.

References Foam::pos().

Here is the call graph for this function:

◆ rfind()

Foam::label rfind	(	const scalar	value,
		label	pos = `-1`
	)		const

Index of the last match for the value.

Any occurrences after the end pos are ignored. Linear search.

Returns: position in list or -1 if not found.

Definition at line 290 of file scalarPredicates.C.

References Foam::pos().

Here is the call graph for this function:

◆ contains()

bool contains	(	const scalar	value,
		label	pos = `0`
	)		const

inline

Matches any condition in the list after the offset position.

Linear search from start pos until the end of the list. Any occurrences before the start pos are ignored.

Returns: True if the value matches any condition in the (sub)list.

Definition at line 57 of file scalarPredicatesI.H.

References Foam::ListOps::find(), and Foam::pos().

Referenced by scalars::found().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ match()

bool match ( const scalar value ) const

inline

Matches any condition in the list.

Returns: True if the value matches any condition in the list.

Definition at line 66 of file scalarPredicatesI.H.

References scalars::matchAny().

Here is the call graph for this function:

◆ matchAny()

bool matchAny ( const scalar value ) const

inline

Matches any condition in the list.

Returns: True if the value matches any condition in the list.

Definition at line 72 of file scalarPredicatesI.H.

Referenced by scalars::match(), and scalars::operator()().

Here is the caller graph for this function:

◆ matchAll()

bool matchAll ( const scalar value ) const

inline

Matches all conditions in the list.

Returns: True if the value matches all conditions in the list.

Definition at line 86 of file scalarPredicatesI.H.

◆ matching() [1/2]

Foam::labelList matching ( const scalar value ) const

inline

Extract list indices for all matches.

Returns: The locations (indices) of the predicates that match

Definition at line 101 of file scalarPredicatesI.H.

References Foam::BitOps::count(), and List< T >::resize().

Here is the call graph for this function:

◆ matching() [2/2]

Foam::labelList matching	(	const UList< scalar > &	input,
		const bool	invert = `false`
	)		const

inline

Extract list indices for all matches.

Parameters

input	A list of scalar inputs to test
invert	invert the matching logic

Returns: The locations (indices) in the input list where match() is true

Definition at line 124 of file scalarPredicatesI.H.

References Foam::BitOps::count(), Foam::input(), Foam::invert(), and List< T >::resize().

Here is the call graph for this function:

◆ operator()()

bool operator() ( const scalar value ) const

inline

Identical to contains(), match(), for use as a predicate.

Definition at line 397 of file scalarPredicates.H.

References scalars::matchAny().

Here is the call graph for this function:

◆ found()

bool found	(	const scalar	value,
		label	pos = `0`
	)		const

inline

Same as contains()

Definition at line 405 of file scalarPredicates.H.

References scalars::contains(), and Foam::pos().

Here is the call graph for this function:

Member Data Documentation

◆ opNames

const Foam::Enum< Foam::predicates::scalars::opType > opNames

static

Names for the opType enumeration.

Definition at line 97 of file scalarPredicates.H.

Referenced by Foam::hasBadEntries(), and Foam::printBadEntries().

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

src/OpenFOAM/primitives/predicates/scalar/scalarPredicates.H
src/OpenFOAM/primitives/predicates/scalar/scalarPredicates.C
src/OpenFOAM/primitives/predicates/scalar/scalarPredicatesI.H

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ unary

Member Enumeration Documentation

◆ opType

Constructor & Destructor Documentation

◆ scalars() [1/3]

◆ scalars() [2/3]

◆ scalars() [3/3]

◆ ~scalars()

Member Function Documentation

◆ equalOp()

◆ notEqualOp()

◆ lessOp()

◆ lessEqualOp()

◆ greaterOp()

◆ greaterEqualOp()

◆ trueOp()

◆ falseOp()

◆ andOp()

◆ orOp()

◆ operation() [1/4]

◆ operation() [2/4]

◆ operation() [3/4]

◆ operation() [4/4]

◆ assign() [1/2]

◆ assign() [2/2]

◆ find()

◆ rfind()

◆ contains()

◆ match()

◆ matchAny()

◆ matchAll()

◆ matching() [1/2]

◆ matching() [2/2]

◆ operator()()

◆ found()

Member Data Documentation

◆ opNames