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

class	Member_accessor
	Member accessor for record datatype. More...

Public Member Functions
	Record_datatype (std::vector< Member > &&members, size_t size)
	Constructs a new Record_datatype. More...

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

Datatype_template_uptr	clone () const override
	Creates a new datatype as an exact copy of this one. More...

Datatype_uptr	clone_type () const override
	Creates a new datatype as an exact copy of this one. More...

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

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

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

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

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

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

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

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

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

std::pair< void *, Datatype_uptr >	subaccess_by_iterators (void *from, std::vector< std::unique_ptr< Accessor_base >>::const_iterator remaining_begin, std::vector< std::unique_ptr< Accessor_base >>::const_iterator remaining_end) const override
	Creates datatype of subtype and returns it with a moved pointer. More...

void	destroy_data (void *) const override
	Function used to delete the data behind the datatype. More...

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

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

Public Member Functions inherited from PDI::Datatype
	~Datatype () override

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

std::pair< void *, Datatype_uptr >	subaccess (void *from, const Accessor_base &accessor) const
	Creates datatype of subtype and returns it with a moved pointer. More...

std::pair< void *, Datatype_uptr >	subaccess (void *from, const std::vector< std::unique_ptr< Accessor_base >> &accessors) const
	Creates datatype of subtype and returns it with a moved pointer. More...

Public Member Functions inherited from PDI::Datatype_template
virtual	~Datatype_template ()
	Destroys the template. More...

Additional Inherited Members
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. More...

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

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.

Constructor & Destructor Documentation

◆ Record_datatype()

PDI::Record_datatype::Record_datatype	(	std::vector< Member > &&	members,
		size_t	size
	)

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

Member Function Documentation

◆ members()

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

Accesses the members in increasing displacement order.

◆ clone()

Datatype_template_uptr PDI::Record_datatype::clone ( ) const

overridevirtual

Creates a new datatype as an exact copy of this one.

Returns: the dense type that is produced

Implements PDI::Datatype_template.

◆ clone_type()

Datatype_uptr PDI::Record_datatype::clone_type ( ) const

overridevirtual

Creates a new datatype as an exact copy of this one.

Returns: the dense type that is produced

Implements PDI::Datatype.

◆ densify()

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

◆ subaccess_by_iterators()

std::pair<void*, Datatype_uptr> PDI::Record_datatype::subaccess_by_iterators	(	void *	from,
		std::vector< std::unique_ptr< Accessor_base >>::const_iterator	remaining_begin,
		std::vector< std::unique_ptr< Accessor_base >>::const_iterator	remaining_end
	)		const

overridevirtual

Creates datatype of subtype and returns it with a moved pointer.

Parameters

[in]	from	the pointer to the data
[in]	remaining_begin	iterator to the begin of remaining accessors
[in]	remaining_end	iterator to the end of remaining accessors

Returns: pointer moved by offset and new datatype

Reimplemented from PDI::Datatype.

◆ destroy_data()

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

overridevirtual

Function used to delete the data behind the datatype.

This should not deallocate the memory.

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.

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

record_datatype.h

PDI 1.2.2

Data exchange made easy

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Record_datatype()

Member Function Documentation

◆ members()

◆ clone()

◆ clone_type()

◆ densify()

◆ evaluate()

◆ dense()

◆ datasize()

◆ buffersize()

◆ alignment()

◆ simple()

◆ data_to_dense_copy()

◆ data_from_dense_copy()

◆ subaccess_by_iterators()

◆ destroy_data()

◆ debug_string()

◆ operator==()