Linux Certif

Toute la documentation sur la certification Linux LPI

hyantes

NAME

/home/serge/SOURCES/hyantes/geocode/hyantes.c - front end part

SYNOPSIS

Defines

#define release_tree(tree)
release the internal memory of a node, but not the memory used by the node itself
#define smoothing_error()
frees allocated memory in case of error in hs_smoothing
#define TIME_VAL_INIT { (time_t)0,(suseconds_t)0 }

Functions

const char ** hs_list_smoothing (size_t *sz)
list all available smoothing methods a smoothing method always take a radius and a distance (in kilometers) as input and returns a new distance (possibly zero)
unsigned long hs_status ()
observer of the execution of the computation
hs_potential_t * hs_smoothing (int resoLat, int resoLon, const char *function_name, double function_param, hs_coord_t visu, FILE *pFileReference)
perform the smoothing of target area inside visu, using potentials from pFileReference the smoothing is performed using function_name smoothing method, with a radius of function_param the resolution of the output matrix will be resoLat x resoLon

Detailed Description

front end part

Author:

serge guelton

Date:

2008-02-13

Definition in file hyantes.c.

Define Documentation

#define release_tree(tree)

Value:

 free_quadtree(tree.fbd);    free_quadtree(tree.fbg);    free_quadtree(tree.fhd);    free_quadtree(tree.fhg);
 

release the internal memory of a node, but not the memory used by the node itself

Parameters:

tree tree to release

Returns:

void

Definition at line 47 of file hyantes.c.

Referenced by hs_smoothing().

#define smoothing_error()

Value:

 if( ptrees != NULL ) free(ptrees);  if( pReference != NULL ) free(pReference);  if( out != NULL ) free(out);  return NULL;
 

frees allocated memory in case of error in hs_smoothing

Returns:

NULL

Definition at line 58 of file hyantes.c.

Referenced by hs_smoothing().

Function Documentation

const char** hs_list_smoothing (size_t * sz)

list all available smoothing methods a smoothing method always take a radius and a distance (in kilometers) as input and returns a new distance (possibly zero)

Parameters:

sz pointer to the number of smoothing methods

Returns:

array of string constant of size *sz. Memory is still owned by hyantes

Definition at line 73 of file hyantes.c.

hs_potential_t* hs_smoothing (int resoLat, int resoLon, const char * function_name, double function_param, hs_coord_t visu, FILE * pFileReference)

perform the smoothing of target area inside visu, using potentials from pFileReference the smoothing is performed using function_name smoothing method, with a radius of function_param the resolution of the output matrix will be resoLat x resoLon

Parameters:

resoLat number of latitude points computed
resoLon number of longitude points computed
function_name name of a smoothing method listed by hs_list_smoothing
function_param parameter (in kilometers) of the smoothing method
visu visualization window
pFileReference file containg the data in the format latitude longitude potential latitude longitude potential ... latitude longitude potential where latitude and longitude are given in degrees

Returns:

an allocated array of size resoLat x resoLon containing triplets (lat, lon, pot) or NULL if an error occured

Definition at line 111 of file hyantes.c.

unsigned long hs_status ()

observer of the execution of the computation

Returns:

number of executed tasks from the beginning of the computation It should be 0 before the beginning And resoLat x resoLon, in the end

Definition at line 84 of file hyantes.c.

Author

Generated automatically by Doxygen for Hyantes from the source code.