Helper functions for managing PackedLink variables. More...

#include <PackedLinkVectorHelper.h>

Inheritance diagram for SG::detail::PackedLinkVectorHelper< CONT >:

Collaboration diagram for SG::detail::PackedLinkVectorHelper< CONT >:

Public Types
using	Link_t = ElementLink< CONT >
	The (linked) data links. More...

using	DLink_t = DataLink< CONT >

using	DataLink_span = detail::AuxDataSpan< DataLink< CONT > >

using	const_DataLink_span = detail::AuxDataConstSpan< DataLink< CONT > >

using	PLink_t = PackedLink< CONT >
	The PackedLinks. More...

using	PackedLink_span = CxxUtils::span< PLink_t >

using	DataLinkBase = ::DataLinkBase

typedef void	InitLinkFunc_t(DataLinkBase &dl, sgkey_t sgkey, IProxyDict *sg)
	Function to initialize a `DataLink` to a given hashed key. More...

using	DataLinkBase_span = detail::AuxDataSpan< DataLinkBase >
	Spans over the linked `DataLinks`. More...

using	const_DataLinkBase_span = detail::AuxDataConstSpan< DataLinkBase >

using	PackedLinkBase_span = CxxUtils::span< PackedLinkBase >
	Span over links. More...

Static Public Member Functions
static std::pair< size_t, bool >	findCollection (LinkedVector &linkedVec, sgkey_t sgkey, DataLinkBase_span &links, IProxyDict *sg)
	Find the collection index in the linked DataLinks for a sgkey. More...

static bool	updateLinks (IAuxTypeVector &linkedVec, SG::PackedLink< CONT > ptr, size_t n, const const_DataLinkBase_span &srcDLinks, IProxyDict sg)
	Update collection index of a collection of `PackedLink`. More...

static bool	updateLinks (IAuxTypeVector &linkedVec, SG::PackedLink< CONT > ptr, size_t n, const IAuxTypeVector &srclv, IProxyDict sg)
	Update collection index of a collection of `PackedLink`. More...

template<class VALLOC >
static bool	updateLinks (IAuxTypeVector &linkedVec, std::vector< SG::PackedLink< CONT >, VALLOC > ptr, size_t n, const IAuxTypeVector &srclv, IProxyDict sg)
	Update collection index of a collection of `PackedLink` vectors. More...

template<class VALLOC , ElementLinkRange< CONT > RANGE>
static bool	assignVElt (std::vector< PLink_t, VALLOC > &velt, IAuxTypeVector &linkedVec, DataLinkBase_span &dlinks, const RANGE &x)
	Assign a range of `ElementLink` to a vector of `Packedlink`. More...

template<class VALLOC , ElementLinkRange< CONT > RANGE>
static bool	insertVElt (std::vector< PLink_t, VALLOC > &velt, size_t pos, IAuxTypeVector &linkedVec, DataLinkBase_span &dlinks, const RANGE &x)
	Insert a range of `ElementLink` into a vector of `Packedlink`. More...

static bool	applyThinning (IAuxTypeVector &linkedVec, PackedLink< CONT > ptr, size_t n, DataLinkBase_span &dlinks, const SG::ThinningCache tc, IProxyDict *sg)
	Apply thinning to packed links, to prepare them for output. More...

static IProxyDict *	storeFromSpan (DataLinkBase_span &links)
	Return the current store from the first valid link in the span. More...

static DataLinkBase_span	getLinkBaseSpan (IAuxTypeVector &linkedVec)
	Return a span over all the linked `DataLinkBase's`, from the linked vector. More...

static const_DataLinkBase_span	getLinkBaseSpan (const IAuxTypeVector &linkedVec)
	Return a span over all the linked DataLinks. More...

static std::pair< size_t, bool >	findCollectionBase (LinkedVector &linkedVec, sgkey_t sgkey, DataLinkBase_span &links, IProxyDict sg, InitLinkFunc_t initLinkFunc)
	Find the collection index in the linked `DataLinks` for a sgkey. More...

static bool	updateLinksBase (IAuxTypeVector &linkedVec, PackedLinkBase_span &links, const const_DataLinkBase_span &srcDLinks, IProxyDict sg, InitLinkFunc_t initLinkFunc)
	Update collection index of a collection of `PackedLink`. More...

static bool	applyThinningBase (IAuxTypeVector &linkedVec, PackedLinkBase_span &links, DataLinkBase_span &dlinks, const SG::ThinningCache tc, IProxyDict sg, InitLinkFunc_t *initLinkFunc)
	Apply thinning to packed links, to prepare them for output. More...

Static Private Member Functions
static void	initLink (DataLinkBase &dl, sgkey_t sgkey, IProxyDict *sg)
	Initialize a `DataLink`. More...

static bool	resizeLinks (LinkedVector &linkedVec, size_t sz)
	Resize a linked vector of `DataLinks`. More...

Detailed Description

template<class CONT>
class SG::detail::PackedLinkVectorHelper< CONT >

Helper functions for managing PackedLink variables.

The template argument is the target type of the links.

Definition at line 254 of file PackedLinkVectorHelper.h.

Member Typedef Documentation

◆ const_DataLink_span

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::const_DataLink_span = detail::AuxDataConstSpan<DataLink<CONT> >

Definition at line 262 of file PackedLinkVectorHelper.h.

◆ const_DataLinkBase_span

using SG::detail::PackedLinkVectorHelperBase::const_DataLinkBase_span = detail::AuxDataConstSpan<DataLinkBase>

inherited

Definition at line 70 of file PackedLinkVectorHelper.h.

◆ DataLink_span

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::DataLink_span = detail::AuxDataSpan<DataLink<CONT> >

Definition at line 261 of file PackedLinkVectorHelper.h.

◆ DataLinkBase

using SG::detail::PackedLinkVectorHelperBase::DataLinkBase = ::DataLinkBase

inherited

Definition at line 57 of file PackedLinkVectorHelper.h.

◆ DataLinkBase_span

using SG::detail::PackedLinkVectorHelperBase::DataLinkBase_span = detail::AuxDataSpan<DataLinkBase>

inherited

Spans over the linked DataLinks.

These hold the span data by reference, so they update if the underlying vector changes.

Definition at line 69 of file PackedLinkVectorHelper.h.

◆ DLink_t

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::DLink_t = DataLink<CONT>

Definition at line 260 of file PackedLinkVectorHelper.h.

◆ InitLinkFunc_t

typedef void SG::detail::PackedLinkVectorHelperBase::InitLinkFunc_t(DataLinkBase &dl, sgkey_t sgkey, IProxyDict *sg)

inherited

Function to initialize a DataLink to a given hashed key.

Definition at line 61 of file PackedLinkVectorHelper.h.

◆ Link_t

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::Link_t = ElementLink<CONT>

The (linked) data links.

Definition at line 259 of file PackedLinkVectorHelper.h.

◆ PackedLink_span

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::PackedLink_span = CxxUtils::span<PLink_t>

Definition at line 266 of file PackedLinkVectorHelper.h.

◆ PackedLinkBase_span

using SG::detail::PackedLinkVectorHelperBase::PackedLinkBase_span = CxxUtils::span<PackedLinkBase>

inherited

Span over links.

Definition at line 127 of file PackedLinkVectorHelper.h.

◆ PLink_t

template<class CONT >

using SG::detail::PackedLinkVectorHelper< CONT >::PLink_t = PackedLink<CONT>

The PackedLinks.

Definition at line 265 of file PackedLinkVectorHelper.h.

Member Function Documentation

◆ applyThinning()

template<class CONT >

static bool SG::detail::PackedLinkVectorHelper< CONT >::applyThinning	(	IAuxTypeVector &	linkedVec,
		PackedLink< CONT > *	ptr,
		size_t	n,
		DataLinkBase_span &	dlinks,
		const SG::ThinningCache *	tc,
		IProxyDict *	sg
	)

static

Apply thinning to packed links, to prepare them for output.

Parameters

linkedVec	Interface for the linked vector of `DataLinks`.
ptr	Pointer to the start of the PackedLink collection.
n	Length of the PackedLink collection.
dlinks	Span over the source link vector, as `DataLinkBase`.
tc	The `ThinningCache` for this object, if it exists.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.

Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ applyThinningBase()

bool SG::detail::PackedLinkVectorHelperBase::applyThinningBase	(	IAuxTypeVector &	linkedVec,
		PackedLinkBase_span &	links,
		DataLinkBase_span &	dlinks,
		const SG::ThinningCache *	tc,
		IProxyDict *	sg,
		InitLinkFunc_t *	initLinkFunc
	)

staticinherited

Apply thinning to packed links, to prepare them for output.

Parameters

linkedVec	Interface for the linked vector of `DataLinks`.
links	Span over the links to update, as `PackedLinkBase`.
dlinks	Span over the source link vector, as `DataLinkBase`.
tc	The `ThinningCache` for this object, if it exists.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.
initFunc	Function to initialize a `DataLink` to a given hashed key.

Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

Definition at line 130 of file PackedLinkVectorHelper.cxx.

 {
   bool cacheValid = true;
   for (PackedLinkBase& l : links) {
     if (l.collection() != 0) {
       sgkey_t sgkey = dlinks[l.collection()].key();
       size_t index = l.index();
       sgkey_t sgkey_out = sgkey;
       size_t index_out = index;
       if (sg) {
         sg->tryELRemap (sgkey, index, sgkey_out, index_out);
       }
       DataProxyHolder::thin (sgkey_out, index_out, tc);
       l.setIndex (index_out);
       if (sgkey_out != sgkey) {
         LinkedVector lv (linkedVec);
         auto [index, flag] = findCollectionBase (lv, sgkey_out, dlinks,
                                                  sg, initLinkFunc);
         l.setCollection (index);
         cacheValid &= flag;
       }
     }
   }
   return cacheValid;
 }

◆ assignVElt()

template<class CONT >

template<class VALLOC , ElementLinkRange< CONT > RANGE>

static bool SG::detail::PackedLinkVectorHelper< CONT >::assignVElt	(	std::vector< PLink_t, VALLOC > &	velt,
		IAuxTypeVector &	linkedVec,
		DataLinkBase_span &	dlinks,
		const RANGE &	x
	)

static

Assign a range of ElementLink to a vector of Packedlink.

Parameters

vect	The vector of `PackedLink` to which to assign.
linkedVec	Interface for the linked vector of DataLinks.
dlinks	Span over the link vector, as `DataLinkBase`.
x	The range to assign.

Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ findCollection()

template<class CONT >

static std::pair<size_t, bool> SG::detail::PackedLinkVectorHelper< CONT >::findCollection	(	LinkedVector &	linkedVec,
		sgkey_t	sgkey,
		DataLinkBase_span &	links,
		IProxyDict *	sg
	)

static

Find the collection index in the linked DataLinks for a sgkey.

Parameters

linkedVec	How to find the linked vector.
sgkey	Hashed key for which to search.
links	Span over the vector of DataLinks. May be modified if the vector grows.
sg	The `IProxyDict` of the current store. May be null to use the global, thread-local default.

Searches for a DataLink matching sgkey in the linked vector. If not found, then a new entry is added. Returns a pair (INDEX, CACHEVALID). INDEX is the index in the vector of the sgkey (and thus the collection index to store in the PackedLink). CACHEVALID is true if it is known that the payload of the vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ findCollectionBase()

std::pair< size_t, bool > SG::detail::PackedLinkVectorHelperBase::findCollectionBase	(	LinkedVector &	linkedVec,
		sgkey_t	sgkey,
		DataLinkBase_span &	links,
		IProxyDict *	sg,
		InitLinkFunc_t *	initLinkFunc
	)

staticinherited

Find the collection index in the linked DataLinks for a sgkey.

Parameters

linkedVec	How to find the linked vector.
sgkey	Hashed key for which to search.
links	Span over the vector of `DataLinks`, as `DataLinkBase`. May be modified if the vector grows.
sg	The `IProxyDict` of the current store. May be null to use the global, thread-local default.
initFunc	Function to initialize a `DataLink` to a given hashed key.

Searches for a DataLinkBase matching sgkey in the linked vector. If not found, then a new entry is added. Returns a pair (INDEX, CACHEVALID). INDEX is the index in the vector of the sgkey (and thus the collection index to store in the PackedLink). CACHEVALID is true if it is known that the payload of the vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

This does not actually initialize the DataLink if the vector grows. The caller should test if the size of the span changed and if so, initialize the last element using sgkey.

Definition at line 42 of file PackedLinkVectorHelper.cxx.

 {
   if (sgkey == 0) {
     if (!links.empty())
       return std::make_pair (0u, true);
   }
   else {
     for (size_t i = 1; i < links.size(); ++i) {
       if (links[i].key() == sgkey) return std::make_pair (i, true);
     }
   }
   size_t oldsz = links.size();
   size_t newsz = oldsz+1;
   if (oldsz == 0 && sgkey != 0) {
     newsz = 2;
   }
   bool cacheValid = resizeLinks (linkedVec, newsz);
   initLinkFunc (links.back(), sgkey, sg);
   return std::make_pair (links.size() - 1, cacheValid);
 }

◆ getLinkBaseSpan() [1/2]

static const_DataLinkBase_span SG::detail::PackedLinkVectorHelperBase::getLinkBaseSpan ( const IAuxTypeVector & linkedVec )

staticinherited

Return a span over all the linked DataLinks.

from the linked vector.

Parameters

linkedVec Interface for the linked vector of DataLinks.

◆ getLinkBaseSpan() [2/2]

static DataLinkBase_span SG::detail::PackedLinkVectorHelperBase::getLinkBaseSpan ( IAuxTypeVector & linkedVec )

staticinherited

Return a span over all the linked DataLinkBase's, from the linked vector.

Parameters

linkedVec Interface for the linked vector of DataLinkBase's.

◆ initLink()

template<class CONT >

static void SG::detail::PackedLinkVectorHelper< CONT >::initLink	(	DataLinkBase &	dl,
		sgkey_t	sgkey,
		IProxyDict *	sg
	)

staticprivate

Initialize a DataLink.

Parameters

dl	The link to initialize. Really of type `DLink_t`.
sgkey	Hashed key to which to initialize the link.
sg	The `IProxyDict` of the current store. May be null to use the global, thread-local default.

◆ insertVElt()

template<class CONT >

template<class VALLOC , ElementLinkRange< CONT > RANGE>

static bool SG::detail::PackedLinkVectorHelper< CONT >::insertVElt	(	std::vector< PLink_t, VALLOC > &	velt,
		size_t	pos,
		IAuxTypeVector &	linkedVec,
		DataLinkBase_span &	dlinks,
		const RANGE &	x
	)

static

Insert a range of ElementLink into a vector of Packedlink.

Parameters

vect	The vector of `PackedLink` to which to assign.
pos	The position at which to do the insertion.
linkedVec	Interface for the linked vector of DataLinks.
dlinks	Span over the link vector, as `DataLinkBase`.
x	The range to assign.

Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ resizeLinks()

bool SG::detail::PackedLinkVectorHelperBase::resizeLinks	(	LinkedVector &	linkedVec,
		size_t	sz
	)

staticprivateinherited

Resize a linked vector of DataLinks.

Parameters

linkedVec	How to find the linked vector.
sz	The new size of the container.

Returns true if it is known the the underlying vector did not move.

Definition at line 171 of file PackedLinkVectorHelper.cxx.

 {
   return linkedVec->resize (sz);
 }

◆ storeFromSpan()

static IProxyDict* SG::detail::PackedLinkVectorHelperBase::storeFromSpan ( DataLinkBase_span & links )

staticinherited

Return the current store from the first valid link in the span.

If there are no valid links, then return the global default.

Parameters

links The span of links.

◆ updateLinks() [1/3]

template<class CONT >

static bool SG::detail::PackedLinkVectorHelper< CONT >::updateLinks	(	IAuxTypeVector &	linkedVec,
		SG::PackedLink< CONT > *	ptr,
		size_t	n,
		const const_DataLinkBase_span &	srcDLinks,
		IProxyDict *	sg
	)

static

Update collection index of a collection of PackedLink.

Parameters

linkedVec	Interface for the linked vector of DataLinks.
ptr	Pointer to the start of the PackedLink collection.
n	Length of the PackedLink collection.
srcDLinks	Span over the vector of DataLinks for the source container of the links.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.

To be used after links have been copied/moved from one container to another. The collection indices are updated to be appropriate for the destination container. Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ updateLinks() [2/3]

template<class CONT >

static bool SG::detail::PackedLinkVectorHelper< CONT >::updateLinks	(	IAuxTypeVector &	linkedVec,
		SG::PackedLink< CONT > *	ptr,
		size_t	n,
		const IAuxTypeVector &	srclv,
		IProxyDict *	sg
	)

static

Update collection index of a collection of PackedLink.

Parameters

linkedVec	Interface for the linked vector of DataLinks.
ptr	Pointer to the start of the PackedLink collection.
n	Length of the PackedLink collection.
srclv	Interface for the linked vector for the source container of the links.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.

To be used after links have been copied/moved from one container to another. The collection indices are updated to be appropriate for the destination container. Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ updateLinks() [3/3]

template<class CONT >

template<class VALLOC >

static bool SG::detail::PackedLinkVectorHelper< CONT >::updateLinks	(	IAuxTypeVector &	linkedVec,
		std::vector< SG::PackedLink< CONT >, VALLOC > *	ptr,
		size_t	n,
		const IAuxTypeVector &	srclv,
		IProxyDict *	sg
	)

static

Update collection index of a collection of PackedLink vectors.

Parameters

linkedVec	Interface for the linked vector of DataLinks.
ptr	Pointer to the start of the PackedLink vector collection.
n	Length of the PackedLink vector collection.
srclv	Interface for the linked vector for the source container of the links.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.

To be used after links have been copied/moved from one container to another. The collection indices are updated to be appropriate for the destination container. Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

◆ updateLinksBase()

bool SG::detail::PackedLinkVectorHelperBase::updateLinksBase	(	IAuxTypeVector &	linkedVec,
		PackedLinkBase_span &	links,
		const const_DataLinkBase_span &	srcDLinks,
		IProxyDict *	sg,
		InitLinkFunc_t *	initLinkFunc
	)

staticinherited

Update collection index of a collection of PackedLink.

Parameters

linkedVec	Interface for the linked vector of `DataLinks`.
links	Span over the links to update, as `PackedLinkBase`.
srcDLinks	Span over the source link vector, as `DataLinkBase`.
sg	The `IProxyDict` of the current store. If null, take it from the links in `srcDlinks`, or use the global, thread-local default.
initFunc	Function to initialize a `DataLink` to a given hashed key.

To be used after links have been copied/moved from one container to another. The collection indices are updated to be appropriate for the destination container. Returns true if it is known that the payload of the linked vector has not moved. (If this is false, any caches/iterators must be assumed to be invalid.)

Definition at line 87 of file PackedLinkVectorHelper.cxx.

 {
   DataLinkBase_span DLinks = getLinkBaseSpan (linkedVec);
   if (sg == nullptr) {
     sg = storeFromSpan (DLinks);
   }
   bool cacheValid = true;
   for (PackedLinkBase& l : links) {
     size_t in_coll = l.collection();
     if (in_coll > 0) {
       LinkedVector lv (linkedVec);
       auto [index, thisValid] = findCollectionBase
         (lv, srcDLinks.at(in_coll).key(), DLinks, sg, initLinkFunc);
       l.setCollection (index);
       cacheValid &= thisValid;
     }
   }
   return cacheValid;
 }

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

PackedLinkVectorHelper.h

Public Types

Static Public Member Functions

Static Private Member Functions

Detailed Description

template<class CONT> class SG::detail::PackedLinkVectorHelper< CONT >

Member Typedef Documentation

◆ const_DataLink_span

◆ const_DataLinkBase_span

◆ DataLink_span

◆ DataLinkBase

◆ DataLinkBase_span

◆ DLink_t

◆ InitLinkFunc_t

◆ Link_t

◆ PackedLink_span

◆ PackedLinkBase_span

◆ PLink_t

Member Function Documentation

◆ applyThinning()

◆ applyThinningBase()

◆ assignVElt()

◆ findCollection()

◆ findCollectionBase()

◆ getLinkBaseSpan() [1/2]

◆ getLinkBaseSpan() [2/2]

◆ initLink()

◆ insertVElt()

◆ resizeLinks()

◆ storeFromSpan()

◆ updateLinks() [1/3]

◆ updateLinks() [2/3]

◆ updateLinks() [3/3]

◆ updateLinksBase()

template<class CONT>
class SG::detail::PackedLinkVectorHelper< CONT >