Algorithm communication variable structure. More...

Public Attributes
unsigned int	data_type
	Type of data. More...

unsigned int	num_entries
	The number of elements of data type data_type stored at the pointer address data. More...

unsigned int	stride
	This data member can be used to describe the extent of one dimension if the data should be interpreted as a two-dimensional matrix. More...

void *	data
	`data` is a pointer to where the AC variable's `data` is stored in memory. More...

Detailed Description

Algorithm communication variable structure.

Algorithm communication variables (AC variables) are described by objects of this type. AC variables can be published to the algorithm variable space with the algo_comm_class_t::insert_var method so that other plugins can read and modify their values.

Member Data Documentation

◆ data_type

unsigned int MHA_AC::comm_var_t::data_type

Type of data.

data_type can be one of the predefined types or any user defined type. The pre-defined types are:

MHA_AC_CHAR
MHA_AC_INT
MHA_AC_MHAREAL
MHA_AC_FLOAT
MHA_AC_DOUBLE
MHA_AC_MHACOMPLEX
or any user defined type with a value >= MHA_AC_USER

◆ num_entries

unsigned int MHA_AC::comm_var_t::num_entries

The number of elements of data type data_type stored at the pointer address data.

◆ stride

unsigned int MHA_AC::comm_var_t::stride

This data member can be used to describe the extent of one dimension if the data should be interpreted as a two-dimensional matrix.

The extent in the other dimension then is num_entries / stride. When downstream plugins could interpret the AC variable as a (possibly 1x1) matrix, then it should be avoided to set stride to 0.

◆ data

void* MHA_AC::comm_var_t::data

data is a pointer to where the AC variable's data is stored in memory.

This pointer has to be valid for the lifetime of this AC variable.

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