1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/* Make header file work when included from C++ */
#ifdef __cplusplus
extern "C" {
#endif
struct sb_stemmer;
typedef unsigned char sb_symbol;
/* FIXME - should be able to get a version number for each stemming
* algorithm (which will be incremented each time the output changes). */
/** Returns an array of the names of the available stemming algorithms.
* Note that these are the canonical names - aliases (ie, other names for
* the same algorithm) will not be included in the list.
* The list is terminated with a null pointer.
*
* The list must not be modified in any way.
*/
const char ** sb_stemmer_list(void);
/** Create a new stemmer object, using the specified algorithm, for the
* specified character encoding.
*
* All algorithms will usually be available in UTF-8, but may also be
* available in other character encodings.
*
* @param algorithm The algorithm name. This is either the english
* name of the algorithm, or the 2 or 3 letter ISO 639 codes for the
* language. Note that case is significant in this parameter - the
* value should be supplied in lower case.
*
* @param charenc The character encoding. NULL may be passed as
* this value, in which case UTF-8 encoding will be assumed. Otherwise,
* the argument may be one of "UTF_8", "ISO_8859_1" (i.e. Latin 1),
* "ISO_8859_2" (i.e. Latin 2) or "KOI8_R" (Russian). Note that case is
* significant in this parameter.
*
* @return NULL if the specified algorithm is not recognised, or the
* algorithm is not available for the requested encoding. Otherwise,
* returns a pointer to a newly created stemmer for the requested algorithm.
* The returned pointer must be deleted by calling sb_stemmer_delete().
*
* @note NULL will also be returned if an out of memory error occurs.
*/
struct sb_stemmer * sb_stemmer_new(const char * algorithm, const char * charenc);
/** Delete a stemmer object.
*
* This frees all resources allocated for the stemmer. After calling
* this function, the supplied stemmer may no longer be used in any way.
*
* It is safe to pass a null pointer to this function - this will have
* no effect.
*/
void sb_stemmer_delete(struct sb_stemmer * stemmer);
/** Stem a word.
*
* The return value is owned by the stemmer - it must not be freed or
* modified, and it will become invalid when the stemmer is called again,
* or if the stemmer is freed.
*
* The length of the return value can be obtained using sb_stemmer_length().
*
* If an out-of-memory error occurs, this will return NULL.
*/
const sb_symbol * sb_stemmer_stem(struct sb_stemmer * stemmer,
const sb_symbol * word, int size);
/** Get the length of the result of the last stemmed word.
* This should not be called before sb_stemmer_stem() has been called.
*/
int sb_stemmer_length(struct sb_stemmer * stemmer);
#ifdef __cplusplus
}
#endif
|
