Classes |
| struct | mkavl_allocator_st_ |
Typedefs |
| typedef struct mkavl_tree_st_ * | mkavl_tree_handle |
| typedef struct mkavl_iterator_st_ * | mkavl_iterator_handle |
| typedef enum mkavl_rc_e_ | mkavl_rc_e |
| typedef enum mkavl_find_type_e_ | mkavl_find_type_e |
| typedef void *(* | mkavl_malloc_fn )(size_t size, void *context) |
| typedef void(* | mkavl_free_fn )(void *ptr, void *context) |
| typedef struct mkavl_allocator_st_ | mkavl_allocator_st |
| typedef int32_t(* | mkavl_compare_fn )(const void *item1, const void *item2, void *context) |
| typedef mkavl_rc_e(* | mkavl_item_fn )(void *item, void *context) |
| typedef mkavl_rc_e(* | mkavl_delete_context_fn )(void *context) |
| typedef void *(* | mkavl_copy_fn )(void *item, void *context) |
| typedef mkavl_rc_e(* | mkavl_walk_cb_fn )(void *item, void *tree_context, void *walk_context, bool *stop_walk) |
Enumerations |
| enum | mkavl_rc_e_ {
MKAVL_RC_E_INVALID,
MKAVL_RC_E_SUCCESS,
MKAVL_RC_E_EINVAL,
MKAVL_RC_E_ENOMEM,
MKAVL_RC_E_EOOSYNC,
MKAVL_RC_E_MAX
} |
| enum | mkavl_find_type_e_ {
MKAVL_FIND_TYPE_E_INVALID,
MKAVL_FIND_TYPE_E_EQUAL,
MKAVL_FIND_TYPE_E_FIRST = MKAVL_FIND_TYPE_E_EQUAL,
MKAVL_FIND_TYPE_E_GT,
MKAVL_FIND_TYPE_E_LT,
MKAVL_FIND_TYPE_E_GE,
MKAVL_FIND_TYPE_E_LE,
MKAVL_FIND_TYPE_E_MAX
} |
Functions |
| bool | mkavl_rc_e_is_notok (mkavl_rc_e rc) |
| bool | mkavl_rc_e_is_ok (mkavl_rc_e rc) |
| bool | mkavl_rc_e_is_valid (mkavl_rc_e rc) |
| const char * | mkavl_rc_e_get_string (mkavl_rc_e rc) |
| bool | mkavl_find_type_e_is_valid (mkavl_find_type_e type) |
| const char * | mkavl_find_type_e_get_string (mkavl_find_type_e type) |
| mkavl_rc_e | mkavl_new (mkavl_tree_handle *tree_h, mkavl_compare_fn *compare_fn_array, size_t compare_fn_array_count, void *context, mkavl_allocator_st *allocator) |
| void * | mkavl_get_tree_context (mkavl_tree_handle tree_h) |
| mkavl_rc_e | mkavl_delete (mkavl_tree_handle *tree_h, mkavl_item_fn item_fn, mkavl_delete_context_fn delete_context_fn) |
| mkavl_rc_e | mkavl_copy (const mkavl_tree_handle source_tree_h, mkavl_tree_handle *new_tree_h, mkavl_copy_fn copy_fn, mkavl_item_fn item_fn, bool use_source_context, void *new_context, mkavl_delete_context_fn delete_context_fn, mkavl_allocator_st *allocator) |
| mkavl_rc_e | mkavl_add (mkavl_tree_handle tree_h, void *item_to_add, void **existing_item) |
| mkavl_rc_e | mkavl_find (mkavl_tree_handle tree_h, mkavl_find_type_e type, size_t key_idx, const void *lookup_item, void **found_item) |
| mkavl_rc_e | mkavl_remove (mkavl_tree_handle tree_h, const void *item_to_remove, void **found_item) |
| mkavl_rc_e | mkavl_add_key_idx (mkavl_tree_handle tree_h, size_t key_idx, void *item_to_add, void **existing_item) |
| mkavl_rc_e | mkavl_remove_key_idx (mkavl_tree_handle tree_h, size_t key_idx, const void *item_to_remove, void **found_item) |
| uint32_t | mkavl_count (mkavl_tree_handle tree_h) |
| mkavl_rc_e | mkavl_walk (mkavl_tree_handle tree_h, mkavl_walk_cb_fn cb_fn, void *walk_context) |
| mkavl_rc_e | mkavl_iter_new (mkavl_iterator_handle *iterator_h, mkavl_tree_handle tree_h, size_t key_idx) |
| mkavl_rc_e | mkavl_iter_delete (mkavl_iterator_handle *iterator_h) |
| mkavl_rc_e | mkavl_iter_first (mkavl_iterator_handle iterator_h, void **item) |
| mkavl_rc_e | mkavl_iter_last (mkavl_iterator_handle iterator_h, void **item) |
| mkavl_rc_e | mkavl_iter_find (mkavl_iterator_handle iterator_h, void *lookup_item, void **found_item) |
| mkavl_rc_e | mkavl_iter_next (mkavl_iterator_handle iterator_h, void **item) |
| mkavl_rc_e | mkavl_iter_prev (mkavl_iterator_handle iterator_h, void **item) |
| mkavl_rc_e | mkavl_iter_cur (mkavl_iterator_handle iterator_h, void **item) |
- Author:
- Matt Miller <matt@matthewjmiller.net>
LICENSE
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
DESCRIPTION
This is the public interface for the multi-key AVL interface.
Definition in file mkavl.h.
Add an item only to a specific AVL tree within the mkavl tree. Note that this must be used very carefully in conjunction with mkavl_remove_key_idx to make sure the mkavl does not become out of sync. In steady state, the mkavl should always have an equal number of data items in each AVL tree. However, if a field changes in an item that affects some keys but not other, these APIs may be used to remove the item with the old values from the affected AVLs, update the values, and then re-add to each AVL tree from which the old item was removed.
- See also:
- mkavl_remove_key_idx
- Parameters:
-
| tree_h | The mkavl tree. |
| key_idx | The index of the AVL tree to which the item is added. |
| item_to_add | The item being added. |
| existing_item | If an existing item is found, it is returned. |
- Returns:
- The return code
Definition at line 1422 of file mkavl.c.
Remove an item only from a specific AVL tree within the mkavl tree. Note that this must be used very carefully in conjunction with mkavl_add_key_idx to make sure the mkavl does not become out of sync. In steady state, the mkavl should always have an equal number of data items in each AVL tree. However, if a field changes in an item that affects some keys but not other, these APIs may be used to remove the item with the old values from the affected AVLs, update the values, and then re-add to each AVL tree from which the old item was removed.
- See also:
- mkavl_add_key_idx
- Parameters:
-
| tree_h | The mkavl tree. |
| key_idx | The index of the AVL tree to which the item is added. |
| item_to_remove | The item being removed. |
| found_item | If the item existed, the item that was found and removed. |
- Returns:
- The return code
Definition at line 1464 of file mkavl.c.
1.7.4