A table of species. More...
#include <specie/speciesTable.H>
Public Member Functions | |
speciesTable (const wordList &specieNames) | |
Construct from list of specie names. | |
speciesTable (const label nSpecies, const char **specieNames) | |
Construct from number of species and list of specie names. | |
speciesTable (Istream &) | |
Construct from Istream. | |
bool | contains (const word &specieName) const |
Does the table contain the given specie. | |
const word & | operator[] (const label) const |
Return a specie's name. | |
label | operator[] (const word &) const |
Lookup a specie's name and return its index. | |
![]() | |
label | size () const |
Return the number of elements in the UList. | |
List () | |
Null constructor. | |
List (const label) | |
Construct with given size. | |
List (const label, const word &) | |
Construct with given size and value for all elements. | |
List (const List< word > &) | |
Copy constructor. | |
List (const Xfer< List< word > > &) | |
Construct by transferring the parameter contents. | |
List (List< word > &, bool reUse) | |
Construct as copy or re-use as specified. | |
List (const UList< word > &, const unallocLabelList &mapAddressing) | |
Construct as subset. | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. | |
List (const FixedList< word, Size > &) | |
Construct as copy of FixedList<T, Size> | |
List (const PtrList< word > &) | |
Construct as copy of PtrList<T> | |
List (const SLList< word > &) | |
Construct as copy of SLList<T> | |
List (const IndirectList< word > &) | |
Construct as copy of IndirectList<T> | |
List (const UIndirectList< word > &) | |
Construct as copy of UIndirectList<T> | |
List (const BiIndirectList< word > &) | |
Construct as copy of BiIndirectList<T> | |
List (Istream &) | |
Construct from Istream. | |
autoPtr< List< word > > | clone () const |
Clone. | |
~List () | |
void | resize (const label) |
Reset size of List. | |
void | resize (const label, const word &) |
Reset size of List and value for new elements. | |
void | setSize (const label) |
Reset size of List. | |
void | setSize (const label, const word &) |
Reset size of List and value for new elements. | |
void | clear () |
Clear the list, i.e. set size to zero. | |
void | append (const UList< word > &) |
Append a List at the end of this list. | |
void | append (const UIndirectList< word > &) |
Append a UIndirectList at the end of this list. | |
void | transfer (List< word > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (DynamicList< word, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (SortableList< word > &) |
Transfer the contents of the argument List into this list. | |
Xfer< List< word > > | xfer () |
Transfer contents to the Xfer container. | |
word & | newElmt (const label) |
Return subscript-checked element of UList. | |
void | operator= (const UList< word > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const List< word > &) |
Assignment operator. Takes linear time. | |
void | operator= (const SLList< word > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const IndirectList< word > &) |
Assignment from IndirectList operator. Takes linear time. | |
void | operator= (const UIndirectList< word > &) |
Assignment from UIndirectList operator. Takes linear time. | |
void | operator= (const BiIndirectList< word > &) |
Assignment from BiIndirectList operator. Takes linear time. | |
void | operator= (const word &) |
Assignment of all entries to the given value. | |
![]() | |
UList () | |
Null constructor. | |
UList (word *__restrict__ v, label size) | |
Construct from components. | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. | |
label | byteSize () const |
Return the binary size in number of characters of the UList. | |
const word * | cdata () const |
Return a const pointer to the first data element,. | |
word * | data () |
Return a pointer to the first data element,. | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1). | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size). | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1). | |
void | writeEntry (Ostream &) const |
Write the UList as a dictionary entry. | |
void | writeEntry (const word &keyword, Ostream &) const |
Write the UList as a dictionary entry with keyword. | |
void | assign (const UList< word > &) |
Assign elements to those from UList. | |
word & | operator[] (const label) |
Return element of UList. | |
operator const Foam::List< word > & () const | |
Allow cast to a const List<T>&. | |
iterator | begin () |
Return an iterator to begin traversing the UList. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. | |
iterator | end () |
Return an iterator to end traversing the UList. | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
label | max_size () const |
Return size of the largest possible UList. | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero). | |
void | swap (UList< word > &) |
Swap two ULists of the same type in constant time. | |
bool | operator== (const UList< word > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UList< word > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const UList< word > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator> (const UList< word > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator<= (const UList< word > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const UList< word > &) const |
Return true if !(a < b). Takes linear time. |
Friends | |
Istream & | operator>> (Istream &, speciesTable &) |
Additional Inherited Members | |
![]() | |
typedef SubList< word > | subList |
Declare type of subList. | |
![]() | |
typedef word | value_type |
Type of values the UList contains. | |
typedef word & | reference |
Type that can be used for storing into. | |
typedef const word & | const_reference |
Type that can be used for storing into. | |
typedef label | difference_type |
The type that can represent the difference between any two. | |
typedef label | size_type |
The type that can represent the size of a UList. | |
typedef word * | iterator |
Random access iterator for traversing UList. | |
typedef const word * | const_iterator |
Random access iterator for traversing UList. | |
typedef word * | reverse_iterator |
Reverse iterator for reverse traversal of UList. | |
typedef const word * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. | |
![]() | |
static const List< word > & | null () |
Return a null List. | |
![]() | |
void | size (const label) |
Override size to be inconsistent with allocated storage. |
speciesTable | ( | const wordList & | specieNames | ) |
Construct from list of specie names.
Definition at line 44 of file speciesTable.C.
speciesTable | ( | const label | nSpecies, |
const char ** | specieNames | ||
) |
Construct from number of species and list of specie names.
Definition at line 53 of file speciesTable.C.
References forAll, and speciesTable::operator[]().
speciesTable | ( | Istream & | is | ) |
Construct from Istream.
Definition at line 67 of file speciesTable.C.
|
inline |
Does the table contain the given specie.
Definition at line 30 of file speciesTableI.H.
References HashTable< T, Key, Hash >::found().
|
inline |
Return a specie's name.
Reimplemented from UList< word >.
Definition at line 39 of file speciesTableI.H.
References UList< word >::operator[]().
Referenced by speciesTable::speciesTable().
Lookup a specie's name and return its index.
Definition at line 47 of file speciesTableI.H.
|
friend |