bstree.h

Go to the documentation of this file.

 
/* **********************************************************************
 *                                  *
 * Changelog                                *
 *                                  *
 * Date     Author  Version Description             *
 *                                  *
 * 05/11/2015   MG  1.0.1   First release.              *
 * 06/11/2015   MG  1.0.2   Elevate errno defs to listsandsorts.h.  *
 * 16/07/2016   MG  1.0.3   Move towards kernel coding style.   *
 * 17/07/2016   MG  1.0.4   Remove function prototype comments. *
 * 21/01/2017   MG  1.0.5   listsandsorts.h mentioned above has *
 *              been replaced with mgeerrno.h.      *
 * 22/03/2017   MG  1.0.6   Added node trace function prototype and *
 *              struct.                 *
 * 03/04/2017   MG  1.0.7   Add bst struct, cre_bst & del_bst() *
 *              prototypes.             *
 * 04/11/2017   MG  1.0.8   Add Doxygen comments.           *
 * 09/11/2017   MG  1.0.9   Add SPDX license tag.           *
 * 02/01/2018   MG  1.0.10  Move to new source directory structure. *
 * 02/06/2018   MG  1.0.11  Add node and counter totals to the tree *
 *              struct.                 *
 * 08/06/2019   MG  1.0.12  clang-format coding style changes.  *
 *                                  *
 ************************************************************************
 */
 
#ifndef BSTREE_H
#define BSTREE_H
 
#include <portability.h>
 
BEGIN_C_DECLS
 
#define BST_NODES_UNIQUE 1     
#define BST_NODES_DUPLICATES 0 
struct bstobjcoord {
    void *object; 
    int count;    
    int xdir;     
    int ydir;     
};
 
struct bstreenode {
    void *object;             
    int count;            
    struct bstreenode *childless; 
    struct bstreenode *childgreater; 
};
 
struct bstree {
    struct bstreenode *root; 
    int unique;      
    int count_total;     
    int node_total;      
    int (*comp)(const void *, const void *); 
};
 
struct bstree *cre_bst(int unique, int (*comp)(const void *, const void *));
 
struct bstree *add_bst_node(struct bstree *tree, const void *object,
                size_t objsize);
 
void *find_bst_node(const struct bstree *tree, const void *searchobj);
 
int get_counter_bst_node(const struct bstree *tree, const void *searchobj);
 
void *find_next_bst_node(const struct bstree *tree, const void *searchobj);
 
void *find_prev_bst_node(const struct bstree *tree, const void *searchobj);
 
void *upd_bst_node(const struct bstree *tree, const void *updobj,
           size_t objsize);
 
struct bstree *del_bst_node(struct bstree *tree, const void *searchobj);
 
struct bstree *del_bst(struct bstree *tree);
 
struct bstobjcoord *find_next_bst_node_trace(const struct bstree *tree,
                         struct bstobjcoord *searchobj);
 
END_C_DECLS
 
#endif /* ndef BSTREE_H */