An ordered pair of two objects of type <T> with first() and second() elements. More...
Public Member Functions | |
Pair () | |
Null constructor. More... | |
Pair (const Type &f, const Type &s) | |
Construct from components. More... | |
Pair (const FixedList< Type, 2 > &fl) | |
Construct from FixedList. More... | |
Pair (Istream &is) | |
Construct from Istream. More... | |
const Type & | first () const |
Return first. More... | |
Type & | first () |
Return first. More... | |
const Type & | second () const |
Return second. More... | |
Type & | second () |
Return second. More... | |
const Type & | other (const Type &a) const |
Return other. More... | |
Public Member Functions inherited from FixedList< Type, 2 > | |
FixedList () | |
Null constructor. More... | |
FixedList (const Type &) | |
Construct from value. More... | |
FixedList (const Type v[Size]) | |
Construct from C-array. More... | |
FixedList (InputIterator first, InputIterator last) | |
Construct given start and end iterators. More... | |
FixedList (std::initializer_list< Type >) | |
Construct from an initialiser list. More... | |
FixedList (const UList< Type > &) | |
Construct from UList. More... | |
FixedList (const SLList< Type > &) | |
Construct from SLList. More... | |
FixedList (Istream &) | |
Construct from Istream. More... | |
autoPtr< FixedList< Type, Size > > | clone () const |
Clone. 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... | |
const Type * | cdata () const |
Return a const pointer to the first data element,. More... | |
Type * | data () |
Return a pointer to the first data element,. More... | |
Type & | first () |
Return the first element of the list. More... | |
const Type & | first () const |
Return first element of the list. More... | |
Type & | last () |
Return the last element of the list. More... | |
const Type & | last () 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 | resize (const label) |
Dummy resize function. More... | |
void | setSize (const label) |
Dummy setSize function. More... | |
void | transfer (const FixedList< Type, Size > &) |
Copy (not transfer) the argument contents. More... | |
Type & | operator[] (const label) |
Return element of FixedList. More... | |
const Type & | operator[] (const label) const |
Return element of constant FixedList. More... | |
void | operator= (const Type v[Size]) |
Assignment to array operator. Takes linear time. More... | |
void | operator= (const UList< Type > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const SLList< Type > &) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (std::initializer_list< Type >) |
Assignment to an initialiser list. Takes linear time. More... | |
void | operator= (const Type &) |
Assignment of all entries to the given value. More... | |
iterator | begin () |
Return an iterator to begin traversing the FixedList. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant FixedList. More... | |
iterator | end () |
Return an iterator to end traversing the FixedList. More... | |
const_iterator | end () const |
Return const_iterator to end traversing the constant FixedList. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant FixedList. More... | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant FixedList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the FixedList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing FixedList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the FixedList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing FixedList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing FixedList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing FixedList. More... | |
label | size () const |
Return the number of elements in the FixedList. More... | |
label | max_size () const |
Return size of the largest possible FixedList. More... | |
bool | empty () const |
Return true if the FixedList is empty (ie, size() is zero) More... | |
void | swap (FixedList< Type, Size > &) |
Swap two FixedLists of the same type in constant time. More... | |
bool | operator== (const FixedList< Type, Size > &) const |
Equality operation on FixedLists of the same type. More... | |
bool | operator!= (const FixedList< Type, Size > &) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const FixedList< Type, Size > &) const |
Compare two FixedLists lexicographically. Takes linear time. More... | |
bool | operator> (const FixedList< Type, Size > &) const |
Compare two FixedLists lexicographically. Takes linear time. More... | |
bool | operator<= (const FixedList< Type, Size > &) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const FixedList< Type, Size > &) const |
Return true if !(a < b). Takes linear time. More... | |
Static Public Member Functions | |
static int | compare (const Pair< Type > &a, const Pair< Type > &b) |
Compare Pairs. More... | |
Static Public Member Functions inherited from FixedList< Type, 2 > | |
static const FixedList< Type, Size > & | null () |
Return a null FixedList. More... | |
Additional Inherited Members | |
Public Types inherited from FixedList< Type, 2 > | |
typedef Type | value_type |
Type of values the FixedList contains. More... | |
typedef Type & | reference |
Type that can be used for storing into. More... | |
typedef const Type & | const_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 FixedList. More... | |
typedef Type * | iterator |
Random access iterator for traversing FixedList. More... | |
typedef const Type * | const_iterator |
Random access iterator for traversing FixedList. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of FixedList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant FixedList. More... | |
An ordered pair of two objects of type <T> with first() and second() elements.
|
inline |
Construct from components.
Definition at line 76 of file Pair.H.
References f(), Pair< Type >::first(), s(), and Pair< Type >::second().
|
inline |
Return first.
Definition at line 98 of file Pair.H.
References FixedList< Type, 2 >::operator[]().
Referenced by multicomponentPhaseChange::addSup(), singleComponentPhaseChange::addSup(), globalIndexAndTransform::addToTransformIndex(), preserveBafflesConstraint::apply(), meshRefinement::balance(), points::calcSamples(), lineFace::calcSamples(), Foam::cutPoly::cellCuts(), decompositionMethod::decompose(), snappySnapDriver::doSnap(), FvFaceCellWave< Type, TrackingData >::faceChanged(), FvFaceCellWave< Type, TrackingData >::faceInfo(), Foam::faceNij(), FvFaceCellWave< Type, TrackingData >::faceToCell(), InjectionModel< CloudType >::findCellAtPosition(), wallBoilingHeatTransfer::flipSign(), Foam::triIntersect::generateGeometry(), globalIndexAndTransform::globalIndexAndTransform(), globalIndexAndTransform::index(), massTransfer::index(), irregular::irregular(), Foam::kShellIntegration(), noiseFFT::Ldelta(), noiseFFT::Lf(), CollidingParcel< ParcelType >::move(), Distribution< Type >::normalised(), multiphaseVoFMixture::interfacePair::hash::operator()(), Foam::operator<(), Foam::operator==(), Pair< Type >::other(), Pair< Type >::Pair(), noiseFFT::Pdelta(), Distribution< Type >::raw(), Foam::readConfigFile(), massTransfer::sign(), globalIndexAndTransform::transformIndicesForPatches(), UniformTable< Type >::UniformTable(), meshPhiCorrectInfo::updateCell(), FvWallInfo< WallLocation >::updateFace(), sweepData::updateFace(), meshPhiCorrectInfo::updateFace(), and Distribution< Type >::validLimits().
|
inline |
Return first.
Definition at line 104 of file Pair.H.
References FixedList< Type, 2 >::operator[]().
|
inline |
Return second.
Definition at line 110 of file Pair.H.
References FixedList< Type, 2 >::operator[]().
Referenced by multicomponentPhaseChange::addSup(), singleComponentPhaseChange::addSup(), globalIndexAndTransform::addToTransformIndex(), preserveBafflesConstraint::apply(), meshRefinement::balance(), points::calcSamples(), lineFace::calcSamples(), Foam::cutPoly::cellCuts(), decompositionMethod::decompose(), snappySnapDriver::doSnap(), FvFaceCellWave< Type, TrackingData >::faceChanged(), FvFaceCellWave< Type, TrackingData >::faceInfo(), Foam::faceNij(), FvFaceCellWave< Type, TrackingData >::faceToCell(), InjectionModel< CloudType >::findCellAtPosition(), Foam::triIntersect::generateGeometry(), massTransfer::index(), irregular::irregular(), Foam::kShellIntegration(), noiseFFT::Ldelta(), noiseFFT::Lf(), noiseFFT::Lsum(), CollidingParcel< ParcelType >::move(), Distribution< Type >::normalised(), multiphaseVoFMixture::interfacePair::hash::operator()(), Foam::operator<(), Foam::operator==(), Pair< Type >::other(), Pair< Type >::Pair(), noiseFFT::Pdelta(), globalIndexAndTransform::processor(), Distribution< Type >::raw(), Foam::readConfigFile(), massTransfer::sign(), globalIndexAndTransform::transformIndex(), globalIndexAndTransform::transformIndicesForPatches(), UniformTable< Type >::UniformTable(), meshPhiCorrectInfo::updateCell(), FvWallInfo< WallLocation >::updateFace(), sweepData::updateFace(), meshPhiCorrectInfo::updateFace(), and Distribution< Type >::validLimits().
|
inline |
Return second.
Definition at line 116 of file Pair.H.
References FixedList< Type, 2 >::operator[]().
|
inline |
Return other.
Definition at line 122 of file Pair.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Pair< Type >::first(), and Pair< Type >::second().
Compare Pairs.
Returning:
Definition at line 153 of file Pair.H.
Referenced by phaseInterface::New(), and Foam::operator==().