A Record_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::Record_datatype:

Classes
class	Member
	A Member is one of the elements inside a Record_datatype. More...

Public Member Functions
const std::vector< Member > &	members () const
	Accesses the members in increasing displacement order.

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 to, const void ) const override
	Creates a dense deep copy of data.

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

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

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

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

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

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

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.

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< Record_datatype >	make (std::vector< Member > &&members, size_t size, const Attributes_map &attributes={})
	Constructs a new Record_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 Record_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 name to access it.

Member Function Documentation

◆ members()

const std::vector< Member > & PDI::Record_datatype::members ( ) const

Accesses the members in increasing displacement order.

◆ densify()

Datatype_sptr PDI::Record_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::Record_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::Record_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::Record_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::Record_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::Record_datatype::alignment ( ) const

overridevirtual

Returns the required alignment for a type.

Returns: the size in bytes

Implements PDI::Datatype.

◆ simple()

bool PDI::Record_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::Record_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::Record_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.

◆ member() [1/2]

Datatype_sptr PDI::Record_datatype::member ( const char * name ) const

overridevirtual

Access the type of the member with the provided name.

Parameters

name	the name of the member to access

Returns: the Datatype of the member

Reimplemented from PDI::Datatype.

◆ member() [2/2]

std::pair< void *, Datatype_sptr > PDI::Record_datatype::member	(	const char *	name,
		void *	data ) const

overridevirtual

Access the type and value of the member with the provided name.

Parameters

name	the name of the member to access
data	the address of the element whose member to access

Returns: the Datatype and address of the member

Reimplemented from PDI::Datatype.

◆ destroy_data()

void PDI::Record_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::Record_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::Record_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< Record_datatype > PDI::Record_datatype::make	(	std::vector< Member > &&	members,
		size_t	size,
		const Attributes_map &	attributes = {} )

static

Constructs a new Record_datatype.

Parameters

members	the members for the newly created Record_datatype in increasing displacement order
size	the total size of the buffer containing all members
attributes	attributes of the record datatype

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

record_datatype.h

PDI 1.9.0-alpha.2025-01-15

the PDI data interface

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ members()

◆ densify()

◆ evaluate()

◆ dense()

◆ datasize()

◆ buffersize()

◆ alignment()

◆ simple()

◆ data_to_dense_copy()

◆ data_from_dense_copy()

◆ member() [1/2]

◆ member() [2/2]

◆ destroy_data()

◆ debug_string()

◆ operator==()

◆ make()