A wordList with hashed named lookup, which can be faster in some situations than using the normal list find/found methods. More...

Inheritance diagram for hashedWordList:

[legend]

Collaboration diagram for hashedWordList:

[legend]

Public Member Functions
	hashedWordList ()=default
	Default construct an empty list. More...

	hashedWordList (const hashedWordList &list)
	Copy construct. More...

	hashedWordList (hashedWordList &&list)
	Move construct. More...

	hashedWordList (const wordUList &list)
	Copy construct from list of words. More...

	hashedWordList (const wordUList &list, bool unique)
	Copy construct from list of words, eliminating duplicates. More...

	hashedWordList (wordList &&list, bool unique=false)
	Move construct from list of words, optionally eliminating duplicates. More...

	hashedWordList (std::initializer_list< word > list)
	Construct from an initializer list. More...

template<class AnyType , class AnyHash >
	hashedWordList (const HashTable< AnyType, word, AnyHash > &tbl)
	Construct from the word keys of any HashTable, sorting immediately. More...

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

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

void	append (const word &val)
	Append an element if not already in the list. More...

label	appendUniq (const word &val)
	Append an element if not already in the list. More...

const HashTable< label > &	lookup () const
	Return the hash of words/indices for inspection. More...

void	swap (hashedWordList &list)
	Swap contents. More...

void	transfer (hashedWordList &list)

void	transfer (wordList &list, bool unique=false)

void	rehash () const
	Rebuild the lookup hash indices. More...

void	rehash (bool unique)
	Rebuild the lookup hash indices, or make unique entries first. More...

void	uniq ()

void	sort ()
	Inplace sort list and rehash the indices. More...

label	find (const word &val) const
	Find index of the value (searches the hash). More...

bool	found (const word &val) const
	True if the value if found in the list (searches the hash). More...

const word &	operator[] (const label index) const
	Return name corresponding to specified index. More...

label	operator[] (const word &val) const
	Find index of the value (searches the hash) - same as find(). More...

bool	operator() (const word &val) const
	Check hashed values for the specified name - same as found(). More...

void	operator= (const hashedWordList &list)
	Copy assignment. Rehashes the indices. More...

void	operator= (const wordUList &list)
	Copy assignment from list of words. Rehashes the indices. More...

void	operator= (std::initializer_list< word > list)
	Copy assignment from initializer list. Rehashes the indices. More...

void	operator= (hashedWordList &&list)
	Move assignment operator. More...

void	operator= (wordList &&list)
	Move assignment from list of words. Rehashes the indices. More...

bool	contains (const word &val) const
	Deprecated(2019-01) Is the specified name found in the list? More...

Public Member Functions inherited from List< word >
constexpr	List () noexcept
	Default construct. More...

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

	List (const label len, const word &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 word &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, word &&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< word > &a)
	Copy construct from list. More...

	List (const UList< word > &a)
	Copy construct contents from list. More...

	List (List< word > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< word > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< word > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< word, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< word > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< word > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< word, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< word > list)
	Construct from an initializer list. More...

	List (List< word > &&list)
	Move construct from List. More...

	List (DynamicList< word, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< word > &&list)
	Move construct from SLList. More...

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

autoPtr< List< word > >	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 word &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

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

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

void	setSize (const label n, const word &val)
	Alias for resize() More...

void	append (const word &val)
	Append an element at the end of the list. More...

void	append (word &&val)
	Move append an element at the end of the list. More...

void	append (const UList< word > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< word, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const word &val)
	Append an element if not already in the list. More...

void	transfer (List< word > &list)

void	transfer (DynamicList< word, SizeMin > &list)

word &	newElmt (const label i)

void	operator= (const UList< word > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< word > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< word > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< word, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< word, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< word > list)
	Assignment to an initializer list. More...

void	operator= (const word &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< word > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< word, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< word > &&list)
	Move assignment. Takes constant time. More...

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

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< word > &)=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...

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

label	rcIndex (const label i) const noexcept

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

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

std::streamsize	byteSize () const

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

label	find (const T &val, label pos=0) 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...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. 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 (const UList< T > &list)
	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...

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

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 noexcept
	The number of elements in the UList. More...

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

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

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

bool	operator!= (const UList< T > &a) 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 > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

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

bool	operator>= (const UList< T > &a) 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

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

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

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

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

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

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

Additional Inherited Members
Public Types inherited from List< word >
typedef SubList< word >	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...

Static Public Member Functions inherited from List< word >
static const List< word > &	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...

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

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

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

Detailed Description

A wordList with hashed named lookup, which can be faster in some situations than using the normal list find/found methods.

Source files

Definition at line 54 of file hashedWordList.H.

Constructor & Destructor Documentation

◆ hashedWordList() [1/9]

hashedWordList ( )

default

Default construct an empty list.

◆ hashedWordList() [2/9]

hashedWordList ( const hashedWordList & list )

inline

Copy construct.

Definition at line 30 of file hashedWordListI.H.

◆ hashedWordList() [3/9]

hashedWordList ( hashedWordList && list )

inline

Move construct.

Definition at line 36 of file hashedWordListI.H.

◆ hashedWordList() [4/9]

hashedWordList ( const wordUList & list )

inlineexplicit

Copy construct from list of words.

Definition at line 43 of file hashedWordListI.H.

◆ hashedWordList() [5/9]

hashedWordList	(	const wordUList &	list,
		bool	unique
	)

inline

Copy construct from list of words, eliminating duplicates.

Definition at line 49 of file hashedWordListI.H.

References hashedWordList::rehash().

Here is the call graph for this function:

◆ hashedWordList() [6/9]

hashedWordList	(	wordList &&	list,
		bool	unique = `false`
	)

inline

Move construct from list of words, optionally eliminating duplicates.

Definition at line 57 of file hashedWordListI.H.

References hashedWordList::rehash().

Here is the call graph for this function:

◆ hashedWordList() [7/9]

hashedWordList ( std::initializer_list< word > list )

inline

Construct from an initializer list.

Definition at line 65 of file hashedWordListI.H.

References hashedWordList::rehash().

Here is the call graph for this function:

◆ hashedWordList() [8/9]

hashedWordList ( const HashTable< AnyType, word, AnyHash > & tbl )

inlineexplicit

Construct from the word keys of any HashTable, sorting immediately.

This also handles a wordHashSet, which is derived from a HashTable. The result is similar to a HashTable::sortedToc.

Definition at line 74 of file hashedWordListI.H.

References hashedWordList::rehash().

Here is the call graph for this function:

◆ hashedWordList() [9/9]

hashedWordList ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 85 of file hashedWordListI.H.

Member Function Documentation

◆ clear()

void clear ( )

inline

Clear the list, i.e. set size to zero.

Definition at line 93 of file hashedWordListI.H.

References List< word >::clear().

Here is the call graph for this function:

◆ append()

void append ( const word & val )

inline

Append an element if not already in the list.

Definition at line 100 of file hashedWordListI.H.

References outputOptions::append().

Here is the call graph for this function:

◆ appendUniq()

Foam::label appendUniq ( const word & val )

inline

Append an element if not already in the list.

Returns: the change in list length

Definition at line 109 of file hashedWordListI.H.

References outputOptions::append().

Referenced by solidReaction< ReactionThermo >::solidReaction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookup()

const Foam::HashTable< Foam::label > & lookup ( ) const

inline

Return the hash of words/indices for inspection.

Definition at line 122 of file hashedWordListI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

◆ swap()

void swap ( hashedWordList & list )

inline

Swap contents.

Definition at line 148 of file hashedWordListI.H.

◆ transfer() [1/2]

void transfer ( hashedWordList & list )

inline

Transfer contents of the argument into this list and annul the argument list, optionally eliminating duplicates

Definition at line 160 of file hashedWordListI.H.

References kinematicSingleLayer::transfer().

Here is the call graph for this function:

◆ transfer() [2/2]

void transfer	(	wordList &	list,
		bool	unique = `false`
	)

inline

Transfer the contents of the argument List into this list and annul the argument list, optionally eliminating duplicates

Definition at line 167 of file hashedWordListI.H.

References kinematicSingleLayer::transfer().

Here is the call graph for this function:

◆ rehash() [1/2]

void rehash ( ) const

Rebuild the lookup hash indices.

Definition at line 32 of file hashedWordList.C.

References HashTable< T, Key, Hash >::clear(), HashTable< T, Key, Hash >::insert(), HashTable< T, Key, Hash >::resize(), and UList< T >::size().

Referenced by hashedWordList::hashedWordList(), and Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rehash() [2/2]

void rehash ( bool unique )

inline

Rebuild the lookup hash indices, or make unique entries first.

Definition at line 174 of file hashedWordListI.H.

◆ uniq()

void uniq ( )

Adjust the list (if needed) to eliminate duplicate entries, and rehash the indices

Definition at line 47 of file hashedWordList.C.

References List< T >::resize(), and UList< T >::size().

Here is the call graph for this function:

◆ sort()

void sort ( )

inline

Inplace sort list and rehash the indices.

Definition at line 187 of file hashedWordListI.H.

References Foam::sort().

Here is the call graph for this function:

◆ find()

Foam::label find ( const word & val ) const

inline

Find index of the value (searches the hash).

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

Definition at line 136 of file hashedWordListI.H.

References lookup::lookup().

Referenced by diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), InterfaceCompositionModel< Thermo, OtherThermo >::getLocalThermo(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::MultiComponentPhaseModel(), and thirdBodyEfficiencies::thirdBodyEfficiencies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ found()

bool found ( const word & val ) const

inline

True if the value if found in the list (searches the hash).

Definition at line 142 of file hashedWordListI.H.

◆ operator[]() [1/2]

const Foam::word & operator[] ( const label index ) const

inline

Return name corresponding to specified index.

Fatal for out of range values.

Definition at line 196 of file hashedWordListI.H.

References ensightPart::operator[]().

Here is the call graph for this function:

◆ operator[]() [2/2]

Foam::label operator[] ( const word & val ) const

inline

Find index of the value (searches the hash) - same as find().

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

Definition at line 205 of file hashedWordListI.H.

◆ operator()()

bool operator() ( const word & val ) const

inline

Check hashed values for the specified name - same as found().

Can be used as a unary predicate.

Definition at line 211 of file hashedWordListI.H.

◆ operator=() [1/5]

void operator= ( const hashedWordList & list )

inline

Copy assignment. Rehashes the indices.

Definition at line 217 of file hashedWordListI.H.

References List< word >::operator=().

Here is the call graph for this function:

◆ operator=() [2/5]

void operator= ( const wordUList & list )

inline

Copy assignment from list of words. Rehashes the indices.

Definition at line 224 of file hashedWordListI.H.

References List< word >::operator=().

Here is the call graph for this function:

◆ operator=() [3/5]

void operator= ( std::initializer_list< word > list )

inline

Copy assignment from initializer list. Rehashes the indices.

Definition at line 231 of file hashedWordListI.H.

References List< word >::operator=().

Here is the call graph for this function:

◆ operator=() [4/5]

void operator= ( hashedWordList && list )

inline

Move assignment operator.

Definition at line 238 of file hashedWordListI.H.

References kinematicSingleLayer::transfer().

Here is the call graph for this function:

◆ operator=() [5/5]

void operator= ( wordList && list )

inline

Move assignment from list of words. Rehashes the indices.

Definition at line 245 of file hashedWordListI.H.

References kinematicSingleLayer::transfer().

Here is the call graph for this function:

◆ contains()

bool contains ( const word & val ) const

inline

Deprecated(2019-01) Is the specified name found in the list?

Deprecated:: (2019-01) - use found() method

Definition at line 190 of file hashedWordList.H.

References found.

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

src/OpenFOAM/primitives/strings/lists/hashedWordList.H
src/OpenFOAM/primitives/strings/lists/hashedWordList.C
src/OpenFOAM/primitives/strings/lists/hashedWordListI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ hashedWordList() [1/9]

◆ hashedWordList() [2/9]

◆ hashedWordList() [3/9]

◆ hashedWordList() [4/9]

◆ hashedWordList() [5/9]

◆ hashedWordList() [6/9]

◆ hashedWordList() [7/9]

◆ hashedWordList() [8/9]

◆ hashedWordList() [9/9]

Member Function Documentation

◆ clear()

◆ append()

◆ appendUniq()

◆ lookup()

◆ swap()

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ rehash() [1/2]

◆ rehash() [2/2]

◆ uniq()

◆ sort()

◆ find()

◆ found()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator()()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ contains()