A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers. The operator[] returns a reference to the object, not the pointer. More...
Inherits UPtrList< T >.
Inherited by DictionaryBase< PtrList< T >, T >, faBoundaryMesh, fvBoundaryMesh, IOPtrList< T >, pointBoundaryMesh, polyBoundaryMesh, and PtrDynList< T, SizeMin >.
Public Member Functions | |
constexpr | PtrList () noexcept |
Default construct. More... | |
PtrList (const label len) | |
Construct with specified size, each element initialized to nullptr. More... | |
PtrList (const PtrList< T > &list) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< T > &&list) noexcept | |
Move construct. More... | |
PtrList (UList< T *> &list) | |
Take ownership of pointers in the list, set old pointers to null. More... | |
template<class CloneArg > | |
PtrList (const PtrList< T > &list, const CloneArg &cloneArgs) | |
Copy construct using 'clone()' method on each element. More... | |
PtrList (PtrList< T > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< T > &list) | |
Copy construct using 'clone()' on each element of SLPtrList<T> More... | |
template<class INew > | |
PtrList (Istream &is, const INew &inew) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &is) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. Frees all pointers. More... | |
template<class... Args> | |
PtrList< T > | clone (Args &&... args) const |
Make a copy by cloning each of the list elements. More... | |
const T * | set (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
void | clear () |
Clear the PtrList. Delete allocated entries and set size to zero. More... | |
void | free () |
Free memory and nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Adjust size of PtrList. More... | |
void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. More... | |
template<class... Args> | |
T & | emplace_back (Args &&... args) |
Construct and append an element to the end of the list, return reference to the new list element. More... | |
void | push_back (T *ptr) |
Append an element to the end of the list. More... | |
void | push_back (std::unique_ptr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (autoPtr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | push_back (const refPtr< T > &ptr) |
Move or clone append a refPtr to the end of the list. More... | |
void | push_back (const tmp< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | push_back (PtrList< T > &&other) |
Move append another list to the end of this list. More... | |
template<class... Args> | |
T & | emplace_set (const label i, Args &&... args) |
Construct and set a new element at given position, (discard old element at that location). More... | |
template<class... Args> | |
T & | emplace (const label i, Args &&... args) |
Same as emplace_set() More... | |
template<class... Args> | |
T & | try_emplace (const label i, Args &&... args) |
Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
autoPtr< T > | set (const label i, T *ptr) |
Set element to given pointer and return old element (can be null) More... | |
autoPtr< T > | set (const label i, std::unique_ptr< T > &&ptr) |
Set element to given unique_ptr and return old element. More... | |
autoPtr< T > | set (const label i, autoPtr< T > &&ptr) |
Set element to given autoPtr and return old element. More... | |
autoPtr< T > | set (const label i, const refPtr< T > &ptr) |
Set element to given refPtr and return old element. More... | |
autoPtr< T > | set (const label i, const tmp< T > &ptr) |
Set element to given tmp and return old element. More... | |
autoPtr< T > | release (const label i) |
Release ownership of the pointer at the given position. More... | |
void | transfer (PtrList< T > &list) |
Transfer into this list and annul the argument list. More... | |
void | operator= (const PtrList< T > &list) |
Copy assignment. More... | |
void | operator= (PtrList< T > &&list) |
Move assignment. More... | |
void | push_back (autoPtr< T > &ptr)=delete |
Disallow push_back with autoPtr without std::move. More... | |
autoPtr< T > | set (const label i, autoPtr< T > &ptr) |
Set element to given autoPtr and return old element. More... | |
void | setSize (const label newLen) |
Same as resize() More... | |
void | append (autoPtr< T > &ptr) |
Move append an element to the end of the list. More... | |
void | append (T *ptr) |
Append an element to the end of the list. More... | |
void | append (std::unique_ptr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (autoPtr< T > &&ptr) |
Move append an element to the end of the list. More... | |
void | append (const refPtr< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | append (const tmp< T > &ptr) |
Move or clone append a tmp to the end of the list. More... | |
void | append (PtrList< T > &&other) |
Move append another list to the end of this list. More... | |
template<class... Args> | |
Foam::PtrList< T > | clone (Args &&... args) const |
Public Member Functions inherited from UPtrList< T > | |
constexpr | UPtrList () noexcept=default |
Default construct. More... | |
UPtrList (const label len) | |
Construct with specified size and set all entries to nullptr . More... | |
UPtrList (const UPtrList< T > &list) | |
Copy construct (shallow copies addresses) More... | |
UPtrList (UPtrList< T > &&list) noexcept | |
Move construct. More... | |
UPtrList (UPtrList< T > &list, bool reuse) | |
Construct as shallow copy or re-use as specified. More... | |
UPtrList (PtrList< T > &list) | |
Shallow copy from PtrList. More... | |
UPtrList (const UList< T *> &list) | |
Construct from UList of pointers (shallow copy) More... | |
UPtrList (UList< T > &list) | |
Construct from UList, taking the address of each list element. More... | |
bool | empty () const noexcept |
True if the list is empty (ie, size() is zero) More... | |
label | size () const noexcept |
The number of entries in the list. More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
label | count_nonnull () const noexcept |
The number of non-nullptr entries in the list. More... | |
T & | front () |
Reference to the first element of the list. More... | |
const T & | front () const |
Reference to first element of the list. More... | |
T & | back () |
Reference to the last element of the list. More... | |
const T & | back () const |
Reference to the last element of the list. More... | |
const T * | test (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | get (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
T * | get (const label i) |
Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
const T * | set (const label i) const |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More... | |
void | clear () |
Set list size to zero. More... | |
void | free () |
Nullify all entries. Does not change the list size. More... | |
void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr . More... | |
void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr . More... | |
label | squeezeNull () |
Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More... | |
void | trimTrailingNull () |
Reduce addressable list size to ignore any trailing null pointers. More... | |
void | push_back (T *ptr) |
Append an element to the end of the list. More... | |
void | push_back (UPtrList< T > &&other) |
Move append another list to the end of this list. More... | |
void | swap (UPtrList< T > &list) noexcept |
Swap content. More... | |
void | transfer (UPtrList< T > &list) |
Transfer contents into this list and annul the argument. More... | |
T * | set (const label i, T *ptr) |
Set element to specified pointer and return the old list element, which can be a nullptr. More... | |
void | reorder (const labelUList &oldToNew, const bool check=false) |
Reorder elements. Reordering must be unique (ie, shuffle). More... | |
void | sortOrder (const labelUList &order, const bool check=false) |
Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More... | |
void | checkNonNull () const |
Check and raise FatalError if any nullptr exists in the list. More... | |
const T & | at (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
T & | at (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. More... | |
const T & | operator[] (const label i) const |
Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
T & | operator[] (const label i) |
Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More... | |
FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const | |
Deprecated(2022-09) - same as get() More... | |
void | operator= (const UPtrList< T > &list) |
Copy assignment (shallow copies addresses) More... | |
void | operator= (UPtrList< T > &&list) |
Move assignment. More... | |
T ** | begin_ptr () noexcept |
Iterator to begin of raw pointers traversal (use with caution) More... | |
T ** | end_ptr () noexcept |
Iterator beyond end of raw pointers traversal (use with caution) More... | |
iterator | begin () |
Return iterator to begin traversal of non-nullptr entries. More... | |
iterator | end () noexcept |
Return iterator beyond end of UPtrList traversal. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | cend () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversal of non-nullptr entries. More... | |
const_iterator | end () const noexcept |
Return const_iterator beyond end of UPtrList traversal. More... | |
void | setSize (const label n) |
Alias for resize() More... | |
T & | first () |
Reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. More... | |
void | append (T *ptr) |
Append an element to the end of the list. More... | |
void | append (UPtrList< T > &&other) |
Move append another list to the end of this list. More... | |
label | count () const noexcept |
The number of non-nullptr entries in the list. More... | |
Protected Member Functions | |
template<class INew > | |
void | readIstream (Istream &is, const INew &inew) |
Read from Istream using Istream constructor class. More... | |
Protected Member Functions inherited from UPtrList< T > | |
void | setAddressableSize (const label n) noexcept |
Adjust addressable size. More... | |
label | find_next (label pos) const |
The next non-null entry after the specified position. More... | |
UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept | |
Low-level move construct. More... | |
Friends | |
Istream & | operator>> (Istream &is, PtrList< T > &list) |
Read from Istream, discarding contents of existing list. More... | |
Additional Inherited Members | |
Public Types inherited from UPtrList< T > | |
typedef T | value_type |
Type of values the list contains. More... | |
typedef T & | reference |
A non-const reference to the value_type. More... | |
typedef const T & | const_reference |
A const reference to the value_type. More... | |
Protected Attributes inherited from UPtrList< T > | |
Detail::PtrListDetail< T > | ptrs_ |
The list of pointers. More... | |
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers. The operator[] returns a reference to the object, not the pointer.
|
inlinenoexcept |
Default construct.
Definition at line 29 of file PtrListI.H.
|
inlineexplicit |
Construct with specified size, each element initialized to nullptr.
Definition at line 36 of file PtrListI.H.
Copy construct using 'clone()' method on each element.
Definition at line 43 of file PtrListI.H.
Move construct.
Definition at line 50 of file PtrListI.H.
Take ownership of pointers in the list, set old pointers to null.
Definition at line 57 of file PtrListI.H.
Copy construct using 'clone()' method on each element.
Definition at line 69 of file PtrListI.H.
Construct from Istream using given Istream constructor class.
Definition at line 143 of file PtrListIO.C.
Construct from Istream using default Istream constructor class.
Definition at line 150 of file PtrListIO.C.
Read from Istream using Istream constructor class.
Definition at line 30 of file PtrListIO.C.
Make a copy by cloning each of the list elements.
Referenced by faMeshDistributor::distribute(), and fvMeshTools::newMesh().
|
inline |
Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
The return value can be tested as a bool.
Definition at line 159 of file PtrList.H.
Referenced by fvMeshAdder::add(), polyMeshAdder::add(), cellTable::addCellZones(), phaseSystem::addField(), viewFactor::calculate(), adjointSolverManager::constraintSensitivities(), diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), boundaryMesh::deletePatch(), faMeshDistributor::distribute(), fvMeshDistribute::distribute(), multiphaseSystem::dragCoeffs(), faBoundaryMesh::edgeFaces(), faBoundaryMesh::edgeLabels(), extrudePatchMesh::extrudePatchMesh(), faBoundaryMesh::faBoundaryMesh(), polyBoundaryMesh::faceCells(), phaseSystem::fillFields(), forAll(), lduPrimitiveMesh::gather(), surfaceZonesInfo::getAllClosedNamedSurfaces(), surfaceZonesInfo::getClosedNamedSurfaces(), surfaceZonesInfo::getInsidePointNamedSurfaces(), surfaceZonesInfo::getNamedSurfaces(), surfaceZonesInfo::getStandaloneNamedSurfaces(), surfaceZonesInfo::getUnclosedNamedSurfaces(), interRegionExplicitPorositySource::initialise(), viewFactor::initialise(), PDRblock::innerMesh(), faBoundaryMesh::interfaces(), LUscalarMatrix::LUscalarMatrix(), fvMeshAdder::MapDimFields(), volSurfaceMapping::mapInternalToSurface(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), Cloud< passivePositionParticle >::move(), faMeshTools::newMesh(), boundaryMesh::patchify(), polyBoundaryMesh::polyBoundaryMesh(), RecycleInteraction< CloudType >::postEvolve(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), multiRegion::read(), boundaryMesh::read(), externalCoupled::readDataMaster(), polyMesh::readUpdate(), refinementSurfaces::refinementSurfaces(), refinementFeatures::regionEdgeTrees(), snappySnapDriver::repatchToSurface(), liquidFilmBase::Up(), trackingInverseDistance::update(), cellVolumeWeight::update(), inverseDistance::update(), designVariablesUpdate::updateGradientsAndValues(), OFstreamCollator::write(), externalCoupled::writeDataMaster(), streamLineBase::writeToFile(), and ZoneMesh< cellZone, polyMesh >::ZoneMesh().
|
inline |
Clear the PtrList. Delete allocated entries and set size to zero.
Definition at line 81 of file PtrListI.H.
Referenced by Relaxation< CloudType >::cacheFields(), Explicit< CloudType >::cacheFields(), faBoundaryMesh::clear(), polyBoundaryMesh::clear(), functionObjectList::clear(), fvMatrix< Type >::clear(), functionObjectList::read(), sampledSets::read(), sampledSurfaces::read(), and decompositionMethod::setConstraints().
|
inline |
Free memory and nullify all entries. Does not change the list size.
Definition at line 89 of file PtrListI.H.
void resize | ( | const label | newLen | ) |
Adjust size of PtrList.
New entries are initialized to nullptr, removed entries are deleted
Definition at line 95 of file PtrList.C.
Referenced by cellTable::addCellZones(), polyTopoChange::addMesh(), fvMeshTools::addPatch(), faBoundaryMesh::checkParallelSync(), polyBoundaryMesh::checkParallelSync(), faMeshDistributor::distribute(), faBoundaryMesh::faBoundaryMesh(), volSurfaceMapping::mapInternalToSurface(), faMeshTools::newMesh(), polyBoundaryMesh::polyBoundaryMesh(), multiRegion::read(), sampledSurfaces::read(), faBoundaryMeshEntries::removeProcPatches(), polyBoundaryMeshEntries::removeProcPatches(), PtrList< transferModel >::setSize(), and ZoneMesh< cellZone, polyMesh >::ZoneMesh().
|
inline |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr
entries.
Definition at line 96 of file PtrListI.H.
Referenced by polyMesh::readUpdate().
|
inline |
Construct and append an element to the end of the list, return reference to the new list element.
Definition at line 105 of file PtrListI.H.
Referenced by surfaceZonesInfo::addCellZone(), surfaceZonesInfo::addFaceZone(), meshRefinement::addPointZone(), ZoneMesh< cellZone, polyMesh >::cfindZone(), ZoneMesh< cellZone, polyMesh >::findZoneID(), and streamLineBase::trimToBox().
|
inline |
Append an element to the end of the list.
Definition at line 114 of file PtrListI.H.
Referenced by adjointSimple::addTopOFvOptions(), PtrList< transferModel >::append(), meshRefinement::appendPatch(), and designVariablesUpdate::updateGradientsAndValues().
|
inline |
Move append an element to the end of the list.
Definition at line 121 of file PtrListI.H.
Move append an element to the end of the list.
Definition at line 128 of file PtrListI.H.
Move or clone append a refPtr to the end of the list.
Definition at line 135 of file PtrListI.H.
Move or clone append a tmp to the end of the list.
Definition at line 142 of file PtrListI.H.
Move append another list to the end of this list.
Definition at line 149 of file PtrListI.H.
|
inline |
Construct and set a new element at given position, (discard old element at that location).
i | - the location to set |
args | arguments to forward to the constructor of the element |
Definition at line 174 of file PtrListI.H.
Referenced by fvMeshDistribute::distribute(), and LUscalarMatrix::LUscalarMatrix().
|
inline |
Same as emplace_set()
Definition at line 185 of file PtrListI.H.
|
inline |
Like emplace_set() but will not overwrite an occupied (non-null) location.
i | - the location to set (unless already defined) |
args | arguments to forward to the constructor of the element |
Definition at line 193 of file PtrListI.H.
|
inline |
Set element to given pointer and return old element (can be null)
No-op if the new pointer value is identical to the current content.
Definition at line 205 of file PtrListI.H.
|
inline |
Set element to given unique_ptr and return old element.
Definition at line 217 of file PtrListI.H.
|
inline |
Set element to given autoPtr and return old element.
Definition at line 228 of file PtrListI.H.
|
inline |
Set element to given refPtr and return old element.
Definition at line 239 of file PtrListI.H.
|
inline |
Set element to given tmp and return old element.
Definition at line 250 of file PtrListI.H.
|
inline |
Release ownership of the pointer at the given position.
Out of bounds addressing is a no-op and returns nullptr.
Definition at line 260 of file PtrListI.H.
Referenced by isoSurfacePoint::isoSurfacePoint(), and PtrDynList< Foam::profilingInformation >::push_back().
Transfer into this list and annul the argument list.
Definition at line 272 of file PtrListI.H.
Referenced by wallDistData< TransferType >::correct(), meshWave::correct(), directionalMeshWave::correct(), and functionObjectList::read().
Move assignment.
Definition at line 287 of file PtrListI.H.
|
inline |
Same as resize()
Definition at line 337 of file PtrList.H.
Referenced by fvMeshAdder::add(), polyMeshAdder::add(), surfaceZonesInfo::addFaceZonesToMesh(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), FacePostProcessing< CloudType >::FacePostProcessing(), lduPrimitiveMesh::gather(), marchingCells::initialise(), interRegionExplicitPorositySource::initialise(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), searchableSurfaces::searchableSurfaces(), duplicatePoints::setRefinement(), trackingInverseDistance::update(), and OFstreamCollator::write().
Move append an element to the end of the list.
FOAM_DEPRECATED_FOR(2022-10, "push_back()")
Definition at line 344 of file PtrList.H.
Referenced by singleProcessorFaceSets::add(), triSurfaceLoader::load(), ParticlePostProcessing< CloudType >::postFace(), and ParticleHistogram< CloudType >::postFace().
|
inline |
|
inline |
Foam::PtrList<T> clone | ( | Args &&... | args | ) | const |
Read from Istream, discarding contents of existing list.