---

epUtils.h

Go to the documentation of this file.

#ifndef _EPUTILS_H_
#define _EPUTILS_H_

#include "epDefs.h"

/* "graine" utilisée pour la génération de la valeur de hashage
   par défaut d'une chaîne de caractère                                         */
#define _B_     128



/*
   Generic pointer deallocator function (in fact, it just make a free).<br>

   <b>visibility :: <i>public</i></b>

   @param   ptr  the pointer to deallocate
   @retval    0  if <b>OK</b>,
   @retval   -1  else.
 */
int epUtils_ptrDeallocatorFunction(void *ptr);

/*
   Estimate if a number is a <b>prime</b> number.<br>
   return <true> if so, <false> else.<br>

   <b>visibility :: <i>public</i></b>

   @param   oddNumber  a number
   @retval     <true>  if it is prime,
   @retval    <false>  else.
 */
boolean_t epUtils_isProbablePrime(ulong oddNumber);

/*
   A Generic string comparison function (which take care of the case).<b>

   <b>visibility :: <i>public</i></b>

   @param   str1     the first string
   @param   str2     the second string
   @retval  <true>   if they are equals,
   @retval  <false>  else.
 */
boolean_t epUtils_stringComparisonFunction(const void *str1, const void *str2);

/*
   A Generic hash function for <i>string-typed</i> keys.<br>

   <b>visibility :: <i>public</i></b>

   @remarks  
             1. hash function used is:  
                <i>h(c) = ( s[0]*b^(n-1) + s[1]*b^(n-2) + ... + s[n-1] )</i>

                where:
                          s is the key
                          n its length
                          b = 128 or 256

   @param   key  the key(a string) 
   @return       its hash value.
 */
uint epUtils_stringHashFunction(const void *key);

#endif /* _EPUTILS_H_ */
     

---