Add documentation
This commit is contained in:
@@ -1,3 +1,11 @@
|
||||
/**
|
||||
* @file tries.yap
|
||||
* @author Ricardo Rocha
|
||||
*
|
||||
* @brief
|
||||
*
|
||||
*
|
||||
*/
|
||||
/****************************************
|
||||
File: tries.yap
|
||||
Author: Ricardo Rocha
|
||||
@@ -5,8 +13,53 @@
|
||||
version: $ID$
|
||||
****************************************/
|
||||
|
||||
:- module(tries, [
|
||||
trie_open/1,
|
||||
trie_close/1,
|
||||
trie_close_all/0,
|
||||
trie_empty/1,
|
||||
trie_mode/1,
|
||||
trie_put_entry/3,
|
||||
trie_check_entry/3,
|
||||
trie_get_entry/2,
|
||||
trie_get_first_entry/2,
|
||||
trie_get_last_entry/2,
|
||||
trie_traverse/2,
|
||||
trie_traverse/3,
|
||||
trie_remove_entry/1,
|
||||
trie_remove_subtree/1,
|
||||
trie_join/2,
|
||||
trie_intersect/2,
|
||||
trie_count_join/3,
|
||||
trie_count_intersect/3,
|
||||
trie_dup/2,
|
||||
trie_save/2,
|
||||
trie_load/2,
|
||||
trie_stats/4,
|
||||
trie_max_stats/4,
|
||||
trie_usage/4,
|
||||
trie_print/1,
|
||||
open_trie/1,
|
||||
close_trie/1,
|
||||
close_all_tries/0,
|
||||
put_trie_entry/4,
|
||||
get_trie_entry/3,
|
||||
remove_trie_entry/1,
|
||||
print_trie/1,
|
||||
trie_traverse_mode/1,
|
||||
trie_disable_hash/0,
|
||||
trie_enable_hash/0,
|
||||
trie_traverse_first/2,
|
||||
trie_traverse_next/2,
|
||||
trie_to_list/2,
|
||||
trie_to_depth_breadth_trie/4,
|
||||
trie_to_depth_breadth_trie/6,
|
||||
trie_get_depth_breadth_reduction_entry/1,
|
||||
trie_get_depth_breadth_reduction_opt_level_count/2,
|
||||
trie_replace_nested_trie/3
|
||||
]).
|
||||
|
||||
/** @defgroup Tries Trie DataStructure
|
||||
/** @defgroup tries Trie DataStructure
|
||||
@ingroup library
|
||||
@{
|
||||
|
||||
@@ -147,51 +200,6 @@ number of _VirtualNodes_.
|
||||
|
||||
|
||||
*/
|
||||
:- module(tries, [
|
||||
trie_open/1,
|
||||
trie_close/1,
|
||||
trie_close_all/0,
|
||||
trie_empty/1,
|
||||
trie_mode/1,
|
||||
trie_put_entry/3,
|
||||
trie_check_entry/3,
|
||||
trie_get_entry/2,
|
||||
trie_get_first_entry/2,
|
||||
trie_get_last_entry/2,
|
||||
trie_traverse/2,
|
||||
trie_traverse/3,
|
||||
trie_remove_entry/1,
|
||||
trie_remove_subtree/1,
|
||||
trie_join/2,
|
||||
trie_intersect/2,
|
||||
trie_count_join/3,
|
||||
trie_count_intersect/3,
|
||||
trie_dup/2,
|
||||
trie_save/2,
|
||||
trie_load/2,
|
||||
trie_stats/4,
|
||||
trie_max_stats/4,
|
||||
trie_usage/4,
|
||||
trie_print/1,
|
||||
open_trie/1,
|
||||
close_trie/1,
|
||||
close_all_tries/0,
|
||||
put_trie_entry/4,
|
||||
get_trie_entry/3,
|
||||
remove_trie_entry/1,
|
||||
print_trie/1,
|
||||
trie_traverse_mode/1,
|
||||
trie_disable_hash/0,
|
||||
trie_enable_hash/0,
|
||||
trie_traverse_first/2,
|
||||
trie_traverse_next/2,
|
||||
trie_to_list/2,
|
||||
trie_to_depth_breadth_trie/4,
|
||||
trie_to_depth_breadth_trie/6,
|
||||
trie_get_depth_breadth_reduction_entry/1,
|
||||
trie_get_depth_breadth_reduction_opt_level_count/2,
|
||||
trie_replace_nested_trie/3
|
||||
]).
|
||||
|
||||
:- load_foreign_files([tries], [], init_tries).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user