Miscellaneous

This group of functions contains various miscellaneous helper functions. More...

Functions
unsigned long	getArrayDescSize_F90Vendor (int rank)
	Returns the size of an array descriptor (in bytes).
F90_HiddenDescType	hiddenArrayDescType_F90Vendor (F90_DescType desc_type)
	Returns the type of hidden descriptor used by the compiler for the given descriptor type.
int	verifyArrayDesc_F90Vendor (const void *desc, int rank)
	Verify an array descriptor.
int	nullifyArrayDesc_F90Vendor (void *desc, int rank)
	Nullify an array descriptor.
int	printArrayDesc_F90Vendor (const void *desc, int rank)
	Prints all fields in the array descriptor.
int	equalsArrayDesc_F90Vendor (const void *desc1, const void *desc2, int rank)
	Determines if two descriptors are equal (equivalent).
char *	getMangledName_F90Vendor (const char *fun_name, const char *mod_name)
	Returns the symbol name of a module procedure, if the module name is not null, otherwise returns the name of the procedure.
void	F90_SetCCFunctions_F90Vendor (F90_CompilerCharacteristics *cc)
	Set CompilerCharacteristics function pointers for a particular compiler.

---

Detailed Description

This group of functions contains various miscellaneous helper functions.

Note that all descriptor parameters in this function group must have been obtained by a call to either createArrayDesc_F90Vendor() or setArrayDesc_F90Vendor().

---

Function Documentation

int equalsArrayDesc_F90Vendor (  const void *  desc1, const void *  desc2, int  rank )

Determines if two descriptors are equal (equivalent). Parameters: desc1  first descriptor (in parameter). desc2  second descriptor (in parameter). rank  the rank of the array (in parameter). Returns: 1 if equal, 0 otherwise.

void F90_SetCCFunctions_F90Vendor (  F90_CompilerCharacteristics *  cc  )

Set CompilerCharacteristics function pointers for a particular compiler. This function is called by the generic (and global) F90_SetCompilerCharacteristics() function to provide a generic interface to the Chasm array-descriptor library. Parameters: cc  the F90_CompilerCharacteristics struct (out parameter).

unsigned long getArrayDescSize_F90Vendor (  int  rank  )

Returns the size of an array descriptor (in bytes). Parameters: rank  the rank of the array (in parameter). Returns: the descriptor size (in bytes).

char* getMangledName_F90Vendor (  const char *  fun_name, const char *  mod_name )

Returns the symbol name of a module procedure, if the module name is not null, otherwise returns the name of the procedure. Note that static memory is used for the return value so it must be copied if retained because the memory is overwritten at each call. Parameters: fun_name  the name of the procedure (in parameter). mod_name  the module name (in parameter). Should be NULL if a global procedure rather than a module procedure. Returns: the symbol name.

F90_HiddenDescType hiddenArrayDescType_F90Vendor (  F90_DescType  desc_type  )

Returns the type of hidden descriptor used by the compiler for the given descriptor type. Parameters: desc_type  type of the descriptor (in parameter). Returns: the hidden descriptor type.

int nullifyArrayDesc_F90Vendor (  void *  desc, int  rank )

Nullify an array descriptor. This sets elements of the array descriptor so that the Fortran nullify intrinsic will return false, given the associated array. Parameters: desc  array descriptor (inout parameter). rank  the rank of the array (in parameter). Returns: 0 if successful (nonzero on error).

int printArrayDesc_F90Vendor (  const void *  desc, int  rank )

Prints all fields in the array descriptor. Parameters: desc  array descriptor (in parameter). rank  the rank of the array (in parameter). Returns: 0 if successful (nonzero on error).

int verifyArrayDesc_F90Vendor (  const void *  desc, int  rank )

Verify an array descriptor. This function does what it can (given only the limited information in the descriptor) to verify that the elements of the array descriptor are correct (i.e., self consistent). Parameters: desc  array descriptor (in parameter). rank  the rank of the array (in parameter). Returns: 0 if the descriptor is valid, nonzero otherwise.

---