From 92aeefebac055291c02961a4ebd3121c8632f257 Mon Sep 17 00:00:00 2001 From: George Bosilca Date: Tue, 30 Apr 2013 23:23:57 +0000 Subject: [PATCH] The constructor and destructor are not publicly visible functions. Fix the indentation. This commit was SVN r28423. --- ompi/class/ompi_rb_tree.c | 29 ++++-- ompi/class/ompi_rb_tree.h | 188 +++++++++++++++++--------------------- 2 files changed, 105 insertions(+), 112 deletions(-) diff --git a/ompi/class/ompi_rb_tree.c b/ompi/class/ompi_rb_tree.c index 3e786c1012..ea925c958b 100644 --- a/ompi/class/ompi_rb_tree.c +++ b/ompi/class/ompi_rb_tree.c @@ -23,11 +23,6 @@ #include "ompi/class/ompi_rb_tree.h" -/* declare the instance of the classes */ -OBJ_CLASS_INSTANCE(ompi_rb_tree_node_t, ompi_free_list_item_t, NULL, NULL); -OBJ_CLASS_INSTANCE(ompi_rb_tree_t, opal_object_t, ompi_rb_tree_construct, - ompi_rb_tree_destruct); - /* Private functions */ static void btree_insert(ompi_rb_tree_t *tree, ompi_rb_tree_node_t * node); static void btree_delete_fixup(ompi_rb_tree_t *tree, ompi_rb_tree_node_t * x); @@ -43,9 +38,14 @@ static void inorder_traversal(ompi_rb_tree_t *tree, ompi_rb_tree_node_t * node); - -/* constructor */ -void ompi_rb_tree_construct(opal_object_t * object) +/** + * the constructor function. creates the free list to get the nodes from + * + * @param object the tree that is to be used + * + * @retval NONE + */ +static void ompi_rb_tree_construct(opal_object_t * object) { ompi_rb_tree_t * tree = (ompi_rb_tree_t *) object; tree->root_ptr = NULL; @@ -56,8 +56,12 @@ void ompi_rb_tree_construct(opal_object_t * object) 0, -1 , 128, NULL); } -/* the destructor function */ -void ompi_rb_tree_destruct(opal_object_t * object) +/** + * the destructor function. Free the tree and destroys the free list. + * + * @param object the tree object + */ +static void ompi_rb_tree_destruct(opal_object_t * object) { if(NULL != ((ompi_rb_tree_t *)object)->root_ptr) { ompi_rb_tree_destroy((ompi_rb_tree_t *) object); @@ -66,6 +70,11 @@ void ompi_rb_tree_destruct(opal_object_t * object) return; } +/* declare the instance of the classes */ +OBJ_CLASS_INSTANCE(ompi_rb_tree_node_t, ompi_free_list_item_t, NULL, NULL); +OBJ_CLASS_INSTANCE(ompi_rb_tree_t, opal_object_t, ompi_rb_tree_construct, + ompi_rb_tree_destruct); + /* Create the tree */ int ompi_rb_tree_init(ompi_rb_tree_t * tree, ompi_rb_tree_comp_fn_t comp) diff --git a/ompi/class/ompi_rb_tree.h b/ompi/class/ompi_rb_tree.h index a12b814c27..421e88371a 100644 --- a/ompi/class/ompi_rb_tree.h +++ b/ompi/class/ompi_rb_tree.h @@ -37,16 +37,16 @@ BEGIN_C_DECLS */ /** - * red and black enum - */ + * red and black enum + */ typedef enum {RED, BLACK} ompi_rb_tree_nodecolor_t; /** - * node data structure - */ + * node data structure + */ struct ompi_rb_tree_node_t { - ompi_free_list_item_t super; /**< the parent class */ + ompi_free_list_item_t super; /**< the parent class */ ompi_rb_tree_nodecolor_t color; /**< the node color */ struct ompi_rb_tree_node_t * parent;/**< the parent node, can be NULL */ struct ompi_rb_tree_node_t * left; /**< the left child - can be nill */ @@ -57,20 +57,20 @@ struct ompi_rb_tree_node_t typedef struct ompi_rb_tree_node_t ompi_rb_tree_node_t; /** - * the compare function typedef. This function is used to compare 2 nodes. - */ + * the compare function typedef. This function is used to compare 2 nodes. + */ typedef int (*ompi_rb_tree_comp_fn_t)(void *key1, void *key2); /** - * the data structure that holds all the needed information about the tree. - */ + * the data structure that holds all the needed information about the tree. + */ struct ompi_rb_tree_t { opal_object_t parent; /**< the parent class */ /* this root pointer doesn't actually point to the root of the tree. * rather, it points to a sentinal node who's left branch is the real * root of the tree. This is done to eliminate special cases */ ompi_rb_tree_node_t * root_ptr;/**< a pointer to the root of the tree */ - ompi_rb_tree_node_t * nill; /**< the nill sentinal node */ + ompi_rb_tree_node_t * nill; /**< the nill sentinel node */ ompi_rb_tree_comp_fn_t comp; /**< the compare function */ ompi_free_list_t free_list; /**< the free list to get the memory from */ size_t tree_size; /**< the size of the tree */ @@ -84,17 +84,17 @@ OMPI_DECLSPEC OBJ_CLASS_DECLARATION(ompi_rb_tree_t); /* Function pointers for map traversal function */ /** - * this function is used for the ompi_rb_tree_traverse function. - * it is passed a pointer to the value for each node and, if it returns - * a one, the action function is called on that node. Otherwise, the node is ignored. - */ + * this function is used for the ompi_rb_tree_traverse function. + * it is passed a pointer to the value for each node and, if it returns + * a one, the action function is called on that node. Otherwise, the node is ignored. + */ typedef int (*ompi_rb_tree_condition_fn_t)(void *); /** - * this function is uused for the user to perform any action on the passed - * values. The first argument is the key and the second is the value. - * note that this function SHOULD NOT modify the keys, as that would - * mess up the tree. - */ + * this function is used for the user to perform any action on the passed + * values. The first argument is the key and the second is the value. + * note that this function SHOULD NOT modify the keys, as that would + * mess up the tree. + */ typedef void (*ompi_rb_tree_action_fn_t)(void *, void *); /* @@ -102,115 +102,99 @@ typedef void (*ompi_rb_tree_action_fn_t)(void *, void *); */ /** - * the construct function. creates the free list to get the nodes from - * - * @param object the tree that is to be used - * - * @retval NONE - */ -OMPI_DECLSPEC void ompi_rb_tree_construct(opal_object_t * object); - -/** - * the destruct function. tries to free the tree and destroys the free list - * - * @param object the tree object - */ -OMPI_DECLSPEC void ompi_rb_tree_destruct(opal_object_t * object); - -/** - * the function creates a new tree - * - * @param tree a pointer to an allocated area of memory for the main - * tree data structure. - * @param comp a pointer to the function to use for comaparing 2 nodes - * - * @retval OMPI_SUCCESS if it is successful - * @retval OMPI_ERR_TEMP_OUT_OF_RESOURCE if unsuccessful - */ + * the function creates a new tree + * + * @param tree a pointer to an allocated area of memory for the main + * tree data structure. + * @param comp a pointer to the function to use for comaparing 2 nodes + * + * @retval OMPI_SUCCESS if it is successful + * @retval OMPI_ERR_TEMP_OUT_OF_RESOURCE if unsuccessful + */ OMPI_DECLSPEC int ompi_rb_tree_init(ompi_rb_tree_t * tree, ompi_rb_tree_comp_fn_t comp); /** - * inserts a node into the tree - * - * @param tree a pointer to the tree data structure - * @param key the key for the node - * @param value the value for the node - * - * @retval OMPI_SUCCESS - * @retval OMPI_ERR_TEMP_OUT_OF_RESOURCE if unsuccessful - */ + * inserts a node into the tree + * + * @param tree a pointer to the tree data structure + * @param key the key for the node + * @param value the value for the node + * + * @retval OMPI_SUCCESS + * @retval OMPI_ERR_TEMP_OUT_OF_RESOURCE if unsuccessful + */ OMPI_DECLSPEC int ompi_rb_tree_insert(ompi_rb_tree_t *tree, void * key, void * value); /** - * finds a value in the tree based on the passed key using passed - * compare function - * - * @param tree a pointer to the tree data structure - * @param key a pointer to the key - * @param compare function - * - * @retval pointer to the value if found - * @retval NULL if not found - */ + * finds a value in the tree based on the passed key using passed + * compare function + * + * @param tree a pointer to the tree data structure + * @param key a pointer to the key + * @param compare function + * + * @retval pointer to the value if found + * @retval NULL if not found + */ OMPI_DECLSPEC void * ompi_rb_tree_find_with(ompi_rb_tree_t *tree, void *key, ompi_rb_tree_comp_fn_t compfn); /** - * finds a value in the tree based on the passed key - * - * @param tree a pointer to the tree data structure - * @param key a pointer to the key - * - * @retval pointer to the value if found - * @retval NULL if not found - */ + * finds a value in the tree based on the passed key + * + * @param tree a pointer to the tree data structure + * @param key a pointer to the key + * + * @retval pointer to the value if found + * @retval NULL if not found + */ static inline void * ompi_rb_tree_find(ompi_rb_tree_t *tree, void *key) { - return ompi_rb_tree_find_with(tree, key, tree->comp); + return ompi_rb_tree_find_with(tree, key, tree->comp); } /** - * deletes a node based on its key - * - * @param tree a pointer to the tree data structure - * @param key a pointer to the key - * - * @retval OMPI_SUCCESS if the node is found and deleted - * @retval OMPI_ERR_NOT_FOUND if the node is not found - */ + * deletes a node based on its key + * + * @param tree a pointer to the tree data structure + * @param key a pointer to the key + * + * @retval OMPI_SUCCESS if the node is found and deleted + * @retval OMPI_ERR_NOT_FOUND if the node is not found + */ OMPI_DECLSPEC int ompi_rb_tree_delete(ompi_rb_tree_t *tree, void *key); /** - * frees all the nodes on the tree - * - * @param tree a pointer to the tree data structure - * - * @retval OMPI_SUCCESS - */ + * frees all the nodes on the tree + * + * @param tree a pointer to the tree data structure + * + * @retval OMPI_SUCCESS + */ OMPI_DECLSPEC int ompi_rb_tree_destroy(ompi_rb_tree_t *tree); /** - * traverses the entire tree, performing the cond function on each of the - * values and if it returns one it performs the action function on the values - * - * @param tree a pointer to the tree - * @param cond a pointer to the condition function - * @param action a pointer to the action function - * - * @retval OMPI_SUCCESS - * @retval OMPI_ERROR if there is an error - */ + * traverses the entire tree, performing the cond function on each of the + * values and if it returns one it performs the action function on the values + * + * @param tree a pointer to the tree + * @param cond a pointer to the condition function + * @param action a pointer to the action function + * + * @retval OMPI_SUCCESS + * @retval OMPI_ERROR if there is an error + */ OMPI_DECLSPEC int ompi_rb_tree_traverse(ompi_rb_tree_t *tree, ompi_rb_tree_condition_fn_t cond, ompi_rb_tree_action_fn_t action); /** - * returns the size of the tree - * - * @param tree a pointer to the tree data structure - * - * @retval int the nuber of items on the tree - */ + * returns the size of the tree + * + * @param tree a pointer to the tree data structure + * + * @retval int the nuber of items on the tree + */ OMPI_DECLSPEC int ompi_rb_tree_size(ompi_rb_tree_t *tree); END_C_DECLS