Class managing concrete vector variables. More...

#include <AuxPersVector.h>

Inheritance diagram for xAOD::AuxPersVector< T, VEC >:

Collaboration diagram for xAOD::AuxPersVector< T, VEC >:

Public Types
typedef VEC &	vector_type
	Convenience type definition. More...

typedef AuxDataTraits< T >::element_type	element_type
	Type that the user sees. More...

typedef vector_type::value_type	vector_value_type
	Vector element type. More...

Public Member Functions
	AuxPersVector (SG::auxid_t auxid, vector_type vec, bool isLinked, SG::IAuxStore *)
	Constructor. More...

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

vector_type &	vec ()
	Return a reference to the payload vector. More...

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

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

virtual const void *	toPtr () const override
	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 () override
	Return a pointer to the STL vector itself. More...

virtual const std::type_info *	objType () const override
	Return the type of the payload object for this instance. More...

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

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

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

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

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

virtual bool	setOption (const AuxDataOption &option) override
	Make an option setting. More...

virtual bool	shift (size_t pos, ptrdiff_t offs) override
	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) override
	Insert elements into the vector via move semantics. More...

virtual std::unique_ptr< IAuxTypeVector >	toPacked () override
	Try to convert this aux vector to a `PackedContainer`. 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 override final
	Return a span object describing the current vector. More...

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

void	storeDataSpan ()
	Update the stored span. More...

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

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

Static Protected Attributes
static const int	SCALE
	1 for the usual case of `V` being `vector<T>`. More...

Private Member Functions
void	insertMove1 (typename CONT::iterator pos, element_type beg, element_type end, std::true_type)
	Helper for `insertMove`. More...

void	insertMove1 (typename CONT::iterator pos, element_type beg, element_type end, std::false_type)
	Helper for `insertMove`. More...

Private Attributes
vector_type *	m_vecPtr
	The contained vector. More...

bool	m_ownFlag
	True if we need to delete the object. More...

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

template<class T, class VEC = std::vector< T >>
class xAOD::AuxPersVector< T, VEC >

Class managing concrete vector variables.

This class is used internally by the "special" auxiliary store objects to manage the auxiliary variables handled by them. User code probably doesn't want to touch it directly...

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 793737

Date: 2017-01-24 21:11:10 +0100 (Tue, 24 Jan 2017)

Definition at line 28 of file AuxPersVector.h.

Member Typedef Documentation

◆ element_type

typedef AuxDataTraits<T>::element_type SG::AuxTypeVectorHolder< T, std::vector< T > >::element_type

inherited

Type that the user sees.

Definition at line 58 of file AuxTypeVector.h.

◆ vector_type

template<class T , class VEC = std::vector< T >>

typedef VEC& xAOD::AuxPersVector< T, VEC >::vector_type

Convenience type definition.

Definition at line 32 of file AuxPersVector.h.

◆ vector_value_type

typedef vector_type::value_type SG::AuxTypeVectorHolder< T, std::vector< T > >::vector_value_type

inherited

Vector element type.

Definition at line 61 of file AuxTypeVector.h.

Constructor & Destructor Documentation

◆ AuxPersVector()

template<class T , class VEC = std::vector< T >>

xAOD::AuxPersVector< T, VEC >::AuxPersVector	(	SG::auxid_t	auxid,
		vector_type	vec,
		bool	isLinked,
		SG::IAuxStore *
	)

inline

Constructor.

Definition at line 35 of file AuxPersVector.h.

36 : SG::AuxTypeVectorHolder<T, VEC> (auxid, &vec, false, isLinked) {}

Member Function Documentation

◆ auxid()

auxid_t SG::IAuxTypeVector::auxid ( ) const

inlineinherited

Return the auxid of the variable this vector represents.

Definition at line 232 of file IAuxTypeVector.h.

   {
     return m_auxid;
   }

◆ clone() [1/2]

template<class T , class VEC = std::vector< T >>

virtual std::unique_ptr<SG::IAuxTypeVector> xAOD::AuxPersVector< T, VEC >::clone ( ) const

inlineoverridevirtual

Make a copy of this vector.

Implements SG::IAuxTypeVector.

Definition at line 38 of file AuxPersVector.h.

                                                                      {
         return std::make_unique<AuxPersVector<T, VEC> >(*this);
       }

◆ clone() [2/2]

virtual std::unique_ptr<IAuxTypeVector> SG::AuxTypeVectorHolder< T, std::vector< T > >::clone

overridevirtualinherited

Make a copy of this vector.

◆ getDataSpan()

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

inlineinherited

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() [1/2]

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

protectedpure virtualinherited

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.

◆ getDataSpanImpl() [2/2]

virtual AuxDataSpanBase SG::AuxTypeVectorHolder< T, std::vector< T > >::getDataSpanImpl

finaloverrideprotectedvirtualinherited

Return a span object describing the current vector.

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

◆ insertMove()

virtual bool SG::AuxTypeVectorHolder< T, std::vector< T > >::insertMove	(	size_t	pos,
		void *	src,
		size_t	src_pos,
		size_t	src_n,
		IAuxStore &	srcStore
	)

overridevirtualinherited

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.

Implements SG::IAuxTypeVector.

◆ insertMove1() [1/2]

void SG::AuxTypeVectorHolder< T, std::vector< T > >::insertMove1	(	typename CONT::iterator	pos,
		element_type *	beg,
		element_type *	end,
		std::false_type
	)

privateinherited

Helper for insertMove.

Parameters

pos	The starting index of the insertion.
beg	Start of the range of elements to insert.
end	End of the range of elements to insert.

This does the actual move for non-POD types.

◆ insertMove1() [2/2]

void SG::AuxTypeVectorHolder< T, std::vector< T > >::insertMove1	(	typename CONT::iterator	pos,
		element_type *	beg,
		element_type *	end,
		std::true_type
	)

privateinherited

Helper for insertMove.

Parameters

pos	The starting index of the insertion.
beg	Start of the range of elements to insert.
end	End of the range of elements to insert.

This does the actual move for POD types.

◆ isLinked()

bool SG::IAuxTypeVector::isLinked ( ) const

inlineinherited

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 ( )

inlinevirtualinherited

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() [1/2]

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

inlinevirtualinherited

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; }

◆ objType() [2/2]

virtual const std::type_info* SG::AuxTypeVectorHolder< T, std::vector< T > >::objType

overridevirtualinherited

Return the type of the payload object for this instance.

May be different from what we get from the registry; if packing is used, for example.

◆ reserve()

virtual void SG::AuxTypeVectorHolder< T, std::vector< T > >::reserve ( size_t sz )

overridevirtualinherited

Change the capacity of the vector.

Parameters

sz	The new vector capacity.

Implements SG::IAuxTypeVector.

◆ resetDataSpan()

void SG::IAuxTypeVector::resetDataSpan ( )

inlineprotectedinherited

Invalidate the stored span.

Definition at line 297 of file IAuxTypeVector.h.

   {
     m_span.reset();
   }

◆ resize()

virtual bool SG::AuxTypeVectorHolder< T, std::vector< T > >::resize ( size_t sz )

overridevirtualinherited

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

Implements SG::IAuxTypeVector.

◆ setOption()

virtual bool SG::AuxTypeVectorHolder< T, std::vector< T > >::setOption ( const AuxDataOption & option )

overridevirtualinherited

Make an option setting.

Parameters

option The option to set.

The interpretation of the option depends on the concrete class.

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

Reimplemented from SG::IAuxTypeVector.

◆ shift()

virtual bool SG::AuxTypeVectorHolder< T, std::vector< T > >::shift	(	size_t	pos,
		ptrdiff_t	offs
	)

overridevirtualinherited

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

Implements SG::IAuxTypeVector.

◆ size() [1/2]

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

pure virtualinherited

Return the size of the vector.

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

◆ size() [2/2]

virtual size_t SG::AuxTypeVectorHolder< T, std::vector< T > >::size

overridevirtualinherited

Return the size of the vector.

◆ storeDataSpan() [1/2]

void SG::AuxTypeVectorHolder< T, std::vector< T > >::storeDataSpan

protectedinherited

Update the stored span.

◆ storeDataSpan() [2/2]

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

inlineprotectedinherited

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::AuxTypeVectorHolder< T, std::vector< T > >::toPacked

overridevirtualinherited

Try to convert this aux vector to a PackedContainer.

If successful, returns a newly-allocated IAuxTypeVector. In this case, the contents of the vector will have been moved to the new vector (and this object will be empty).

Returns null on failure.

Reimplemented from SG::IAuxTypeVector.

◆ toPtr() [1/3]

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

pure virtualinherited

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/3]

virtual const void* SG::AuxTypeVectorHolder< T, std::vector< T > >::toPtr

overridevirtualinherited

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

Implements SG::IAuxTypeVector.

◆ toPtr() [3/3]

virtual void* SG::AuxTypeVectorHolder< T, std::vector< T > >::toPtr

overridevirtualinherited

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

Implements SG::IAuxTypeVector.

◆ toVector()

virtual void* SG::AuxTypeVectorHolder< T, std::vector< T > >::toVector

overridevirtualinherited

Return a pointer to the STL vector itself.

Implements SG::IAuxTypeVector.

◆ vec()

vector_type& SG::AuxTypeVectorHolder< T, std::vector< T > >::vec

inherited

Return a reference to the payload vector.

Member Data Documentation

◆ m_auxid

auxid_t SG::IAuxTypeVector::m_auxid

privateinherited

The auxid of the variable this vector represents.

Definition at line 305 of file IAuxTypeVector.h.

◆ m_isLinked

bool SG::IAuxTypeVector::m_isLinked

privateinherited

True if this variable is linked from another one.

Definition at line 308 of file IAuxTypeVector.h.

◆ m_ownFlag

bool SG::AuxTypeVectorHolder< T, std::vector< T > >::m_ownFlag

privateinherited

True if we need to delete the object.

Definition at line 303 of file AuxTypeVector.h.

◆ m_span

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

privateinherited

Description of the vector start+size.

Definition at line 311 of file IAuxTypeVector.h.

◆ m_vecPtr

vector_type* SG::AuxTypeVectorHolder< T, std::vector< T > >::m_vecPtr

privateinherited

The contained vector.

Definition at line 300 of file AuxTypeVector.h.

◆ SCALE

const int SG::AuxTypeVectorHolder< T, std::vector< T > >::SCALE

staticprotectedinherited

1 for the usual case of V being vector<T>.

If V is vector<char>, then this is sizeof(T).

Definition at line 67 of file AuxTypeVector.h.

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

AuxPersVector.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class T, class VEC = std::vector< T >> class xAOD::AuxPersVector< T, VEC >

Member Typedef Documentation

◆ element_type

◆ vector_type

◆ vector_value_type

Constructor & Destructor Documentation

◆ AuxPersVector()

Member Function Documentation

◆ auxid()

◆ clone() [1/2]

◆ clone() [2/2]

◆ getDataSpan()

◆ getDataSpanImpl() [1/2]

◆ getDataSpanImpl() [2/2]

◆ insertMove()

◆ insertMove1() [1/2]

◆ insertMove1() [2/2]

◆ isLinked()

◆ linkedVector()

◆ objType() [1/2]

◆ objType() [2/2]

◆ reserve()

◆ resetDataSpan()

◆ resize()

◆ setOption()

◆ shift()

◆ size() [1/2]

◆ size() [2/2]

◆ storeDataSpan() [1/2]

◆ storeDataSpan() [2/2]

◆ toPacked()

◆ toPtr() [1/3]

◆ toPtr() [2/3]

◆ toPtr() [3/3]

◆ toVector()

◆ vec()

Member Data Documentation

◆ m_auxid

◆ m_isLinked

◆ m_ownFlag

◆ m_span

◆ m_vecPtr

◆ SCALE

template<class T, class VEC = std::vector< T >>
class xAOD::AuxPersVector< T, VEC >