Factory object that creates vectors using AuxTypeVector. More...

#include <AuxTypeVectorFactory.h>

Inheritance diagram for SG::AuxTypeVectorFactoryImpl< T, ALLOC >:

Collaboration diagram for SG::AuxTypeVectorFactoryImpl< T, ALLOC >:

Public Types
using	AuxTypeVector_t = AuxTypeVector< T, ALLOC >

using	vector_value_type = typename AuxTypeVector_t::vector_value_type

Public Member Functions
virtual std::unique_ptr< IAuxTypeVector >	create (SG::auxid_t auxid, size_t size, size_t capacity, bool isLinked) const override
	Create a vector object of this type. More...

virtual std::unique_ptr< IAuxTypeVector >	createFromData (SG::auxid_t auxid, void data, IAuxTypeVector linkedVector, bool isPacked, bool ownFlag, bool isLinked) const override
	Create a vector object of this type from a data blob. More...

virtual void	copy (SG::auxid_t auxid, AuxVectorData &dst, size_t dst_index, const AuxVectorData &src, size_t src_index, size_t n) const override
	Copy elements between vectors. More...

virtual void	copyForOutput (SG::auxid_t auxid, AuxVectorData &dst, size_t dst_index, const AuxVectorData &src, size_t src_index, size_t n) const override
	Copy elements between vectors, possibly applying thinning. More...

virtual void	swap (SG::auxid_t auxid, AuxVectorData &a, size_t aindex, AuxVectorData &b, size_t bindex, size_t n) const override
	Swap elements between vectors. More...

virtual void	clear (SG::auxid_t auxid, AuxVectorData &dst, size_t dst_index, size_t n) const override
	Clear a range of elements within a vector. More...

virtual size_t	getEltSize () const override
	Return the size of an element of this vector type. More...

virtual const std::type_info *	tiVec () const override
	Return the `type_info` of the vector. More...

virtual bool	isDynamic () const override
	True if the vectors created by this factory work by dynamic emulation (via `TVirtualCollectionProxy` or similar); false if the std::vector code is used directly. More...

virtual const std::type_info *	tiAlloc () const override
	Return the `type_info` of the vector allocator. More...

virtual std::string	tiAllocName () const override
	Return the (demangled) name of the vector allocator. More...

void	copy (SG::auxid_t auxid, AuxVectorData &&dst, size_t dst_index, const AuxVectorData &src, size_t src_index, size_t n) const
	Copy elements between vectors. More...

Private Member Functions
vector_value_type *	copyImpl (SG::auxid_t auxid, AuxVectorData &dst, size_t dst_index, const AuxVectorData &src, size_t src_index, size_t n) const
	Helper for copy; returns a pointer to the first destination object, or nullptr if the destination was cleared rather than copied. More...

std::unique_ptr< IAuxTypeVector >	createFromData (auxid_t auxid, void *data, bool isPacked, bool ownFlag, bool isLinked, std::true_type) const
	Helpers for creating vector from a data blob,. More...

std::unique_ptr< IAuxTypeVector >	createFromData (auxid_t auxid, void *data, bool isPacked, bool ownFlag, bool isLinked, std::false_type) const

Detailed Description

template<class T, class ALLOC = AuxAllocator_t<T>>
class SG::AuxTypeVectorFactoryImpl< T, ALLOC >

Factory object that creates vectors using AuxTypeVector.

This is an implementation of IAuxTypeVectorFactory that makes vectors using the AuxTypeVector implementation.

All of the actual code is broken out into this base class of AuxTypeVectorFactory to make it easier to specialize that type while still allowing the specializations to share this code.

Definition at line 38 of file AuxTypeVectorFactory.h.

Member Typedef Documentation

◆ AuxTypeVector_t

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxTypeVectorFactoryImpl< T, ALLOC >::AuxTypeVector_t = AuxTypeVector<T, ALLOC>

Definition at line 42 of file AuxTypeVectorFactory.h.

◆ vector_value_type

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxTypeVectorFactoryImpl< T, ALLOC >::vector_value_type = typename AuxTypeVector_t::vector_value_type

Definition at line 44 of file AuxTypeVectorFactory.h.

Member Function Documentation

◆ clear()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual void SG::AuxTypeVectorFactoryImpl< T, ALLOC >::clear	(	SG::auxid_t	auxid,
		AuxVectorData &	dst,
		size_t	dst_index,
		size_t	n
	)		const

overridevirtual

Clear a range of elements within a vector.

Parameters

auxid	The aux data item being operated on.
dst	Container holding the element
dst_index	Index of the first element in the vector.
n	Number of elements to clear.

Implements SG::IAuxTypeVectorFactory.

◆ copy() [1/2]

void SG::IAuxTypeVectorFactory::copy	(	SG::auxid_t	auxid,
		AuxVectorData &&	dst,
		size_t	dst_index,
		const AuxVectorData &	src,
		size_t	src_index,
		size_t	n
	)		const

inlineinherited

Copy elements between vectors.

Parameters

auxid	The aux data item being operated on.
dst	Container for the destination vector. Declared as a rvalue reference to allow passing a temporary here (such as from AuxVectorInterface).
dst_index	Index of the first destination element in the vector.
src	Container for the source vector.
src_index	Index of the first source element in the vector.
n	Number of elements to copy.

dst and @ src can be either the same or different.

Definition at line 132 of file IAuxTypeVectorFactory.h.

   {
     copy (auxid, dst, dst_index, src, src_index, n);
   }

◆ copy() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual void SG::AuxTypeVectorFactoryImpl< T, ALLOC >::copy	(	SG::auxid_t	auxid,
		AuxVectorData &	dst,
		size_t	dst_index,
		const AuxVectorData &	src,
		size_t	src_index,
		size_t	n
	)		const

overridevirtual

Copy elements between vectors.

Parameters

auxid	The aux data item being operated on.
dst	Container for the destination vector.
dst_index	Index of the first destination element in the vector.
src	Container for the source vector.
src_index	Index of the first source element in the vector.
n	Number of elements to copy.

dst and @ src can be either the same or different.

Implements SG::IAuxTypeVectorFactory.

◆ copyForOutput()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual void SG::AuxTypeVectorFactoryImpl< T, ALLOC >::copyForOutput	(	SG::auxid_t	auxid,
		AuxVectorData &	dst,
		size_t	dst_index,
		const AuxVectorData &	src,
		size_t	src_index,
		size_t	n
	)		const

overridevirtual

Copy elements between vectors, possibly applying thinning.

Parameters

auxid	The aux data item being operated on.
dst	Container for the destination vector.
dst_index	Index of the first destination element in the vector.
src	Container for the source vector.
src_index	Index of source element in the vector.
src_index	Index of the first source element in the vector.
n	Number of elements to copy.

dst and @ src can be either the same or different.

Implements SG::IAuxTypeVectorFactory.

◆ copyImpl()

template<class T , class ALLOC = AuxAllocator_t<T>>

vector_value_type* SG::AuxTypeVectorFactoryImpl< T, ALLOC >::copyImpl	(	SG::auxid_t	auxid,
		AuxVectorData &	dst,
		size_t	dst_index,
		const AuxVectorData &	src,
		size_t	src_index,
		size_t	n
	)		const

private

Helper for copy; returns a pointer to the first destination object, or nullptr if the destination was cleared rather than copied.

◆ create()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual std::unique_ptr<IAuxTypeVector> SG::AuxTypeVectorFactoryImpl< T, ALLOC >::create	(	SG::auxid_t	auxid,
		size_t	size,
		size_t	capacity,
		bool	isLinked
	)		const

overridevirtual

Create a vector object of this type.

Parameters

auxid	ID for the variable being created.
size	Initial size of the new vector.
capacity	Initial capacity of the new vector.
isLinked	True if this variable is linked from another one.

Returns a newly-allocated object.

Implements SG::IAuxTypeVectorFactory.

◆ createFromData() [1/3]

template<class T , class ALLOC = AuxAllocator_t<T>>

std::unique_ptr<IAuxTypeVector> SG::AuxTypeVectorFactoryImpl< T, ALLOC >::createFromData	(	auxid_t	auxid,
		void *	data,
		bool	isPacked,
		bool	ownFlag,
		bool	isLinked,
		std::false_type
	)		const

private

◆ createFromData() [2/3]

template<class T , class ALLOC = AuxAllocator_t<T>>

std::unique_ptr<IAuxTypeVector> SG::AuxTypeVectorFactoryImpl< T, ALLOC >::createFromData	(	auxid_t	auxid,
		void *	data,
		bool	isPacked,
		bool	ownFlag,
		bool	isLinked,
		std::true_type
	)		const

private

Helpers for creating vector from a data blob,.

◆ createFromData() [3/3]

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual std::unique_ptr<IAuxTypeVector> SG::AuxTypeVectorFactoryImpl< T, ALLOC >::createFromData	(	SG::auxid_t	auxid,
		void *	data,
		IAuxTypeVector *	linkedVector,
		bool	isPacked,
		bool	ownFlag,
		bool	isLinked
	)		const

overridevirtual

Create a vector object of this type from a data blob.

Parameters

auxid	ID for the variable being created.
data	The vector object.
linkedVector	The interface for another variable linked to this one, or nullptr if there isn't one. (We do not take ownership.)
isPacked	If true, `data` is a `PackedContainer`.
ownFlag	If true, the newly-created IAuxTypeVector object will take ownership of `data`.
isLinked	True if this variable is linked from another one.

If the element type is T, then data should be a pointer to a std::vector<T> object, which was obtained with new. But if isPacked is true, then data should instead point at an object of type SG::PackedContainer<T>.

Returns a newly-allocated object.

Implements SG::IAuxTypeVectorFactory.

◆ getEltSize()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual size_t SG::AuxTypeVectorFactoryImpl< T, ALLOC >::getEltSize ( ) const

overridevirtual

Return the size of an element of this vector type.

Implements SG::IAuxTypeVectorFactory.

◆ isDynamic()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual bool SG::AuxTypeVectorFactoryImpl< T, ALLOC >::isDynamic ( ) const

overridevirtual

True if the vectors created by this factory work by dynamic emulation (via TVirtualCollectionProxy or similar); false if the std::vector code is used directly.

Implements SG::IAuxTypeVectorFactory.

◆ swap()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual void SG::AuxTypeVectorFactoryImpl< T, ALLOC >::swap	(	SG::auxid_t	auxid,
		AuxVectorData &	a,
		size_t	aindex,
		AuxVectorData &	b,
		size_t	bindex,
		size_t	n
	)		const

overridevirtual

Swap elements between vectors.

Parameters

auxid	The aux data item being operated on.
a	Container for the first vector.
aindex	Index of the first element in the first vector.
b	Container for the second vector.
bindex	Index of the first element in the second vector.
n	Number of elements to swap.

a and @ b can be either the same or different. However, the ranges should not overlap.

Implements SG::IAuxTypeVectorFactory.

◆ tiAlloc()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual const std::type_info* SG::AuxTypeVectorFactoryImpl< T, ALLOC >::tiAlloc ( ) const

overridevirtual

Return the type_info of the vector allocator.

Implements SG::IAuxTypeVectorFactory.

◆ tiAllocName()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual std::string SG::AuxTypeVectorFactoryImpl< T, ALLOC >::tiAllocName ( ) const

overridevirtual

Return the (demangled) name of the vector allocator.

Implements SG::IAuxTypeVectorFactory.

◆ tiVec()

template<class T , class ALLOC = AuxAllocator_t<T>>

virtual const std::type_info* SG::AuxTypeVectorFactoryImpl< T, ALLOC >::tiVec ( ) const

overridevirtual

Return the type_info of the vector.

Implements SG::IAuxTypeVectorFactory.

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

AuxTypeVectorFactory.h

Public Types

Public Member Functions

Private Member Functions

Detailed Description

template<class T, class ALLOC = AuxAllocator_t<T>> class SG::AuxTypeVectorFactoryImpl< T, ALLOC >

Member Typedef Documentation

◆ AuxTypeVector_t

◆ vector_value_type

Member Function Documentation

◆ clear()

◆ copy() [1/2]

◆ copy() [2/2]

◆ copyForOutput()

◆ copyImpl()

◆ create()

◆ createFromData() [1/3]

◆ createFromData() [2/3]

◆ createFromData() [3/3]

◆ getEltSize()

◆ isDynamic()

◆ swap()

◆ tiAlloc()

◆ tiAllocName()

◆ tiVec()

template<class T, class ALLOC = AuxAllocator_t<T>>
class SG::AuxTypeVectorFactoryImpl< T, ALLOC >