tdelete

NAME

tdelete, tfind, tsearch, twalk - manage a binary search tree

SYNOPSIS

[XSI] #include <search.h>

void *tdelete(const void *restrict key, void **restrict rootp,
       int(*compar)(const void *, const void *));
void *tfind(const void *key, void *const *rootp,
       int(*compar)(const void *, const void *));
void *tsearch(const void *key, void **rootp,
       int (*compar)(const void *, const void *));
void twalk(const void *root,
       void (*action)(const void *, VISIT, int));

DESCRIPTION

The tdelete(), tfind(), tsearch(), and twalk() functions manipulate binary search trees. Comparisonsare made with a user-supplied routine, the address of which is passed as the compar argument. This routine is called withtwo arguments, which are the pointers to the elements being compared. The application shall ensure that the user-supplied routinereturns an integer less than, equal to, or greater than 0, according to whether the first argument is to be considered less than,equal to, or greater than the second argument. The comparison function need not compare every byte, so arbitrary data may becontained in the elements in addition to the values being compared.

The tsearch() function shall build and access the tree. The key argument is a pointer to an element to be accessedor stored. If there is a node in the tree whose element is equal to the value pointed to by key, a pointer to this foundnode shall be returned. Otherwise, the value pointed to by key shall be inserted (that is, a new node is created and thevalue of key is copied to this node), and a pointer to this node returned. Only pointers are copied, so the applicationshall ensure that the calling routine stores the data. The rootp argument points to a variable that points to the root nodeof the tree. A null pointer value for the variable pointed to by rootp denotes an empty tree; in this case, the variableshall be set to point to the node which shall be at the root of the new tree.

Like tsearch(), tfind() shall search for a node in the tree, returning a pointer to it if found. However, if it isnot found, tfind() shall return a null pointer. The arguments for tfind() are the same as for tsearch().

The tdelete() function shall delete a node from a binary search tree. The arguments are the same as for tsearch().The variable pointed to by rootp shall be changed if the deleted node was the root of the tree. The tdelete()function shall return a pointer to the parent of the deleted node, or an unspecified non-null pointer if the deleted node was theroot node, or a null pointer if the node is not found.

If tsearch() adds an element to a tree, or tdelete() successfully deletes an element from a tree, the concurrentuse of that tree in another thread, or use of pointers produced by a previous call to tfind() or tsearch(), producesundefined results.

The twalk() function shall traverse a binary search tree. The root argument is a pointer to the root node of thetree to be traversed. (Any node in a tree may be used as the root for a walk below that node.) The argument action is thename of a routine to be invoked at each node. This routine is, in turn, called with three arguments. The first argument shall bethe address of the node being visited. The structure pointed to by this argument is unspecified and shall not be modified by theapplication, but it shall be possible to cast a pointer-to-node into a pointer-to-pointer-to-element to access the element storedin the node. The second argument shall be a value from an enumeration data type:

typedef enum { preorder, postorder, endorder, leaf } VISIT;

(defined in <search.h>), depending on whether this is the first, second, orthird time that the node is visited (during a depth-first, left-to-right traversal of the tree), or whether the node is a leaf. Thethird argument shall be the level of the node in the tree, with the root being level 0.

If the calling function alters the pointer to the root, the result is undefined.

If the functions pointed to by action or compar (for any of these binary search functions) change the tree, theresults are undefined.

These functions are thread-safe only as long as multiple threads do not access the same tree.

RETURN VALUE

If the node is found, both tsearch() and tfind() shall return a pointer to it. If not, tfind() shall returna null pointer, and tsearch() shall return a pointer to the inserted item.

A null pointer shall be returned by tsearch() if there is not enough space available to create a new node.

A null pointer shall be returned by tdelete(), tfind(), and tsearch() if rootp is a null pointer onentry.

The tdelete() function shall return a pointer to the parent of the deleted node, or an unspecified non-null pointer ifthe deleted node was the root node, or a null pointer if the node is not found.

The twalk() function shall not return a value.

ERRORS

No errors are defined.

---

The following sections are informative.

EXAMPLES

The following code reads in strings and stores structures containing a pointer to each string and a count of its length. It thenwalks the tree, printing out the stored strings and their lengths in alphabetical order.

#include <search.h>
#include <string.h>
#include <stdio.h>


#define STRSZ    10000
#define NODSZ    500


struct node {      /* Pointers to these are stored in the tree. */
    char    *string;
    int     length;
};


char   string_space[STRSZ];  /* Space to store strings. */
struct node nodes[NODSZ];    /* Nodes to store. */
void  *root = NULL;          /* This points to the root. */


int main(int argc, char *argv[])
{
    char   *strptr = string_space;
    struct node    *nodeptr = nodes;
    void   print_node(const void *, VISIT, int);
    int    i = 0, node_compare(const void *, const void *);


    while (gets(strptr) != NULL && i++ < NODSZ)  {
        /* Set node. */
        nodeptr->string = strptr;
        nodeptr->length = strlen(strptr);
        /* Put node into the tree. */
        (void) tsearch((void *)nodeptr, (void **)&root,
            node_compare);
        /* Adjust pointers, so we do not overwrite tree. */
        strptr += nodeptr->length + 1;
        nodeptr++;
    }
    twalk(root, print_node);
    return 0;
}


/*
 *  This routine compares two nodes, based on an
 *  alphabetical ordering of the string field.
 */
int
node_compare(const void *node1, const void *node2)
{
    return strcmp(((const struct node *) node1)->string,
        ((const struct node *) node2)->string);
}


/*
 *  This routine prints out a node, the second time
 *  twalk encounters it or if it is a leaf.
 */
void
print_node(const void *ptr, VISIT order, int level)
{
    const struct node *p = *(const struct node **) ptr;


    if (order == postorder || order == leaf)  {
        (void) printf("string = %s,  length = %d\n",
            p->string, p->length);
    }
}

APPLICATION USAGE

The root argument to twalk() is one level of indirection less than the rootp arguments to tdelete()and tsearch().

There are two nomenclatures used to refer to the order in which tree nodes are visited. The tsearch() function usespreorder, postorder, and endorder to refer respectively to visiting a node before any of its children, afterits left child and before its right, and after both its children. The alternative nomenclature uses preorder,inorder, and postorder to refer to the same visits, which could result in some confusion over the meaning ofpostorder.

Since the return value of tdelete() is an unspecified non-null pointer in the case that the root of the tree has beendeleted, applications should only use the return value of tdelete() as indication of success or failure and should notassume it can be dereferenced. Some implementations in this case will return a pointer to the new root of the tree (or to an emptytree if the deleted root node was the only node in the tree); other implementations return arbitrary non-null pointers.