hashedWordList Class Reference

A wordList with hashed indices for faster lookup by name. More...

Inheritance diagram for hashedWordList:
Collaboration diagram for hashedWordList:

Public Member Functions

 hashedWordList ()
 Construct null. More...
 
 hashedWordList (const hashedWordList &)
 Copy constructor. More...
 
 hashedWordList (const UList< word > &names)
 Construct from list of names. More...
 
 hashedWordList (const Xfer< List< word > > &names)
 Construct by transferring the parameter contents. More...
 
 hashedWordList (const label nNames, const char **names)
 Construct from number and list of names. More...
 
 hashedWordList (const char **names)
 Construct from a NULL-terminated list of names. More...
 
 hashedWordList (Istream &)
 Construct from Istream. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const word &)
 Append an element at the end of the list. More...
 
bool contains (const word &) const
 Does the list contain the specified name. More...
 
void transfer (List< word > &)
 Transfer the contents of the argument List into this list. More...
 
void operator= (const UList< word > &names)
 Assignment operator from list of names. More...
 
void operator= (const hashedWordList &)
 Assignment operator. More...
 
const wordoperator[] (const label index) const
 Return name corresponding to specified index. More...
 
label operator[] (const word &) const
 Return index corresponding to specified name. More...
 
- Public Member Functions inherited from List< word >
label size () const
 Return the number of elements in the UList. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const word &)
 Construct with given size and value for all elements. More...
 
 List (const List< word > &)
 Copy constructor. More...
 
 List (const Xfer< List< word > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< word > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< word > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< word, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< word > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< word > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< word > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< word > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< word > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const word &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const word &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const word &)
 Append an element at the end of the list. More...
 
void append (const UList< word > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< word > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< word > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< word, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< word > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< word > > xfer ()
 Transfer contents to the Xfer container. More...
 
wordnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< word > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< word > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< word > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< word > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< word > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const word &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) 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 &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 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
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero). More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 

Friends

Istreamoperator>> (Istream &, hashedWordList &)
 
Ostreamoperator<< (Ostream &, const hashedWordList &)
 

Additional Inherited Members

- Public Types inherited from List< word >
typedef SubList< wordsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. 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 null UList. More...
 
- Protected Member Functions inherited from List< word >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

A wordList with hashed indices for faster lookup by name.

Source files

Definition at line 57 of file hashedWordList.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 42 of file hashedWordList.C.

hashedWordList ( const hashedWordList names)

Copy constructor.

Definition at line 56 of file hashedWordList.C.

hashedWordList ( const UList< word > &  names)

Construct from list of names.

Definition at line 48 of file hashedWordList.C.

hashedWordList ( const Xfer< List< word > > &  names)

Construct by transferring the parameter contents.

Definition at line 64 of file hashedWordList.C.

hashedWordList ( const label  nNames,
const char **  names 
)

Construct from number and list of names.

Definition at line 73 of file hashedWordList.C.

References forAll, and UList< T >::operator[]().

Here is the call graph for this function:

hashedWordList ( const char **  names)

Construct from a NULL-terminated list of names.

Definition at line 90 of file hashedWordList.C.

References forAll, UList< T >::operator[](), and List< T >::setSize().

Here is the call graph for this function:

Construct from Istream.

Definition at line 111 of file hashedWordList.C.

Member Function Documentation

void clear ( )

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

Definition at line 119 of file hashedWordList.C.

References List< T >::clear().

Here is the call graph for this function:

void append ( const word name)

Append an element at the end of the list.

Definition at line 126 of file hashedWordList.C.

References List< T >::append().

Here is the call graph for this function:

bool contains ( const word name) const
inline

Does the list contain the specified name.

Definition at line 28 of file hashedWordListI.H.

void transfer ( List< word > &  lst)

Transfer the contents of the argument List into this list.

and annul the argument list.

Definition at line 134 of file hashedWordList.C.

References List< T >::transfer().

Here is the call graph for this function:

void operator= ( const UList< word > &  names)
inline

Assignment operator from list of names.

Definition at line 36 of file hashedWordListI.H.

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

Here is the call graph for this function:

void operator= ( const hashedWordList lst)
inline

Assignment operator.

Definition at line 43 of file hashedWordListI.H.

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

Return name corresponding to specified index.

Definition at line 50 of file hashedWordListI.H.

References UList< T >::operator[]().

Here is the call graph for this function:

Foam::label operator[] ( const word name) const
inline

Return index corresponding to specified name.

Definition at line 59 of file hashedWordListI.H.

References Foam::name().

Here is the call graph for this function:

Friends And Related Function Documentation

Istream& operator>> ( Istream ,
hashedWordList  
)
friend
Ostream& operator<< ( Ostream ,
const hashedWordList  
)
friend

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