wiki.burkey.co

User Tools

Site Tools

Trace:
libflint:binarytree

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
libflint:binarytree [2025/01/07 03:21] – eburklibflint:binarytree [2025/01/07 03:22] (current) – eburk
Line 1: Line 1:
-====== binarytree =======+====== binarytree ======
  
-Binary tree module with standard leaf operations+Binary tree with standard leaf operations
  
-==== Usage ====+===== Usage =====
  
-Create the tree. The user is responsible for memory management of the `BinTree` struct.+Create the tree. The user is responsible for memory management of the ''%%BinTree%%'' struct.
  
 <code c> <code c>
Line 11: Line 11:
 </code> </code>
  
-After the tree is created, init it. The second argument on ''bintree_init()'' is an optional memory freeing function pointer with signature ''void (*destroy)(void *data)''. Use ''free()'' from the stdlib if you are creating the data with `malloc()`. If allocation of your data is more complex, you can pass your own memory deallocation function as long as it fits the signature.+After the tree is created, init it. The second argument on ''%%bintree_init()%%'' is an optional memory freeing function pointer with signature ''%%void (*destroy)(void *data)%%''. Use ''%%free()%%'' from the stdlib if you are creating the data with ''%%malloc()%%''. If allocation of your data is more complex, you can pass your own memory deallocation function as long as it fits the signature.
  
-In this example, we are passing ''NULL'' because all memory will be stack allocated.+In this example, we are passing ''%%NULL%%'' because all memory will be stack allocated.
  
 <code c> <code c>
Line 24: Line 24:
 </code> </code>
  
-Next lets insert our data into the tree. The insert functions signature is ''bintree_ins_...(tree, parent, data)''. If you are inserting data at the root of the tree, you may use either ''bintree_ins_left()'' or ''bintree_ins_right()'' as long as ''NULL'' is passed as the parent argument.+Next lets insert our data into the tree. The insert functions signature is ''%%bintree_ins_...(tree, parent, data)%%''. If you are inserting data at the root of the tree, you may use either ''%%bintree_ins_left()%%'' or ''%%bintree_ins_right()%%'' as long as ''%%NULL%%'' is passed as the parent argument.
  
 <code c> <code c>
Line 36: Line 36:
 </code> </code>
  
-We can use ''bintree_debug_print(tree)'' to print a graphical representation of the tree to ''stdout'' +We can use ''%%bintree_debug_print(tree)%%'' to print a graphical representation of the tree to ''%%stdout%%'' 
-<code>+ 
 +<code plaintext>
 └──0 └──0
     ├──1     ├──1
Line 47: Line 48:
 </code> </code>
  
-To cleanup the tree, first destroy the nodes. If you passed a deallocation function, it will be called on +To cleanup the tree, first destroy the nodes. If you passed a deallocation function, it will be called on the data member of each node before the node itself is freed. ''%%bintree_destroy()%%'' does not free the tree itself, just the nodes inside of it, hence we must also call ''%%free()%%'' on the tree.
-the data member of each node before the node itself is freed. ''bintree_destroy()'' does not free the tree itself, just the +
-nodes inside of it, hence we must also call `free()` on the tree.+
  
 <code c> <code c>
Line 84: Line 83:
 </code> </code>
  
-==== Structs ====+===== Structs =====
  
-=== BinTree ===+==== BinTree ====
  
 Binary tree struct Binary tree struct
Line 101: Line 100:
 Members: Members:
  
-  * ''size'': How many nodes the tree contains +  * ''%%size%%'': How many nodes the tree contains 
-  * ''compare'': Comparison function between data in two nodes. Currently not used for anything +  * ''%%compare%%'': Comparison function between data in two nodes. Currently not used for anything 
-  * ''destroy'': Optional deallocation function for data inside a node. Typical usage is ''NULL'' for stack allocated data and ''free()'' for data created with ''malloc()'' +  * ''%%destroy%%'': Optional deallocation function for data inside a node. Typical usage is ''%%NULL%%'' for stack allocated data and ''%%free()%%'' for data created with ''%%malloc()%%'' 
-  * ''root'': The root node of the tree+  * ''%%root%%'': The root node of the tree
  
-=== BinTreeNode ===+==== BinTreeNode ====
  
 Node of the tree Node of the tree
Line 118: Line 117:
 </code> </code>
  
-Members: +Members: - ''%%data%%'': void pointer to data the node contains - ''%%left%%'': left facing leaf of the node - ''%%right%%'': right facing leaf of the node
-  * ''data'': void pointer to data the node contains +
-  * ''left'': left facing leaf of the node +
-  * ''right'': right facing leaf of the node+
  
-==== Functions ====+===== Functions =====
  
-=== bintree_init ===+==== bintree_init ====
  
-Initialize the binary tree. User is responsible for freeing memory with `bintree_destroy()`.+Initialize the binary tree. User is responsible for freeing memory with ''%%bintree_destroy()%%''.
  
 <code c> <code c>
Line 133: Line 129:
 </code> </code>
  
-=== bintree_destroy ===+==== bintree_destroy ====
  
-Destroys the nodes inside a tree and calls the deallaction function on the data if one was provided. Does not deallocate +Destroys the nodes inside a tree and calls the deallaction function on the data if one was provided. Does not deallocate the tree itself, that is left to the user.
-the tree itself, that is left to the user.+
  
 <code c> <code c>
Line 142: Line 137:
 </code> </code>
  
-=== bintree_ins_left ===+==== bintree_ins_left ====
  
-Creates a new node containing `data` and inserts it as the left child of `node`.+Creates a new node containing ''%%data%%'' and inserts it as the left child of ''%%node%%''.
  
 <code c> <code c>
Line 150: Line 145:
 </code> </code>
  
-=== bintree_ins_right ===+==== bintree_ins_right ====
  
-Creates a new node containing `data` and inserts it as the right child of `node`.+Creates a new node containing ''%%data%%'' and inserts it as the right child of ''%%node%%''.
  
 <code c> <code c>
Line 158: Line 153:
 </code> </code>
  
-=== bintree_rem_left ===+==== bintree_rem_left ====
  
-Removes and deallocates the left child node of `node`. Calls the deallocation function on the data if one was provided.+Removes and deallocates the left child node of ''%%node%%''. Calls the deallocation function on the data if one was provided.
  
 <code c> <code c>
Line 166: Line 161:
 </code> </code>
  
-=== bintree_rem_right ===+==== bintree_rem_right ====
  
-Removes and deallocates the right child node of `node`. Calls the deallocation function on the data if one was provided.+Removes and deallocates the right child node of ''%%node%%''. Calls the deallocation function on the data if one was provided.
  
 <code c> <code c>
Line 174: Line 169:
 </code> </code>
  
-=== bintree_debug_print ===+==== bintree_debug_print ====
  
 Prints a representation of the tree to stdout. Gets very messy with large trees. Prints a representation of the tree to stdout. Gets very messy with large trees.
Line 182: Line 177:
 </code> </code>
  
-==== Macros ==== +==== bintree_is_eob ====
- +
-=== bintree_is_eob ===+
  
 Utility macro that checks if the node is the End Of Branch. Utility macro that checks if the node is the End Of Branch.
Line 192: Line 185:
 </code> </code>
  
-=== bintree_is_leaf ===+==== bintree_is_leaf ====
  
 Utility macro that checks if a node has children. Utility macro that checks if a node has children.
libflint/binarytree.txt · Last modified: 2025/01/07 03:22 by eburk

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution 4.0 International
CC Attribution 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki