An ordered pair of two objects of type <T> with first() and second() elements. More...

Inheritance diagram for Pair< T >:

[legend]

Collaboration diagram for Pair< T >:

Classes
struct	symmHasher
	Symmetric hashing functor for Pair, hashes lower value first. More...

Public Member Functions
	Pair ()=default
	Default construct. More...

void	front ()=delete
	The front() accessor (from FixedList) has no purpose. More...

void	back ()=delete
	The back() accessor (from FixedList) has no purpose. More...

	Pair (const T &f, const T &s)
	Copy construct from components. More...

	Pair (T &&f, T &&s)
	Move construct from components. More...

	Pair (const std::pair< T, T > &vals)
	Copy construct from std::pair. More...

	Pair (std::pair< T, T > &&vals)
	Move construct from std::pair. More...

	Pair (const FixedList< T, 2 > &list)
	Copy construct FixedList of two items. More...

	Pair (const T &f, const T &s, const bool doSort)
	Copy construct, optionally sorted with first less-than second. More...

	Pair (const FixedList< T, 2 > &list, const bool doSort)
	Copy construct, optionally sorted with first less-than second. More...

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

const T &	first () const noexcept
	Access the first element. More...

T &	first () noexcept
	Access the first element. More...

const T &	second () const noexcept
	Access the second element. More...

T &	second () noexcept
	Access the second element. More...

const T &	other (const T &a) const
	Return other element. More...

bool	is_sorted () const
	True if first() is less-than-equal second() More...

void	flip ()
	Flip the Pair in-place. More...

void	sort ()
	Sort so that first() is less-than second() More...

bool	sorted () const
	Deprecated(2023-07) Use is_sorted() method. More...

Public Member Functions inherited from FixedList< T, 2 >
void	writeEntry (const word &keyword, Ostream &os) const
	Write the list as a dictionary entry with keyword. More...

	FixedList ()=default
	Default construct. More...

	FixedList (const T &val)
	Construct and initialize all entries to given value. More...

	FixedList (const Foam::zero)
	Construct and initialize all entries to zero. More...

	FixedList (const FixedList< T, N > &list)
	Copy construct. More...

	FixedList (FixedList< T, N > &&list)
	Move construct by using move assignment for the individual list elements. More...

	FixedList (std::initializer_list< T > list)
	Construct from an initializer list. Runtime size check. More...

	FixedList (const UList< T > &list)
	Construct from UList. Runtime size check. More...

	FixedList (const FixedList< T, AnyNum > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check. More...

	FixedList (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check. More...

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

	FixedList (const T list[N])
	Deprecated: copy construct from C-array. More...

autoPtr< FixedList< T, N > >	clone () const
	Clone. 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 &	get () noexcept
	Element access using compile-time indexing. More...

const T &	get () const noexcept
	Element access using compile-time indexing. More...

T &	front () noexcept
	Access first element of the list, position [0]. More...

const T &	front () const noexcept
	Access first element of the list, position [0]. More...

T &	back () noexcept
	Access last element of the list, position [N-1]. More...

const T &	back () const noexcept
	Access last element of the list, position [N-1]. More...

label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list. More...

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

label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of 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...

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is identical to template parameter N. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,N) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

bool	contains (const T &val) const
	True if the value is contained in the list. More...

bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list? More...

label	find (const T &val) const
	Find index of the first occurrence of the value. More...

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

void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	resize_fill (const label n, const T &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	setSize (const label n)
	Dummy function, to make FixedList consistent with List. More...

void	fill (const T &val)
	Assign all entries to the given value. More...

void	fill (const Foam::zero)
	Assign all entries to zero. 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. More...

void	swapLast (const label i)
	Swap element with the last element. More...

void	transfer (FixedList< T, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements. More...

T &	operator[] (const label i)
	Return element of FixedList. More...

const T &	operator[] (const label i) const
	Return element of constant FixedList. More...

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

void	operator= (std::initializer_list< T > list)
	Assignment to an initializer list. Takes linear time. More...

void	operator= (const T &val)
	Assign all entries to the given value. fill() More...

void	operator= (const Foam::zero)
	Assign all entries to zero. fill() More...

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

void	operator= (FixedList< T, N > &&list)
	Move assignment. More...

void	operator= (const T list[N])
	Deprecated: assignment from C-array. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the FixedList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant FixedList. More...

iterator	end () noexcept
	Return an iterator to end traversing the FixedList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant FixedList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant FixedList. More...

const_iterator	cend () const noexcept
	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...

void	swap (FixedList< T, N > &other)
	Swap lists by swapping the content of the individual list elements. More...

bool	operator== (const FixedList< T, N > &list) const
	Equality operation on FixedLists of the same type. More...

bool	operator!= (const FixedList< T, N > &list) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const FixedList< T, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator> (const FixedList< T, N > &list) const
	Compare two FixedLists lexicographically. Takes linear time. More...

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

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

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

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

T &	first () noexcept
	Access first element of the list, position [0] - front() More...

const T &	first () const noexcept
	Access first element of the list, position [0] - front() More...

T &	last () noexcept
	Access last element of the list, position [N-1] - back() More...

const T &	last () const noexcept
	Access last element of the list, position [N-1] - back() More...

bool	found (const T &val, label pos=0) const
	Same as contains() More...

Static Public Member Functions
static int	compare (const Pair< T > &a, const Pair< T > &b)
	Compare Pairs. More...

Static Public Member Functions inherited from FixedList< T, 2 >
static const FixedList< T, N > &	null ()
	Return a null FixedList. More...

static std::streamsize	size_bytes () noexcept
	Number of contiguous bytes for the list data,. More...

static std::streamsize	byteSize ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous. More...

static constexpr bool	empty () noexcept
	Always false since zero-sized FixedList is compile-time disabled. More...

static constexpr label	size () noexcept
	Return the number of elements in the FixedList. More...

static constexpr unsigned	max_size () noexcept
	The dimensioned size (template parameter N) of the FixedList. More...

Additional Inherited Members
Public Types inherited from FixedList< T, 2 >
typedef T	value_type
	The value type the FixedList 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 FixedList. More...

typedef const T *	const_iterator
	Random access iterator for traversing FixedList. More...

typedef label	size_type
	The type to represent the size of a FixedList. 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...

Protected Member Functions inherited from FixedList< T, 2 >
void	writeEntry (Ostream &os) const
	Write the FixedList with its compound type. More...

Detailed Description

template<class T>
class Foam::Pair< T >

An ordered pair of two objects of type <T> with first() and second() elements.

Source files

See also: Foam::Tuple2 for storing two objects of dissimilar types.

Definition at line 46 of file instant.H.

Constructor & Destructor Documentation

◆ Pair() [1/9]

Pair ( )

default

Default construct.

◆ Pair() [2/9]

Pair	(	const T &	f,
		const T &	s
	)

inline

Copy construct from components.

Definition at line 42 of file PairI.H.

◆ Pair() [3/9]

Pair	(	T &&	f,
		T &&	s
	)

inline

Move construct from components.

Definition at line 50 of file PairI.H.

◆ Pair() [4/9]

Pair ( const std::pair< T, T > & vals )

inline

Copy construct from std::pair.

Definition at line 58 of file PairI.H.

◆ Pair() [5/9]

Pair ( std::pair< T, T > && vals )

inline

Move construct from std::pair.

Definition at line 66 of file PairI.H.

◆ Pair() [6/9]

Pair ( const FixedList< T, 2 > & list )

inline

Copy construct FixedList of two items.

Definition at line 74 of file PairI.H.

◆ Pair() [7/9]

Pair	(	const T &	f,
		const T &	s,
		const bool	doSort
	)

inline

Copy construct, optionally sorted with first less-than second.

Definition at line 81 of file PairI.H.

◆ Pair() [8/9]

Pair	(	const FixedList< T, 2 > &	list,
		const bool	doSort
	)

inline

Copy construct, optionally sorted with first less-than second.

Definition at line 97 of file PairI.H.

◆ Pair() [9/9]

Pair ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 104 of file PairI.H.

Member Function Documentation

◆ front()

void front ( )

delete

The front() accessor (from FixedList) has no purpose.

◆ back()

void back ( )

delete

The back() accessor (from FixedList) has no purpose.

◆ first() [1/2]

const T& first ( ) const

inlinenoexcept

Access the first element.

Definition at line 137 of file Pair.H.

Referenced by linePoints::a(), phaseChange::addToDriftRate(), globalIndexAndTransform::addToTransformIndex(), reconstructionSchemes::alreadyReconstructed(), meshRefinement::balance(), cell::box(), face::box(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::box(), fieldMinMax::calcMinMaxFieldType(), meshReader::cellFaceIdentifier::cellId(), commSchedule::commSchedule(), Pair< word >::compare(), faPatchData::comparePatchPair(), injectionModelList::correct(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), multiWorldConnections::createComms(), simpleControl::criteriaSatisfied(), pimpleControl::criteriaSatisfied(), faMeshDistributor::distribute(), snappyRefineDriver::doRefine(), Foam::faceNij(), shellSurfaces::findDirectionalLevel(), globalIndexAndTransform::globalIndexAndTransform(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), globalIndexAndTransform::index(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), linearInterpolationWeights::integrationWeights(), isoSurfaceTopo::interpolateTemplate(), isoSurfaceTopo::isoSurfaceTopo(), volSurfaceMapping::mapToSurface(), volSurfaceMapping::mapToVolume(), faPatchData::matchPatchPair(), solutionControl::maxTypeResidual(), slidingInterface::modifyMotionPoints(), Distribution< Type >::normalised(), meshReader::cellFaceIdentifier::notUsed(), Pair< T >::symmHasher::operator()(), minFirstOp< T1 >::operator()(), maxFirstOp< T1 >::operator()(), Foam::operator==(), FieldField< Foam::Field, LUType >::operator[](), Distribution< Type >::raw(), ensightSurfaceReader::readGeometry(), ensightSurfaceReader::readGeometryHeader(), lumpedPointMovement::setInterpolator(), meshRefinement::splitFacesUndo(), SquareMatrix< cmptType >::SquareMatrix(), globalIndexAndTransform::transformIndicesForPatches(), meshReader::cellFaceIdentifier::used(), Distribution< Type >::validLimits(), polyBoundaryMesh::whichPatch(), ABAQUSsurfaceFormat< Face >::write(), and meshRefinement::zonify().

◆ first() [2/2]

T& first ( )

inlinenoexcept

Access the first element.

Definition at line 142 of file Pair.H.

◆ second() [1/2]

const T& second ( ) const

inlinenoexcept

Access the second element.

Definition at line 147 of file Pair.H.

Referenced by globalIndexAndTransform::addToTransformIndex(), reconstructionSchemes::alreadyReconstructed(), linePoints::b(), meshRefinement::balance(), cell::box(), face::box(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::box(), fieldMinMax::calcMinMaxFieldType(), commSchedule::commSchedule(), Pair< word >::compare(), faPatchData::comparePatchPair(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), faMeshDistributor::distribute(), snappyRefineDriver::doRefine(), meshReader::cellFaceIdentifier::faceId(), Foam::faceNij(), shellSurfaces::findDirectionalLevel(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), linearInterpolationWeights::integrationWeights(), isoSurfaceTopo::interpolateTemplate(), isoSurfaceTopo::isoSurfaceTopo(), volSurfaceMapping::mapToSurface(), faPatchData::matchPatchPair(), slidingInterface::modifyMotionPoints(), Distribution< Type >::normalised(), meshReader::cellFaceIdentifier::notUsed(), Pair< T >::symmHasher::operator()(), Foam::operator==(), FieldField< Foam::Field, LUType >::operator[](), globalIndexAndTransform::processor(), Distribution< Type >::raw(), ensightSurfaceReader::readGeometry(), ensightSurfaceReader::readGeometryHeader(), lumpedPointMovement::setInterpolator(), meshRefinement::splitFacesUndo(), SquareMatrix< cmptType >::SquareMatrix(), globalIndexAndTransform::transformIndex(), globalIndexAndTransform::transformIndicesForPatches(), meshReader::cellFaceIdentifier::used(), Distribution< Type >::validLimits(), ABAQUSsurfaceFormat< Face >::write(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ second() [2/2]

T& second ( )

inlinenoexcept

Access the second element.

Definition at line 152 of file Pair.H.

◆ other()

const T & other ( const T & a ) const

inline

Return other element.

Definition at line 113 of file PairI.H.

◆ is_sorted()

bool is_sorted ( ) const

inline

True if first() is less-than-equal second()

Definition at line 144 of file PairI.H.

Referenced by Pair< word >::sorted().

Here is the caller graph for this function:

◆ flip()

void flip ( )

inline

Flip the Pair in-place.

Definition at line 137 of file PairI.H.

Referenced by patchEdgeFaceRegions::updateEdge(), and patchEdgeFaceRegions::updateFace().

Here is the caller graph for this function:

◆ sort()

void sort ( )

inline

Sort so that first() is less-than second()

Definition at line 151 of file PairI.H.

◆ compare()

int compare	(	const Pair< T > &	a,
		const Pair< T > &	b
	)

inlinestatic

Compare Pairs.

Returns

0: different
+1: identical values and order used
-1: identical values, but in reversed order

Definition at line 24 of file PairI.H.

◆ sorted()

bool sorted ( ) const

inline

Deprecated(2023-07) Use is_sorted() method.

Deprecated:: (2023-07) Use is_sorted() method

Definition at line 225 of file Pair.H.

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

src/OpenFOAM/db/Time/instant/instant.H
src/OpenFOAM/primitives/tuples/Pair.H
src/OpenFOAM/primitives/tuples/PairI.H

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class Foam::Pair< T >

Constructor & Destructor Documentation

◆ Pair() [1/9]

◆ Pair() [2/9]

◆ Pair() [3/9]

◆ Pair() [4/9]

◆ Pair() [5/9]

◆ Pair() [6/9]

◆ Pair() [7/9]

◆ Pair() [8/9]

◆ Pair() [9/9]

Member Function Documentation

◆ front()

◆ back()

◆ first() [1/2]

◆ first() [2/2]

◆ second() [1/2]

◆ second() [2/2]

◆ other()

◆ is_sorted()

◆ flip()

◆ sort()

◆ compare()

◆ sorted()

template<class T>
class Foam::Pair< T >