Base for doubly-linked lists. More...

#include <DLListBase.H>

Inheritance diagram for DLListBase:

[legend]

Classes
struct	link
	The structure for a doubly-linked storage node. More...
class	iterator
	A primitive non-const node iterator. More...
class	const_iterator
	A primitive const node iterator (bidirectional). More...

Public Member Functions
	DLListBase ()=default
	Default construct.
	DLListBase (const DLListBase &)=delete
	No copy construct.
void	operator= (const DLListBase &)=delete
	No copy assignment.
	~DLListBase ()=default
	Destructor.
bool	empty () const noexcept
	True if the list is empty.
label	size () const noexcept
	The number of elements in list.
link *	front ()
	Return first entry.
const link *	front () const
	Return const access to first entry.
link *	back ()
	Return last entry.
const link *	back () const
	Return const access to last entry.
void	push_front (link *item)
	Add at front of list.
void	push_back (link *item)
	Add at back of list.
bool	swapUp (link *item)
	Swap this element with the one above unless it is at the top.
bool	swapDown (link *item)
	Swap this element with the one below unless it is at the bottom.
link *	removeHead ()
	Remove and return first entry.
link *	remove (link *item)
	Remove and return element.
link *	remove (iterator &iter)
	Remove and return element specified by iterator.
link *	replace (link oldLink, link newLink)
	Replace oldLink with newLink and return element.
link *	replace (iterator &oldIter, link *newitem)
	Replace oldIter with newItem and return element.
void	clear ()
	Clear the list.
void	swap (DLListBase &lst)
	Swap the contents of the list.
void	transfer (DLListBase &lst)
	Transfer the contents of the argument into this list and annul the argument list.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
const_iterator	crbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for iterators.
const const_iterator &	cend () const
	End of list for iterators.
const const_iterator &	crend () const
	End of list for reverse iterators.
link *	first ()
	Return first entry.
const link *	first () const
	Return const access to first entry.
link *	last ()
	Return last entry.
const link *	last () const
	Return const access to last entry.
void	prepend (link *item)
	Add at front of list.
void	append (link *item)
	Add at back of list.

Protected Member Functions
template<class IteratorType>
IteratorType	iterator_first () const
	Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType	iterator_last () const
	Return iterator to last item or end-iterator if list is empty.

Static Protected Member Functions
template<class IteratorType>
static const IteratorType &	iterator_end ()
	Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType &	iterator_rend ()
	Factory method to return an iterator reverse end.

Friends
class	iterator
class	const_iterator

Detailed Description

Base for doubly-linked lists.

The iterators associated with the list only have a core functionality for navigation, with additional functionality to be added by inheriting classes. The node iterators always have a node-pointer as the first member data, which allows reinterpret_cast from anything else with a nullptr as its first data member. The nullObject is such an item (with a nullptr data member).

Source files

Definition at line 57 of file DLListBase.H.

Constructor & Destructor Documentation

◆ DLListBase() [1/2]

DLListBase ( )

default

Default construct.

Referenced by DLListBase::const_iterator::const_iterator(), DLListBase::const_iterator::const_iterator(), DLListBase(), iterator_first(), iterator_last(), operator=(), swap(), and transfer().

Here is the caller graph for this function:

◆ DLListBase() [2/2]

DLListBase ( const DLListBase & )

delete

No copy construct.

References DLListBase().

Here is the call graph for this function:

◆ ~DLListBase()

~DLListBase ( )

default

Destructor.

Member Function Documentation

◆ iterator_end()

template<class IteratorType>

const IteratorType & iterator_end ( )

inlinestaticprotected

Factory method to return an iterator end.

Simply reinterprets a NullObject as a DLListBase iterator.

Definition at line 28 of file DLListBaseI.H.

References Foam::nullObjectPtr.

Referenced by cend(), UILList< DLListBase, T >::cend(), end(), and UILList< DLListBase, T >::end().

Here is the caller graph for this function:

◆ iterator_rend()

template<class IteratorType>

const IteratorType & iterator_rend ( )

inlinestaticprotected

Factory method to return an iterator reverse end.

Simply reinterprets a NullObject as a DLListBase iterator.

Definition at line 35 of file DLListBaseI.H.

References Foam::nullObjectPtr.

Referenced by crend(), UILList< DLListBase, T >::crend(), and UILList< DLListBase, T >::rend().

Here is the caller graph for this function:

◆ iterator_first()

template<class IteratorType>

IteratorType iterator_first ( ) const

inlineprotected

Return iterator to first item or end-iterator if list is empty.

Removes constness which the caller promises to manage.

Definition at line 42 of file DLListBaseI.H.

References DLListBase(), and size().

Referenced by begin(), UILList< DLListBase, T >::begin(), cbegin(), and UILList< DLListBase, T >::cbegin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ iterator_last()

template<class IteratorType>

IteratorType iterator_last ( ) const

inlineprotected

Return iterator to last item or end-iterator if list is empty.

Removes constness which the caller promises to manage.

Definition at line 57 of file DLListBaseI.H.

References DLListBase(), and size().

Referenced by crbegin(), UILList< DLListBase, T >::crbegin(), and UILList< DLListBase, T >::rbegin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const DLListBase & )

delete

No copy assignment.

References DLListBase().

Here is the call graph for this function:

◆ empty()

bool empty ( ) const

inlinenoexcept

True if the list is empty.

Definition at line 189 of file DLListBase.H.

References Foam::noexcept.

Referenced by cellTable::combine(), dictionary::endLineNumber(), regionFaModel::evolve(), Foam::operator<<(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), basicThermo::printThermoNames(), reader::remapMeshInfo(), boundaryRegion::rename(), schemesLookup::schemesLookup(), sensitivitySurface::smoothSensitivities(), solution::solution(), dictionary::startLineNumber(), Foam::writeFuncsImpl(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), and IOobject::writeHeaderContent().

Here is the caller graph for this function:

◆ size()

label size ( ) const

inlinenoexcept

The number of elements in list.

Definition at line 194 of file DLListBase.H.

References Foam::noexcept.

Referenced by sixDoFRigidBodyMotion::addConstraints(), sixDoFRigidBodyMotion::addRestraints(), quasiNewton::allocateHessian(), begin(), KinematicCloud< CloudType >::buildCellOccupancy(), cbegin(), cellSizeFunction::cellSize(), linearDistance::cellSize(), linearSpatial::cellSize(), surfaceOffsetLinearDistance::cellSize(), uniform::cellSize(), uniformDistance::cellSize(), cellShapeControl::cellSizeAndAlignment(), Cloud< ParcelType >::checkFieldFieldIOobject(), ReactingHeterogeneousCloud< CloudType >::checkParcelProperties(), Cloud< ParticleType >::Cloud(), CloudFunctionObjectList< CloudType >::CloudFunctionObjectList(), ISQP::computeResiduals(), conjugateGradient::conjugateGradient(), crbegin(), displacementInterpolationMotionSolver::curPoints(), diffusionMulticomponent< ReactionThermo, ThermoType >::diffusionMulticomponent(), KinematicCloud< CloudType >::evolveCloud(), adjointSolver::getObjectiveSensitivities(), MMA::getOrDefaultScalarField(), updateMethod::globalSum(), graphFunctionObject::graphFunctionObject(), LBFGS::HessianVectorProduct(), DSMCCloud< ParcelType >::info(), dynamicMultiMotionSolverFvMesh::init(), viewFactor::initialise(), ISQP::ISQP(), iterator_first(), iterator_last(), dictionary::keys(), liquidFilmModel::liquidFilmModel(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), nullSpace::meritFunctionDirectionalDerivative(), MMA::MMA(), multiDisplacementMotionSolver::multiDisplacementMotionSolver(), multiDisplacementMotionSolver::multiDisplacementMotionSolver(), multiphaseSystem::multiphaseSystem(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), Cloud< ParticleType >::nParcels(), objectiveFlowRate::objectiveFlowRate(), objectiveFlowRatePartition::objectiveFlowRatePartition(), objectiveUniformityCellZone::objectiveUniformityCellZone(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), ParticleForceList< CloudType >::ParticleForceList(), SprayCloud< CloudType >::penetration(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::preEvolve(), quasiNewton::quasiNewton(), ReactingCloud< CloudType >::ReactingCloud(), functionObjectList::read(), externalCoupled::read(), multiFieldValue::read(), foamReport::read(), FixedValueConstraint< Type >::read(), Time::readDict(), updateMethod::readOrZeroField(), boundaryRegion::rename(), ReactingCloud< Foam::DSMCCloud< dsmcParcel > >::setModels(), MMA::setOrDefaultScalarField(), cellSetOption::setSelection(), solarLoad::solarLoad(), solarLoad::solarLoad(), rigidBodyMeshMotion::solve(), sixDoFRigidBodyMotionSolver::solve(), nullSpace::solveDualProblem(), LBFGS::SR1HessianVectorProduct(), StandardChemistryModel< ReactionThermo, ThermoType >::StandardChemistryModel(), nullSpace::statistics(), Cloud< ParcelType >::storeGlobalPositions(), surfaceAlignedSBRStressFvMotionSolver::surfaceAlignedSBRStressFvMotionSolver(), TDACChemistryModel< ReactionThermo, ThermoType >::TDACChemistryModel(), dictionary::toc(), adjointSpalartAllmaras::topologySensitivities(), Foam::unitSet(), nullSpace::updateCorrectionIndices(), updateMethod::updateMethod(), LBFGS::updateVectors(), viewFactor::viewFactor(), viewFactor::viewFactor(), volBSplinesBase::volBSplinesBase(), waveModel::waveModel(), dictionaryListEntry::write(), and topOVariablesBase::writeFluidSolidInterface().

◆ front() [1/2]

Foam::DLListBase::link * front ( )

inline

Return first entry.

Definition at line 96 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by first(), and first().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ front() [2/2]

const Foam::DLListBase::link * front ( ) const

inline

Return const access to first entry.

Definition at line 109 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ back() [1/2]

Foam::DLListBase::link * back ( )

inline

Return last entry.

Definition at line 122 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by last(), and last().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ back() [2/2]

const Foam::DLListBase::link * back ( ) const

inline

Return const access to last entry.

Definition at line 135 of file DLListBaseI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ push_front()

void push_front ( DLListBase::link * item )

Add at front of list.

Definition at line 27 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by prepend(), and UILList< DLListBase, T >::UILList().

Here is the caller graph for this function:

◆ push_back()

void push_back ( DLListBase::link * item )

Add at back of list.

Definition at line 52 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by dictionary::add(), and append().

Here is the caller graph for this function:

◆ swapUp()

bool swapUp ( DLListBase::link * a )

Swap this element with the one above unless it is at the top.

Definition at line 77 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

◆ swapDown()

bool swapDown ( DLListBase::link * a )

Swap this element with the one below unless it is at the bottom.

Definition at line 116 of file DLListBase.C.

References DLListBase::link::next_, and DLListBase::link::prev_.

◆ removeHead()

Foam::DLListBase::link * removeHead ( )

Remove and return first entry.

Definition at line 155 of file DLListBase.C.

References Foam::abort(), DLListBase::link::deregister(), Foam::FatalError, FatalErrorInFunction, and DLListBase::link::next_.

Here is the call graph for this function:

◆ remove() [1/2]

Foam::DLListBase::link * remove ( DLListBase::link * item )

Remove and return element.

Definition at line 181 of file DLListBase.C.

References DLListBase::link::deregister(), DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove() [2/2]

Foam::DLListBase::link * remove ( DLListBase::iterator & iter )

inline

Remove and return element specified by iterator.

Definition at line 184 of file DLListBaseI.H.

References remove().

Here is the call graph for this function:

◆ replace() [1/2]

Foam::DLListBase::link * replace	(	DLListBase::link *	oldLink,
		DLListBase::link *	newLink )

Replace oldLink with newLink and return element.

Definition at line 213 of file DLListBase.C.

References DLListBase::link::deregister(), DLListBase::link::next_, and DLListBase::link::prev_.

Referenced by dictionary::add(), dictionary::changeKeyword(), and replace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replace() [2/2]

Foam::DLListBase::link * replace	(	DLListBase::iterator &	oldIter,
		DLListBase::link *	newItem )

inline

Replace oldIter with newItem and return element.

Definition at line 194 of file DLListBaseI.H.

References replace().

Here is the call graph for this function:

◆ clear()

void clear ( )

inline

Clear the list.

Definition at line 147 of file DLListBaseI.H.

Referenced by transfer().

Here is the caller graph for this function:

◆ swap()

void swap ( DLListBase & lst )

inline

Swap the contents of the list.

Definition at line 155 of file DLListBaseI.H.

References DLListBase().

Here is the call graph for this function:

◆ transfer()

void transfer ( DLListBase & lst )

inline

Transfer the contents of the argument into this list and annul the argument list.

Definition at line 168 of file DLListBaseI.H.

References clear(), and DLListBase().

Here is the call graph for this function:

◆ begin()

Foam::DLListBase::iterator begin ( )

inline

Iterator to first item in list with non-const access.

Definition at line 295 of file DLListBaseI.H.

References end(), iterator_first(), and size().

Referenced by DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cbegin()

Foam::DLListBase::const_iterator cbegin ( ) const

inline

Iterator to first item in list with const access.

Definition at line 393 of file DLListBaseI.H.

References cend(), iterator_first(), and size().

Referenced by DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ crbegin()

Foam::DLListBase::const_iterator crbegin ( ) const

inline

Iterator to last item in list with const access.

Note that this is not a const_reverse_iterator, this is the responsibility of any derived classes.

Definition at line 405 of file DLListBaseI.H.

References crend(), iterator_last(), and size().

Referenced by DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

const Foam::DLListBase::iterator & end ( )

inline

End of list for iterators.

Definition at line 73 of file DLListBaseI.H.

References iterator_end().

Referenced by begin(), and DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cend()

const Foam::DLListBase::const_iterator & cend ( ) const

inline

End of list for iterators.

Definition at line 80 of file DLListBaseI.H.

References iterator_end().

Referenced by cbegin(), and DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ crend()

const Foam::DLListBase::const_iterator & crend ( ) const

inline

End of list for reverse iterators.

Definition at line 87 of file DLListBaseI.H.

References iterator_rend().

Referenced by crbegin(), and DLListBase::const_iterator::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ first() [1/2]

link * first ( )

inline

Return first entry.

FOAM_DEPRECATED_FOR(2022-10, "front()")

Definition at line 460 of file DLListBase.H.

References first(), and front().

Referenced by first().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ first() [2/2]

const link * first ( ) const

inline

Return const access to first entry.

FOAM_DEPRECATED_FOR(2022-10, "front()")

Definition at line 467 of file DLListBase.H.

References front().

Here is the call graph for this function:

◆ last() [1/2]

link * last ( )

inline

Return last entry.

FOAM_DEPRECATED_FOR(2022-10, "back()")

Definition at line 474 of file DLListBase.H.

References back().

Here is the call graph for this function:

◆ last() [2/2]

const link * last ( ) const

inline

Return const access to last entry.

FOAM_DEPRECATED_FOR(2022-10, "back()")

Definition at line 481 of file DLListBase.H.

References back().

Here is the call graph for this function:

◆ prepend()

void prepend ( link * item )

inline

Add at front of list.

FOAM_DEPRECATED_FOR(2022-10, "push_front()")

Definition at line 488 of file DLListBase.H.

References push_front().

Here is the call graph for this function:

◆ append()

void append ( link * item )

inline

Add at back of list.

FOAM_DEPRECATED_FOR(2022-10, "push_back()")

Definition at line 495 of file DLListBase.H.

References push_back().

Here is the call graph for this function:

◆ iterator

friend class iterator

friend

Definition at line 155 of file DLListBase.H.

◆ const_iterator

friend class const_iterator

friend

Definition at line 158 of file DLListBase.H.

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

src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.H
src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBase.C
src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBaseI.H

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DLListBase() [1/2]

◆ DLListBase() [2/2]

◆ ~DLListBase()

Member Function Documentation

◆ iterator_end()

◆ iterator_rend()

◆ iterator_first()

◆ iterator_last()

◆ operator=()

◆ empty()

◆ size()

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ push_front()

◆ push_back()

◆ swapUp()

◆ swapDown()

◆ removeHead()

◆ remove() [1/2]

◆ remove() [2/2]

◆ replace() [1/2]

◆ replace() [2/2]

◆ clear()

◆ swap()

◆ transfer()

◆ begin()

◆ cbegin()

◆ crbegin()

◆ end()

◆ cend()

◆ crend()

◆ first() [1/2]

◆ first() [2/2]

◆ last() [1/2]

◆ last() [2/2]

◆ prepend()

◆ append()

Friends And Related Symbol Documentation

◆ iterator

◆ const_iterator