datrie/alpha-map.h File Reference

AlphaMap data type and functions. More...


Typedefs

typedef struct _AlphaMap AlphaMap
 AlphaMap data type.

Functions

AlphaMapalpha_map_new ()
 Create new alphabet map.
AlphaMapalpha_map_clone (const AlphaMap *a_map)
 Create a clone of alphabet map.
void alpha_map_free (AlphaMap *alpha_map)
 Free an alphabet map object.
int alpha_map_add_range (AlphaMap *alpha_map, AlphaChar begin, AlphaChar end)
 Add a range to alphabet map.
int alpha_char_strlen (const AlphaChar *str)
 Alphabet string length.


Detailed Description

AlphaMap data type and functions.


Function Documentation

int alpha_char_strlen ( const AlphaChar str  ) 

Alphabet string length.

Parameters:
str : the array of null-terminated AlphaChar string to measure
Returns:
the total characters in str.

int alpha_map_add_range ( AlphaMap alpha_map,
AlphaChar  begin,
AlphaChar  end 
)

Add a range to alphabet map.

Parameters:
alpha_map : the alphabet map object
begin : the first character of the range
end : the last character of the range
Add a range of character codes from begin to end to the alphabet set.

AlphaMap* alpha_map_clone ( const AlphaMap a_map  ) 

Create a clone of alphabet map.

Parameters:
a_map : the source alphabet map to clone
Returns:
a pointer to the alphabet map clone, NULL on failure
The created object must be freed with alpha_map_free().

void alpha_map_free ( AlphaMap alpha_map  ) 

Free an alphabet map object.

Parameters:
alpha_map : the alphabet map object to free
Destruct the alpha_map and free its allocated memory.

AlphaMap* alpha_map_new (  ) 

Create new alphabet map.

Returns:
a pointer to the newly created alphabet map, NULL on failure
Create a new empty alphabet map. The map contents can then be added with alpha_map_add_range().

The created object must be freed with alpha_map_free().


Generated on Tue Mar 23 17:20:52 2010 for libdatrie by  doxygen 1.5.7.1