double_dictionary.h File Reference

Provides access to the double dictionary class in tblite, which gathers post processing values. More...

#include "tblite/macros.h"

Go to the source code of this file.

Typedefs
typedef struct _tblite_double_dictionary *	tblite_double_dictionary

Functions
TBLITE_API_ENTRY int TBLITE_API_CALL	tblite_get_n_entries_dict (tblite_error error, tblite_double_dictionary dict)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_get_array_entry_index (tblite_error error, tblite_double_dictionary dict, const int *index, double *array)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_get_array_size_index (tblite_error error, tblite_double_dictionary dict, const int *index, int *dim1, int *dim2, int *dim3)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_get_array_entry_label (tblite_error error, tblite_double_dictionary dict, char *label, double *array)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_get_array_size_label (tblite_error error, tblite_double_dictionary dict, char *label, int *dim1, int *dim2, int *dim3)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_get_label_entry_index (tblite_error error, tblite_double_dictionary dict, const int *index, char *label, const int *buffersize)
TBLITE_API_ENTRY void TBLITE_API_CALL	tblite_delete_double_dictionary (tblite_double_dictionary *dict)

Detailed Description

Provides access to the double dictionary class in tblite, which gathers post processing values.

Provides access to a double dictionary class, the entries of the dictionary can be retrieved by index. The number of indices can be requested, making asimple itareation over thee possible

Function Documentation

tblite_delete_double_dictionary()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_delete_double_dictionary

(

tblite_double_dictionary *

dict

)

Delete dictionary

Parameters

dict	Double dictionary instance

tblite_get_array_entry_index()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_get_array_entry_index	(	tblite_error	error,
		tblite_double_dictionary	dict,
		const int *	index,
		double *	array )

Get the array associated with an entry by index, together with its dimensions

Parameters

error	Error handler
dict	Double dictionary instance
index	Index of the entry for which to retrieve the label
array	Array associated to the entry addressed by the index

tblite_get_array_entry_label()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_get_array_entry_label	(	tblite_error	error,
		tblite_double_dictionary	dict,
		char *	label,
		double *	array )

Get the array associated with an entry by index, together with its dimensions

Parameters

error	Error handler
dict	Double dictionary instance
label	label of the entry for which to retrieve the label
array	Array associated to the entry addressed by the label

tblite_get_array_size_index()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_get_array_size_index	(	tblite_error	error,
		tblite_double_dictionary	dict,
		const int *	index,
		int *	dim1,
		int *	dim2,
		int *	dim3 )

Get the array associated with an entry by index, together with its dimensions

Parameters

error	Error handler
dict	Double dictionary instance
index	Index of the entry for which to retrieve the label
dim1	1st dimension of the associated tensor to the index
dim2	2nd dimension of the associated tensor to the index
dim3	3rd dimension of the associated tensor to the index

tblite_get_array_size_label()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_get_array_size_label	(	tblite_error	error,
		tblite_double_dictionary	dict,
		char *	label,
		int *	dim1,
		int *	dim2,
		int *	dim3 )

Get the array associated with an entry by label, together with its dimensions

Parameters

error	Error handler
dict	Double dictionary instance
label	label of the entry for which to retrieve the label
dim1	1st dimension of the associated tensor to the label
dim2	2nd dimension of the associated tensor to the label
dim3	3rd dimension of the associated tensor to the label

tblite_get_label_entry_index()

TBLITE_API_ENTRY void TBLITE_API_CALL tblite_get_label_entry_index	(	tblite_error	error,
		tblite_double_dictionary	dict,
		const int *	index,
		char *	label,
		const int *	buffersize )

Get label of an entry by index

Parameters

error	Error handler
dict	Double dictionary instance
index	Index of the entry for which to retrieve the label
label	Label which is retrieved

tblite_get_n_entries_dict()

TBLITE_API_ENTRY int TBLITE_API_CALL tblite_get_n_entries_dict	(	tblite_error	error,
		tblite_double_dictionary	dict )

Get number of entries

Parameters

error	Error handler
dict	Double dictionary instance