This is the initial commit.
[keystone-rtos/netapi.git] / ti / runtime / netapi / test / trie.h
1 /*\r
2 \r
3 Copyright (c) 2005, Simon Howard\r
4 All rights reserved.\r
5 \r
6 Redistribution and use in source and binary forms, with or without \r
7 modification, are permitted provided that the following conditions \r
8 are met:\r
9 \r
10  * Redistributions of source code must retain the above copyright \r
11    notice, this list of conditions and the following disclaimer.\r
12  * Redistributions in binary form must reproduce the above copyright \r
13    notice, this list of conditions and the following disclaimer in \r
14    the documentation and/or other materials provided with the \r
15    distribution.\r
16  * Neither the name of the C Algorithms project nor the names of its \r
17    contributors may be used to endorse or promote products derived \r
18    from this software without specific prior written permission.\r
19 \r
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \r
21 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT \r
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS \r
23 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
24 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
25 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, \r
26 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; \r
27 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER \r
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT \r
29 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN \r
30 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
31 POSSIBILITY OF SUCH DAMAGE.\r
32 \r
33 */\r
34 \r
35 /**\r
36  * @file trie.h\r
37  *\r
38  * @brief Fast string lookups\r
39  *\r
40  * A trie is a data structure which provides fast mappings from strings\r
41  * to values.\r
42  *\r
43  * To create a new trie, use @ref trie_new.  To destroy a trie,\r
44  * use @ref trie_free.\r
45  *\r
46  * To insert a value into a trie, use @ref trie_insert. To remove a value\r
47  * from a trie, use @ref trie_remove.  \r
48  *\r
49  * To look up a value from its key, use @ref trie_lookup.\r
50  *\r
51  * To find the number of entries in a trie, use @ref trie_num_entries.\r
52  */\r
53 \r
54 #ifndef ALGORITHM_TRIE_H\r
55 #define ALGORITHM_TRIE_H\r
56 \r
57 #ifdef __cplusplus\r
58 extern "C" {\r
59 #endif\r
60 \r
61 typedef struct _Trie Trie;\r
62 \r
63 /**\r
64  * Create a new trie.\r
65  *\r
66  * @return                   Pointer to a new trie structure.\r
67  */\r
68 \r
69 Trie *trie_new(void);\r
70 \r
71 /** \r
72  * Destroy a trie.\r
73  *\r
74  * @param trie               The trie to destroy.\r
75  */\r
76 \r
77 void trie_free(Trie *trie);\r
78 \r
79 /**\r
80  * Insert a new key-value pair into a trie.\r
81  *\r
82  * @param trie               The trie.\r
83  * @param key                The key to access the new value.\r
84  * @param value              The value.\r
85  */\r
86 \r
87 void trie_insert(Trie *trie, char *key, int keylen, void *value);\r
88 \r
89 /**\r
90  * Look up a value from its key in a trie.\r
91  *\r
92  * @param trie               The trie.\r
93  * @param key                The key.\r
94  * @return                   The value associated with the key, or NULL if\r
95  *                           not found in the trie.\r
96  */\r
97 \r
98 void *trie_lookup(Trie *trie, char *key, int keylen);\r
99 \r
100 /**\r
101  * Remove an entry from a trie.\r
102  *\r
103  * @param trie               The trie.\r
104  * @param key                The key of the entry to remove.\r
105  */\r
106 \r
107 void trie_remove(Trie *trie, char *key, int keylen);\r
108 \r
109 /** \r
110  * Find the number of entries in a trie.\r
111  *\r
112  * @param trie               The trie.\r
113  * @return                   Count of the number of entries in the trie.\r
114  */\r
115 \r
116 int trie_num_entries(Trie *trie);\r
117 \r
118 #ifdef __cplusplus\r
119 }\r
120 #endif\r
121 \r
122 #endif /* #ifndef ALGORITHM_TRIE_H */\r
123 \r