A Tuple_datatype is a Datatype that represents a fixed number of elements of potentially different types layed out in a specific way in memory. More...

Inheritance diagram for PDI::Tuple_datatype:

Classes
class	Element
	A Element is one of the elements inside a Tuple_datatype. More...

Public Member Functions
const std::vector< Element > &	elements () const
	Accesses the elements in increasing offset order.

size_t	size () const
	Number of elements of the tuple.

Datatype_sptr	densify () const override
	Creates a new datatype as the dense copy of this one.

Datatype_sptr	evaluate (Context &) const override
	Creates a new datatype by resolving the value of all metadata references.

bool	dense () const override
	Indicate if the datatype is dense or not.

size_t	datasize () const override
	Computes the data size of a type, excluding potentially unused memory from a sparse type.

size_t	buffersize () const override
	Computes the data size of a type, including potentially unused memory from a sparse type.

size_t	alignment () const override
	Returns the required alignment for a type.

bool	simple () const override
	Tells if data can be copied as bytes (if type is dense) and doesn't need a destroyer.

void *	data_to_dense_copy (void , const void ) const override
	Creates a dense deep copy of data.

void *	data_from_dense_copy (void , const void ) const override
	Creates a sparse deep copy of dense data.

Datatype_sptr	index (size_t) const override
	Access the type of the element at the provided index.

std::pair< void *, Datatype_sptr >	index (size_t, void *) const override
	Access the type and value of the element at the provided index.

Datatype_sptr	slice (size_t, size_t) const override
	Access the type of the elements slice between the provided indices.

std::pair< void *, Datatype_sptr >	slice (size_t, size_t, void *) const override
	Access the type and value of the elements slice between the provided indices.

void	destroy_data (void *) const override
	Delete data whose type is described by the Datatype.

std::string	debug_string () const override
	Returns the datatype yaml representation as a string.

bool	operator== (const Datatype &) const override
	Test for equality.

Public Member Functions inherited from PDI::Datatype
	Datatype (const Attributes_map &attributes={})
	Creates a new datatype.

	~Datatype () override

virtual bool	operator== (const Datatype &other) const =0
	Test for equality.

bool	operator!= (const Datatype &other) const
	Test for inequality.

virtual Datatype_sptr	densify () const =0
	Creates a new datatype as the dense copy of this one.

virtual bool	dense () const =0
	Indicate if the datatype is dense or not.

virtual size_t	datasize () const =0
	Computes the data size of a type, excluding potentially unused memory from a sparse type.

virtual size_t	buffersize () const =0
	Computes the data size of a type, including potentially unused memory from a sparse type.

virtual size_t	alignment () const =0
	Returns the required alignment for a type.

virtual bool	simple () const =0
	Tells if data can be copied as bytes (if type is dense) and doesn't need a destroyer.

virtual void *	data_to_dense_copy (void to, const void from) const =0
	Creates a dense deep copy of data.

virtual void *	data_from_dense_copy (void to, const void from) const =0
	Creates a sparse deep copy of dense data.

virtual Datatype_sptr	index (size_t index) const
	Access the type of the element at the provided index.

virtual std::pair< void *, Datatype_sptr >	index (size_t index, void *data) const
	Access the type and value of the element at the provided index.

virtual Datatype_sptr	slice (size_t start_index, size_t end_index) const
	Access the type of the elements slice between the provided indices.

virtual std::pair< void *, Datatype_sptr >	slice (size_t start_index, size_t end_index, void *data) const
	Access the type and value of the elements slice between the provided indices.

virtual Datatype_sptr	member (const char *name) const
	Access the type of the member with the provided name.

virtual std::pair< void *, Datatype_sptr >	member (const char name, void data) const
	Access the type and value of the member with the provided name.

virtual Datatype_sptr	dereference () const
	Access the type referenced by this.

virtual std::pair< void *, Datatype_sptr >	dereference (void *data) const
	Access the type and value referenced by this.

virtual void	destroy_data (void *ptr) const =0
	Delete data whose type is described by the Datatype.

virtual std::string	debug_string () const =0
	Returns the datatype yaml representation as a string.

Public Member Functions inherited from PDI::Datatype_template
	Datatype_template (const Attributes_map &attributes={})
	Creates datatype template with given attributes.

	Datatype_template (PC_tree_t datatype_tree)
	Creates datatype template.

virtual	~Datatype_template ()
	Destroys the template.

virtual Datatype_sptr	evaluate (Context &ctx) const =0
	Creates a new datatype by resolving the value of all metadata references.

Expression	attribute (const std::string &attribute_name) const
	Returns attribute of given name as Expression.

const Attributes_map &	attributes () const
	Returns all attributes as a unordered map.

Static Public Member Functions
static std::shared_ptr< Tuple_datatype >	make (std::vector< Element > elements, size_t buffersize, const Attributes_map &attributes={})
	Constructs a new Tuple_datatype.

Static Public Member Functions inherited from PDI::Datatype_template
static void	load_basic_datatypes (Context &ctx)
	Adds to the context the basic Array, Record, C and Fortran datatypes.

static void	load_user_datatypes (Context &ctx, PC_tree_t types_tree)
	Adds to the context the user defined datatypes.

Additional Inherited Members
Protected Attributes inherited from PDI::Datatype_template
Attributes_map	m_attributes

Detailed Description

A Tuple_datatype is a Datatype that represents a fixed number of elements of potentially different types layed out in a specific way in memory.

Each element is given a index to access it.

Member Function Documentation

◆ elements()

const std::vector< Element > & PDI::Tuple_datatype::elements ( ) const

Accesses the elements in increasing offset order.

◆ size()

size_t PDI::Tuple_datatype::size ( ) const

Number of elements of the tuple.

Returns: the number of elements of the tuple

◆ densify()

Datatype_sptr PDI::Tuple_datatype::densify ( ) const

overridevirtual

Creates a new datatype as the dense copy of this one.

Returns: the type that is produced

Implements PDI::Datatype.

◆ evaluate()

Datatype_sptr PDI::Tuple_datatype::evaluate ( Context & ctx ) const

overridevirtual

Creates a new datatype by resolving the value of all metadata references.

Parameters

ctx	the context in which to evaluate this template

Returns: the evaluated type that is produced

Implements PDI::Datatype_template.

◆ dense()

bool PDI::Tuple_datatype::dense ( ) const

overridevirtual

Indicate if the datatype is dense or not.

Returns: whether the datatype is dense

Implements PDI::Datatype.

◆ datasize()

size_t PDI::Tuple_datatype::datasize ( ) const

overridevirtual

Computes the data size of a type, excluding potentially unused memory from a sparse type.

Returns: the size in bytes

Implements PDI::Datatype.

◆ buffersize()

size_t PDI::Tuple_datatype::buffersize ( ) const

overridevirtual

Computes the data size of a type, including potentially unused memory from a sparse type.

Returns: the size in bytes

Implements PDI::Datatype.

◆ alignment()

size_t PDI::Tuple_datatype::alignment ( ) const

overridevirtual

Returns the required alignment for a type.

Returns: the size in bytes

Implements PDI::Datatype.

◆ simple()

bool PDI::Tuple_datatype::simple ( ) const

overridevirtual

Tells if data can be copied as bytes (if type is dense) and doesn't need a destroyer.

Returns: true if data has trivial copier and destroyer, false otherwise

Implements PDI::Datatype.

◆ data_to_dense_copy()

void * PDI::Tuple_datatype::data_to_dense_copy	(	void *	to,
		const void *	from
	)		const

overridevirtual

Creates a dense deep copy of data.

Parameters

[in]	to	the pointer to the allocated memory to fill (dense data)
[in]	from	the pointer to the copied data (size of buffersize)

Returns: updated ‘to’ pointer

Implements PDI::Datatype.

◆ data_from_dense_copy()

void * PDI::Tuple_datatype::data_from_dense_copy	(	void *	to,
		const void *	from
	)		const

overridevirtual

Creates a sparse deep copy of dense data.

Parameters

[in]	to	the pointer to the allocated memory to fill (size of buffersize)
[in]	from	the pointer to the copied data (dense data)

Returns: updated ‘to’ pointer

Implements PDI::Datatype.

◆ index() [1/2]

Datatype_sptr PDI::Tuple_datatype::index ( size_t index ) const

overridevirtual

Access the type of the element at the provided index.

Parameters

index the index where to look

Returns: the Datatype of the indexed sub-element

Reimplemented from PDI::Datatype.

◆ index() [2/2]

std::pair< void *, Datatype_sptr > PDI::Tuple_datatype::index	(	size_t	index,
		void *	data
	)		const

overridevirtual

Access the type and value of the element at the provided index.

Parameters

index	the index where to look
data	the address of the element to index

Returns: the Datatype and address of the indexed sub-element

Reimplemented from PDI::Datatype.

◆ slice() [1/2]

Datatype_sptr PDI::Tuple_datatype::slice	(	size_t	start_index,
		size_t	end_index
	)		const

overridevirtual

Access the type of the elements slice between the provided indices.

Parameters

start_index	the index where to start
end_index	the index where to end

Returns: the Datatype of the slice

Reimplemented from PDI::Datatype.

◆ slice() [2/2]

std::pair< void *, Datatype_sptr > PDI::Tuple_datatype::slice	(	size_t	start_index,
		size_t	end_index,
		void *	data
	)		const

overridevirtual

Access the type and value of the elements slice between the provided indices.

Parameters

start_index	the index where to start
end_index	the index where to end
data	the address of the element to slice

Returns: the Datatype and address of the slice

Reimplemented from PDI::Datatype.

◆ destroy_data()

void PDI::Tuple_datatype::destroy_data ( void * ptr ) const

overridevirtual

Delete data whose type is described by the Datatype.

This does not deallocate the buffer used to store the data.

Parameters

[in] ptr to the data to free

Implements PDI::Datatype.

◆ debug_string()

std::string PDI::Tuple_datatype::debug_string ( ) const

overridevirtual

Returns the datatype yaml representation as a string.

Returns: the datatype yaml representation as a string

Implements PDI::Datatype.

◆ operator==()

bool PDI::Tuple_datatype::operator== ( const Datatype & other ) const

overridevirtual

Test for equality.

Parameters

other the Datatype to compare

Returns: true if the Datatype's are equal

Implements PDI::Datatype.

◆ make()

static std::shared_ptr< Tuple_datatype > PDI::Tuple_datatype::make	(	std::vector< Element >	elements,
		size_t	buffersize,
		const Attributes_map &	attributes = `{}`
	)

static

Constructs a new Tuple_datatype.

Parameters

elements	the elements for the newly created Tuple_datatype in increasing offset order
buffersize	the total size of the buffer containing all elements
attributes	attributes of the tuple datatype

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

tuple_datatype.h

PDI 1.7.1

the PDI data interface

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ elements()

◆ size()

◆ densify()

◆ evaluate()

◆ dense()

◆ datasize()

◆ buffersize()

◆ alignment()

◆ simple()

◆ data_to_dense_copy()

◆ data_from_dense_copy()

◆ index() [1/2]

◆ index() [2/2]

◆ slice() [1/2]

◆ slice() [2/2]

◆ destroy_data()

◆ debug_string()

◆ operator==()

◆ make()