libdict 1.0.7
Data Structure C Library
Loading...
Searching...
No Matches
wb_tree.c File Reference
#include "wb_tree.h"
#include <stdint.h>
#include "dict_private.h"
#include "tree_common.h"
Include dependency graph for wb_tree.c:

Go to the source code of this file.

Data Structures

struct  wb_node
 
struct  wb_tree
 
struct  wb_itor
 

Macros

#define WEIGHT(n)
 

Typedefs

typedef struct wb_node wb_node
 

Functions

wb_tree * wb_tree_new (dict_compare_func cmp_func)
 Create an empty tree that orders keys with |cmp_func| (must not be NULL).
 
dict * wb_dict_new (dict_compare_func cmp_func)
 Like wb_tree_new(), but wrapped in a generic dict for use with the dict_* macros.
 
void ** wb_tree_search (wb_tree *tree, const void *key)
 Return the address of the datum stored for |key|, or NULL if |key| is not present.
 
void ** wb_tree_search_le (wb_tree *tree, const void *key)
 Return the address of the datum of the greatest key less than or equal to |key|, or NULL if there is none.
 
void ** wb_tree_search_lt (wb_tree *tree, const void *key)
 Return the address of the datum of the greatest key less than |key|, or NULL if there is none.
 
void ** wb_tree_search_ge (wb_tree *tree, const void *key)
 Return the address of the datum of the least key greater than or equal to |key|, or NULL if there is none.
 
void ** wb_tree_search_gt (wb_tree *tree, const void *key)
 Return the address of the datum of the least key greater than |key|, or NULL if there is none.
 
dict_insert_result wb_tree_insert (wb_tree *tree, void *key)
 Insert |key| unless an equal key is present.
 
dict_remove_result wb_tree_remove (wb_tree *tree, const void *key)
 Remove the element with key |key|.
 
size_t wb_tree_free (wb_tree *tree, dict_delete_func delete_func)
 Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL, and free the tree.
 
size_t wb_tree_clear (wb_tree *tree, dict_delete_func delete_func)
 Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL.
 
size_t wb_tree_traverse (wb_tree *tree, dict_visit_func visit, void *user_data)
 Call |visit|(key, datum, |user_data|) for each element in key order, stopping early if |visit| returns false.
 
bool wb_tree_select (wb_tree *tree, size_t n, const void **key, void **datum)
 Store the key and datum of the |n|th element in key order (0-based) through |key| and |datum| and return true, or store NULL through them and return false if |n| is out of range.
 
size_t wb_tree_count (const wb_tree *tree)
 Return the number of elements.
 
size_t wb_tree_min_path_length (const wb_tree *tree)
 Return the shallowest depth at which a child link is absent, the root being at depth 1, or 0 for an empty tree.
 
size_t wb_tree_max_path_length (const wb_tree *tree)
 Return the greatest depth of any node, the root being at depth 1, or 0 for an empty tree: the height of the tree.
 
size_t wb_tree_total_path_length (const wb_tree *tree)
 Return the sum of the depths of all nodes, the root being at depth 1, or 0 for an empty tree.
 
bool wb_tree_verify (const wb_tree *tree)
 Check the internal invariants of the tree and return true if they hold, or print the first failed check to stderr and return false.
 
wb_itor * wb_itor_new (wb_tree *tree)
 Create an iterator over |tree| that is not positioned on any element yet.
 
dict_itor * wb_dict_itor_new (wb_tree *tree)
 Like wb_itor_new(), but wrapped in a generic dict_itor for use with the dict_itor_* macros.
 
void wb_itor_free (wb_itor *itor)
 Free an iterator.
 
bool wb_itor_valid (const wb_itor *itor)
 Return whether |itor| is positioned on an element.
 
void wb_itor_invalidate (wb_itor *itor)
 Unposition |itor|, so that it is not positioned on any element.
 
bool wb_itor_next (wb_itor *itor)
 Move |itor| to the next element in key order and return true, or unposition it and return false if there is none.
 
bool wb_itor_prev (wb_itor *itor)
 Move |itor| to the previous element in key order and return true, or unposition it and return false if there is none.
 
bool wb_itor_nextn (wb_itor *itor, size_t count)
 Move |itor| |count| elements forward and return whether it is still positioned.
 
bool wb_itor_prevn (wb_itor *itor, size_t count)
 Move |itor| |count| elements back and return whether it is still positioned.
 
bool wb_itor_first (wb_itor *itor)
 Position |itor| on the first element in key order and return true, or unposition it and return false if the tree is empty.
 
bool wb_itor_last (wb_itor *itor)
 Position |itor| on the last element in key order and return true, or unposition it and return false if the tree is empty.
 
bool wb_itor_search (wb_itor *itor, const void *key)
 Position |itor| on |key| and return true, or unposition it and return false if |key| is not present.
 
bool wb_itor_search_le (wb_itor *itor, const void *key)
 Position |itor| on the greatest key less than or equal to |key| and return true, or unposition it and return false if there is none.
 
bool wb_itor_search_lt (wb_itor *itor, const void *key)
 Position |itor| on the greatest key less than |key| and return true, or unposition it and return false if there is none.
 
bool wb_itor_search_ge (wb_itor *itor, const void *key)
 Position |itor| on the least key greater than or equal to |key| and return true, or unposition it and return false if there is none.
 
bool wb_itor_search_gt (wb_itor *itor, const void *key)
 Position |itor| on the least key greater than |key| and return true, or unposition it and return false if there is none.
 
const void * wb_itor_key (const wb_itor *itor)
 Return the key |itor| is positioned on, or NULL if it is not positioned.
 
void ** wb_itor_datum (wb_itor *itor)
 Return the address of the datum |itor| is positioned on, through which it can be read or replaced, or NULL if it is not positioned.
 
int wb_itor_compare (const wb_itor *i1, const wb_itor *i2)
 Compare the positions of two iterators over the same tree: return a negative value, zero, or a positive value as |i1| is before, at, or after |i2| in key order.
 
bool wb_itor_remove (wb_itor *itor)
 Remove the element |itor| is positioned on and unposition |itor|; return false if it was not positioned.
 

Macro Definition Documentation

◆ WEIGHT

#define WEIGHT ( n)
Value:
((n) ? (n)->weight : 1U)

Definition at line 73 of file wb_tree.c.

Typedef Documentation

◆ wb_node

typedef struct wb_node wb_node

Definition at line 67 of file wb_tree.c.

Function Documentation

◆ wb_dict_itor_new()

dict_itor * wb_dict_itor_new ( wb_tree * tree)

Like wb_itor_new(), but wrapped in a generic dict_itor for use with the dict_itor_* macros.

Free it with dict_itor_free().

Definition at line 451 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_dict_new()

dict * wb_dict_new ( dict_compare_func cmp_func)

Like wb_tree_new(), but wrapped in a generic dict for use with the dict_* macros.

Free it with dict_free(). Returns NULL if memory cannot be allocated.

Definition at line 152 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_compare()

int wb_itor_compare ( const wb_itor * i1,
const wb_itor * i2 )

Compare the positions of two iterators over the same tree: return a negative value, zero, or a positive value as |i1| is before, at, or after |i2| in key order.

An unpositioned iterator compares before every positioned one.

Definition at line 480 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_datum()

void ** wb_itor_datum ( wb_itor * itor)

Return the address of the datum |itor| is positioned on, through which it can be read or replaced, or NULL if it is not positioned.

Definition at line 479 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_first()

bool wb_itor_first ( wb_itor * itor)

Position |itor| on the first element in key order and return true, or unposition it and return false if the tree is empty.

Definition at line 471 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_free()

void wb_itor_free ( wb_itor * itor)

Free an iterator.

Definition at line 464 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_invalidate()

void wb_itor_invalidate ( wb_itor * itor)

Unposition |itor|, so that it is not positioned on any element.

Definition at line 466 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_key()

const void * wb_itor_key ( const wb_itor * itor)

Return the key |itor| is positioned on, or NULL if it is not positioned.

The key belongs to the container and must not be modified in a way that changes how it compares.

Definition at line 478 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_last()

bool wb_itor_last ( wb_itor * itor)

Position |itor| on the last element in key order and return true, or unposition it and return false if the tree is empty.

Definition at line 472 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_new()

wb_itor * wb_itor_new ( wb_tree * tree)

Create an iterator over |tree| that is not positioned on any element yet.

Returns NULL if memory cannot be allocated.

Definition at line 440 of file wb_tree.c.

◆ wb_itor_next()

bool wb_itor_next ( wb_itor * itor)

Move |itor| to the next element in key order and return true, or unposition it and return false if there is none.

An unpositioned iterator stays unpositioned and returns false.

Definition at line 467 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_nextn()

bool wb_itor_nextn ( wb_itor * itor,
size_t count )

Move |itor| |count| elements forward and return whether it is still positioned.

It becomes unpositioned if it runs past the last element.

Definition at line 469 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_prev()

bool wb_itor_prev ( wb_itor * itor)

Move |itor| to the previous element in key order and return true, or unposition it and return false if there is none.

An unpositioned iterator stays unpositioned and returns false.

Definition at line 468 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_prevn()

bool wb_itor_prevn ( wb_itor * itor,
size_t count )

Move |itor| |count| elements back and return whether it is still positioned.

It becomes unpositioned if it runs past the first element.

Definition at line 470 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_remove()

bool wb_itor_remove ( wb_itor * itor)

Remove the element |itor| is positioned on and unposition |itor|; return false if it was not positioned.

No delete function is called, so fetch the key and datum first if they need freeing. See Iterator invalidation for which iterators this invalidates.

Definition at line 483 of file wb_tree.c.

◆ wb_itor_search()

bool wb_itor_search ( wb_itor * itor,
const void * key )

Position |itor| on |key| and return true, or unposition it and return false if |key| is not present.

Definition at line 473 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_search_ge()

bool wb_itor_search_ge ( wb_itor * itor,
const void * key )

Position |itor| on the least key greater than or equal to |key| and return true, or unposition it and return false if there is none.

Definition at line 476 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_search_gt()

bool wb_itor_search_gt ( wb_itor * itor,
const void * key )

Position |itor| on the least key greater than |key| and return true, or unposition it and return false if there is none.

Definition at line 477 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_search_le()

bool wb_itor_search_le ( wb_itor * itor,
const void * key )

Position |itor| on the greatest key less than or equal to |key| and return true, or unposition it and return false if there is none.

Definition at line 474 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_search_lt()

bool wb_itor_search_lt ( wb_itor * itor,
const void * key )

Position |itor| on the greatest key less than |key| and return true, or unposition it and return false if there is none.

Definition at line 475 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_itor_valid()

bool wb_itor_valid ( const wb_itor * itor)

Return whether |itor| is positioned on an element.

Definition at line 465 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_clear()

size_t wb_tree_clear ( wb_tree * tree,
dict_delete_func delete_func )

Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL.

Returns the number of elements removed. The tree stays usable. See Iterator invalidation for which iterators this invalidates.

Definition at line 337 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_count()

size_t wb_tree_count ( const wb_tree * tree)

Return the number of elements.

Takes O(1) time.

Definition at line 369 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_free()

size_t wb_tree_free ( wb_tree * tree,
dict_delete_func delete_func )

Remove every element, calling |delete_func|(key, datum) for each unless |delete_func| is NULL, and free the tree.

Returns the number of elements removed. Iterators over the tree may afterwards only be freed.

Definition at line 336 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_insert()

dict_insert_result wb_tree_insert ( wb_tree * tree,
void * key )

Insert |key| unless an equal key is present.

Returns {&datum, true} for a new key, whose datum starts as NULL; the tree stores the |key| pointer itself, it does not copy the key. If an equal key is present, returns {&datum, false} with that key's datum, and |key| is not stored and still belongs to the caller. Returns {NULL, false} if memory cannot be allocated.

Definition at line 248 of file wb_tree.c.

◆ wb_tree_max_path_length()

size_t wb_tree_max_path_length ( const wb_tree * tree)

Return the greatest depth of any node, the root being at depth 1, or 0 for an empty tree: the height of the tree.

A statistic for testing and benchmarking.

Definition at line 371 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_min_path_length()

size_t wb_tree_min_path_length ( const wb_tree * tree)

Return the shallowest depth at which a child link is absent, the root being at depth 1, or 0 for an empty tree.

A statistic for testing and benchmarking.

Definition at line 370 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_new()

wb_tree * wb_tree_new ( dict_compare_func cmp_func)

Create an empty tree that orders keys with |cmp_func| (must not be NULL).

Returns NULL if memory cannot be allocated.

Definition at line 137 of file wb_tree.c.

◆ wb_tree_remove()

dict_remove_result wb_tree_remove ( wb_tree * tree,
const void * key )

Remove the element with key |key|.

Returns {key, datum, true}, handing the stored key and datum back to the caller (no delete function is called), or {NULL, NULL, false} if |key| is not present. See Iterator invalidation for which iterators this invalidates.

Definition at line 326 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_search()

void ** wb_tree_search ( wb_tree * tree,
const void * key )

Return the address of the datum stored for |key|, or NULL if |key| is not present.

Definition at line 165 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_search_ge()

void ** wb_tree_search_ge ( wb_tree * tree,
const void * key )

Return the address of the datum of the least key greater than or equal to |key|, or NULL if there is none.

Definition at line 168 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_search_gt()

void ** wb_tree_search_gt ( wb_tree * tree,
const void * key )

Return the address of the datum of the least key greater than |key|, or NULL if there is none.

Definition at line 169 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_search_le()

void ** wb_tree_search_le ( wb_tree * tree,
const void * key )

Return the address of the datum of the greatest key less than or equal to |key|, or NULL if there is none.

Definition at line 166 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_search_lt()

void ** wb_tree_search_lt ( wb_tree * tree,
const void * key )

Return the address of the datum of the greatest key less than |key|, or NULL if there is none.

Definition at line 167 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_select()

bool wb_tree_select ( wb_tree * tree,
size_t n,
const void ** key,
void ** datum )

Store the key and datum of the |n|th element in key order (0-based) through |key| and |datum| and return true, or store NULL through them and return false if |n| is out of range.

Either may be NULL. Takes O(log n) time.

Definition at line 341 of file wb_tree.c.

◆ wb_tree_total_path_length()

size_t wb_tree_total_path_length ( const wb_tree * tree)

Return the sum of the depths of all nodes, the root being at depth 1, or 0 for an empty tree.

A statistic for testing and benchmarking.

Definition at line 372 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_traverse()

size_t wb_tree_traverse ( wb_tree * tree,
dict_visit_func visit,
void * user_data )

Call |visit|(key, datum, |user_data|) for each element in key order, stopping early if |visit| returns false.

Returns the number of calls made.

Definition at line 338 of file wb_tree.c.

Here is the call graph for this function:

◆ wb_tree_verify()

bool wb_tree_verify ( const wb_tree * tree)

Check the internal invariants of the tree and return true if they hold, or print the first failed check to stderr and return false.

Meant for testing and debugging; takes O(n) time.

Definition at line 425 of file wb_tree.c.