Abstract interface for manipulating vectors of arbitrary types. More...

#include <IAuxTypeVector.h>

Collaboration diagram for SG::IAuxTypeVector:

Public Member Functions
	IAuxTypeVector (auxid_t auxid, bool isLinked)
	Constructor. More...

virtual	~IAuxTypeVector ()=default
	Destructor. More...

virtual std::unique_ptr< IAuxTypeVector >	clone () const =0
	Make a copy of this vector. More...

virtual void *	toPtr ()=0
	Return a pointer to the start of the vector's data. More...

virtual const void *	toPtr () const =0
	Return a pointer to the start of the vector's data. More...

virtual void *	toVector ()=0
	Return a pointer to the STL vector itself. More...

virtual size_t	size () const =0
	Return the size of the vector. More...

virtual bool	resize (size_t sz)=0
	Change the size of the vector. More...

virtual void	reserve (size_t sz)=0
	Change the capacity of the vector. More...

virtual bool	shift (size_t pos, ptrdiff_t offs)=0
	Shift the elements of the vector. More...

virtual bool	insertMove (size_t pos, void *src, size_t src_pos, size_t src_n, IAuxStore &srcStore)=0
	Insert elements into the vector via move semantics. More...

virtual bool	setOption (const AuxDataOption &)
	Set an option for this variable. More...

virtual std::unique_ptr< IAuxTypeVector >	toPacked ()
	Make a packed version of the variable. More...

virtual const std::type_info *	objType () const
	Return the type of the complete object to be saved. More...

virtual std::unique_ptr< IAuxTypeVector >	linkedVector ()
	Return `IAuxTypeVector` of a linked variable, if there is one. More...

bool	isLinked () const
	Return true if this variable is linked from another one. More...

auxid_t	auxid () const
	Return the auxid of the variable this vector represents. More...

const AuxDataSpanBase &	getDataSpan () const
	Return a reference to a description of this vector's start+size. More...

Protected Member Functions
virtual AuxDataSpanBase	getDataSpanImpl () const =0
	Return a span object describing the current vector. More...

void	storeDataSpan (void *beg, size_t size)
	Update the stored span. More...

void	resetDataSpan ()
	Invalidate the stored span. More...

Private Attributes
auxid_t	m_auxid
	The auxid of the variable this vector represents. More...

bool	m_isLinked
	True if this variable is linked from another one. More...

CxxUtils::CachedValue< AuxDataSpanBase >	m_span
	Description of the vector start+size. More...

Detailed Description

Abstract interface for manipulating vectors of arbitrary types.

The auxiliary data for a container are stored in a set of STL vectors, one for each data item. However, we want to allow storing arbitrary types in these vectors. Thus, we define this abstract interface to operate on the vectors. The concrete version of this will own one vector.

Definition at line 41 of file IAuxTypeVector.h.

Constructor & Destructor Documentation

◆ IAuxTypeVector()

SG::IAuxTypeVector::IAuxTypeVector	(	auxid_t	auxid,
		bool	isLinked
	)

inline

Constructor.

Parameters

auxid	The ID of the variable that this vector represents.
isLinked	True if this variable is linked from another one.

Definition at line 49 of file IAuxTypeVector.h.

     : m_auxid (auxid),
       m_isLinked (isLinked)
   {
   }

◆ ~IAuxTypeVector()

virtual SG::IAuxTypeVector::~IAuxTypeVector ( )

virtualdefault

Destructor.

Member Function Documentation

◆ auxid()

auxid_t SG::IAuxTypeVector::auxid ( ) const

inline

Return the auxid of the variable this vector represents.

Definition at line 232 of file IAuxTypeVector.h.

   {
     return m_auxid;
   }

◆ clone()

virtual std::unique_ptr<IAuxTypeVector> SG::IAuxTypeVector::clone ( ) const

pure virtual

Make a copy of this vector.

Implemented in SG::AuxTypeVectorHolder< T, CONT >, SG::RootAuxVector, xAOD::AuxPersVector< std::vector< SG::PackedLink< TARG >, VALLOC >, VEC >, xAOD::TAuxVector, xAOD::AuxPersVector< SG::PackedLink< TARG >, VEC >, xAOD::AuxPersInfo< T >, xAOD::AuxPersVector< SG::JaggedVecElt< T >, VEC >, and xAOD::AuxPersVector< T, VEC >.

◆ getDataSpan()

const AuxDataSpanBase& SG::IAuxTypeVector::getDataSpan ( ) const

inline

Return a reference to a description of this vector's start+size.

This returns a reference to an AuxDataSpanBase, which gives the start and size of the vector. This object will be updated if the vector changes.

For low overhead, we want this to be a non-virtual function call. However, for variables being read, the usage pattern is that we first create the @IAuxTypeVector object, give the underlying std::vector object to ROOT, and then ROOT fills the vector without the involvement of the IAuxTypeVector. To be able to have this work correctly, we need to defer initializing the span object until the first time that getDataSpan gets called. We do this with a CachedValue. If the span has already been initialized, we just return it; otherwise, we make a virtual call to fetch the vector from the derived class.

Be aware: this is in principle a const-correctness violation, since AuxDataSpanBase has a non-const pointer to the start of the vector. But doing it properly is kind of painful, and as this interface is only meant to be used internally, it's likely not a real problem.

Definition at line 261 of file IAuxTypeVector.h.

   {
     if (!m_span.isValid()) {
       m_span.set (this->getDataSpanImpl());
     }
     return *m_span.ptr();
   }

◆ getDataSpanImpl()

virtual AuxDataSpanBase SG::IAuxTypeVector::getDataSpanImpl ( ) const

protectedpure virtual

Return a span object describing the current vector.

Used to initialize m_span the first time that getDataSpan is called.

Implemented in SG::AuxTypeVectorHolder< T, CONT >, SG::RootAuxVector, xAOD::AuxPersInfo< T >, and xAOD::TAuxVector.

◆ insertMove()

virtual bool SG::IAuxTypeVector::insertMove	(	size_t	pos,
		void *	src,
		size_t	src_pos,
		size_t	src_n,
		IAuxStore &	srcStore
	)

pure virtual

Insert elements into the vector via move semantics.

Parameters

pos	The starting index of the insertion.
src	Start of the vector containing the range of elements to insert.
src_pos	Position of the first element to insert.
src_n	Number of elements to insert.
srcStore	The source store.

beg and end define a range of container elements, with length len defined by the difference of the pointers divided by the element size.

The size of the container will be increased by len, with the elements starting at pos copied to pos+len.

The contents of the source range will then be moved to our vector starting at pos. This will be done via move semantics if possible; otherwise, it will be done with a copy.

Returns true if it is known that the vector's memory did not move, false otherwise.

◆ isLinked()

bool SG::IAuxTypeVector::isLinked ( ) const

inline

Return true if this variable is linked from another one.

This is inlined here rather than being a virtual function because this is frequently called from loops over auxids.

Definition at line 226 of file IAuxTypeVector.h.

226 { return m_isLinked; }

◆ linkedVector()

virtual std::unique_ptr<IAuxTypeVector> SG::IAuxTypeVector::linkedVector ( )

inlinevirtual

Return IAuxTypeVector of a linked variable, if there is one.

If the variable represented by this vector has a linked variable, then return its IAuxTypeVector. Otherwise, return nullptr. Beware of potential threading issues: the returned object is not locked, so it should not be modified in contexts where the parent container cannot be modified.

This returns a unique_ptr, so it can generally be called only once on a given instance. After that, it will return nullptr.

Definition at line 217 of file IAuxTypeVector.h.

217 { return nullptr; }

◆ objType()

virtual const std::type_info* SG::IAuxTypeVector::objType ( ) const

inlinevirtual

Return the type of the complete object to be saved.

For example, if the object is a std::vector, then we return the type_info of the vector. But if we're holding a PackedContainer, then we return the type_info of the PackedContainer.

Can return null if the operation is not supported. In that case, I/O will use the type found from the variable registry.

Reimplemented in SG::RootAuxVector, SG::AuxTypeVectorHolder< T, CONT >, and xAOD::AuxPersInfo< T >.

Definition at line 202 of file IAuxTypeVector.h.

202 { return 0; }

◆ reserve()

virtual void SG::IAuxTypeVector::reserve ( size_t sz )

pure virtual

Change the capacity of the vector.

Parameters

sz	The new vector capacity.

◆ resetDataSpan()

void SG::IAuxTypeVector::resetDataSpan ( )

inlineprotected

Invalidate the stored span.

Definition at line 297 of file IAuxTypeVector.h.

   {
     m_span.reset();
   }

◆ resize()

virtual bool SG::IAuxTypeVector::resize ( size_t sz )

pure virtual

Change the size of the vector.

Parameters

sz	The new vector size. Returns true if it is known that iterators have not been invalidated; false otherwise. (Will always return false when increasing the size of an empty container.)

◆ setOption()

virtual bool SG::IAuxTypeVector::setOption ( const AuxDataOption & )

inlinevirtual

Set an option for this variable.

Parameters

option The option to set.

The interpretation of the option depends on the particular representation of the variable provided by the concrete class.

Returns true if the option setting was successful; false otherwise.

Definition at line 172 of file IAuxTypeVector.h.

173 { return false; }

◆ shift()

virtual bool SG::IAuxTypeVector::shift	(	size_t	pos,
		ptrdiff_t	offs
	)

pure virtual

Shift the elements of the vector.

Parameters

pos	The starting index for the shift.
offs	The (signed) amount of the shift.

This operation shifts the elements in the vectors for all aux data items, to implement an insertion or deletion. offs may be either positive or negative.

If offs is positive, then the container is growing. The container size should be increased by offs, the element at pos moved to pos + offs, and similarly for following elements. The elements between pos and pos + offs should be default-initialized.

If offs is negative, then the container is shrinking. The element at pos should be moved to pos + offs, and similarly for following elements. The container should then be shrunk by -offs elements (running destructors as appropriate).

Returns true if it is known that iterators have not been invalidated; false otherwise. (Will always return false when increasing the size of an empty container.)

◆ size()

virtual size_t SG::IAuxTypeVector::size ( ) const

pure virtual

Return the size of the vector.

Implemented in SG::AuxTypeVectorHolder< T, CONT >, SG::RootAuxVector, xAOD::TAuxVector, and xAOD::AuxPersInfo< T >.

◆ storeDataSpan()

void SG::IAuxTypeVector::storeDataSpan	(	void *	beg,
		size_t	size
	)

inlineprotected

Update the stored span.

Parameters

beg	The start of the vector.
size	The length of the vector.

Definition at line 284 of file IAuxTypeVector.h.

   {
     // Only do this if the span is already valid, so that it doesn't
     // get marked valid before ROOT I/O.
     if (m_span.isValid()) {
       m_span.store (AuxDataSpanBase (beg, size));
     }
   }

◆ toPacked()

virtual std::unique_ptr<IAuxTypeVector> SG::IAuxTypeVector::toPacked ( )

inlinevirtual

Make a packed version of the variable.

If possible, return a new vector object that stores the data in a PackedContainer. The data itself should be moved to the new container (so that this vector becomes empty). This ensures that pointers to the data are preserved.

If successful, a newly-allocated object is returned. A null pointer is returned on failure (operation not supported, type can't be packed, type is already packed).

Definition at line 188 of file IAuxTypeVector.h.

188 { return 0; }

◆ toPtr() [1/2]

virtual const void* SG::IAuxTypeVector::toPtr ( ) const

pure virtual

Return a pointer to the start of the vector's data.

Implemented in SG::AuxTypeVectorHolder< T, CONT >, SG::RootAuxVector, xAOD::TAuxVector, and xAOD::AuxPersInfo< T >.

◆ toPtr() [2/2]

virtual void* SG::IAuxTypeVector::toPtr ( )

pure virtual

Return a pointer to the start of the vector's data.

◆ toVector()

virtual void* SG::IAuxTypeVector::toVector ( )

pure virtual

Return a pointer to the STL vector itself.

Member Data Documentation

◆ m_auxid

auxid_t SG::IAuxTypeVector::m_auxid

private

The auxid of the variable this vector represents.

Definition at line 305 of file IAuxTypeVector.h.

◆ m_isLinked

bool SG::IAuxTypeVector::m_isLinked

private

True if this variable is linked from another one.

Definition at line 308 of file IAuxTypeVector.h.

◆ m_span

CxxUtils::CachedValue<AuxDataSpanBase> SG::IAuxTypeVector::m_span

private

Description of the vector start+size.

Definition at line 311 of file IAuxTypeVector.h.

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

IAuxTypeVector.h

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IAuxTypeVector()

◆ ~IAuxTypeVector()

Member Function Documentation

◆ auxid()

◆ clone()

◆ getDataSpan()

◆ getDataSpanImpl()

◆ insertMove()

◆ isLinked()

◆ linkedVector()

◆ objType()

◆ reserve()

◆ resetDataSpan()

◆ resize()

◆ setOption()

◆ shift()

◆ size()

◆ storeDataSpan()

◆ toPacked()

◆ toPtr() [1/2]

◆ toPtr() [2/2]

◆ toVector()

Member Data Documentation

◆ m_auxid

◆ m_isLinked

◆ m_span