template<class Type>
class Foam::Pair< Type >
An ordered pair of two objects of type <T> with first() and second() elements.
- See also:
- Foam::Tuple2 for storing two objects of dissimilar types.
Definition at line 52 of file Pair.H.
Public Member Functions |
| Pair () |
| Null constructor.
|
| Pair (const Type &f, const Type &s) |
| Construct from components.
|
| Pair (Istream &is) |
| Construct from Istream.
|
const Type & | first () const |
| Return first.
|
Type & | first () |
| Return first.
|
const Type & | second () const |
| Return second.
|
Type & | second () |
| Return second.
|
Pair< Type > | reversePair () const |
| Return reverse pair.
|
const Type & | other (const Type &a) const |
| Return other.
|
| FixedList () |
| Null constructor.
|
| FixedList (const Typev[Size]) |
| Construct from components.
|
| FixedList (const Type &) |
| Construct from value.
|
| FixedList (const UList< Type > &) |
| Construct from UList.
|
| FixedList (const SLList< Type > &) |
| Construct from SLList.
|
| FixedList (const FixedList< Type, Size > &) |
| Copy constructor.
|
| FixedList (Istream &) |
| Construct from Istream.
|
autoPtr< FixedList< Type, Size > > | clone () const |
| Clone.
|
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.
|
const Type * | cdata () const |
| Return a const pointer to the first data element,.
|
Type * | 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 | resize (const label) |
| Dummy resize function.
|
void | setSize (const label) |
| Dummy setSize function.
|
void | transfer (const FixedList< Type, Size > &) |
| Copy (not transfer) the argument contents.
|
void | writeEntry (Ostream &) const |
| Write the FixedList as a dictionary entry.
|
void | writeEntry (const word &keyword, Ostream &) const |
| Write the FixedList as a dictionary entry with keyword.
|
Type & | operator[] (const label) |
| Return element of FixedList.
|
const Type & | operator[] (const label) const |
| Return element of constant FixedList.
|
void | operator= (const Typev[Size]) |
| Assignment from array operator. Takes linear time.
|
void | operator= (const UList< Type > &) |
| Assignment from UList operator. Takes linear time.
|
void | operator= (const SLList< Type > &) |
| Assignment from SLList operator. Takes linear time.
|
void | operator= (const Type &) |
| Assignment of all entries to the given value.
|
iterator | begin () |
| Return an iterator to begin traversing the FixedList.
|
const_iterator | begin () const |
| Return const_iterator to begin traversing the constant FixedList.
|
iterator | end () |
| Return an iterator to end traversing the FixedList.
|
const_iterator | end () const |
| Return const_iterator to end traversing the constant FixedList.
|
const_iterator | cbegin () const |
| Return const_iterator to begin traversing the constant FixedList.
|
const_iterator | cend () const |
| Return const_iterator to end traversing the constant FixedList.
|
reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the FixedList.
|
const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing FixedList.
|
reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the FixedList.
|
const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing FixedList.
|
const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing FixedList.
|
const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing FixedList.
|
label | size () const |
| Return the number of elements in the FixedList.
|
label | max_size () const |
| Return size of the largest possible FixedList.
|
bool | empty () const |
| Return true if the FixedList is empty (ie, size() is zero).
|
void | swap (FixedList< Type, Size > &) |
| Swap two FixedLists of the same type in constant time.
|
bool | operator== (const FixedList< Type, Size > &) const |
| Equality operation on FixedLists of the same type.
|
bool | operator!= (const FixedList< Type, Size > &) const |
| The opposite of the equality operation. Takes linear time.
|
bool | operator< (const FixedList< Type, Size > &) const |
| Compare two FixedLists lexicographically. Takes linear time.
|
bool | operator> (const FixedList< Type, Size > &) const |
| Compare two FixedLists lexicographically. Takes linear time.
|
bool | operator<= (const FixedList< Type, Size > &) const |
| Return true if !(a > b). Takes linear time.
|
bool | operator>= (const FixedList< Type, Size > &) const |
| Return true if !(a < b). Takes linear time.
|