https://github.com/phschaad/avl_tree

A basic implementation of an AVL-Tree in C.
https://github.com/phschaad/avl_tree

avl avl-tree avl-visualizer avltree c cpp

Last synced: 6 months ago
JSON representation

A basic implementation of an AVL-Tree in C.

• Host: GitHub
• URL: https://github.com/phschaad/avl_tree
• Owner: phschaad
• License: gpl-2.0
• Created: 2015-10-23T12:16:29.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-01T10:03:01.000Z (over 8 years ago)
• Last Synced: 2025-04-03T20:38:58.869Z (6 months ago)
• Topics: avl, avl-tree, avl-visualizer, avltree, c, cpp
• Language: C
• Size: 85 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# README #

This is a very basic implementation of an AVL-Tree in C, by Philipp Schaad. The implementation is done in a modular style, allowing quick and easy integration of the AVL-Tree in to any type of program.

### In Short: ###

* This is a very basic implementation of an AVL-Tree in C. Modular design allows quick and easy integration in any C/C++ project.

* Current Version: 1.0.0

### How do I get set up? ###

* If you want to use the AVL-Tree Module, you need to copy the avl_core.c and avl_core.h files in to your project folder, and include avl_core.h.

* The core-module itself does not contain a main method. If you need one, you will have to supply one yourself. Alternatively you can copy the test-avl.c file in to you project, which contains a main method. The method simply tests the AVL-Tree.

* In addition to the core module there is a visualizion module (avl_visualizer.c / avl_visualizer.h). The integration in to the project follows the same rules as the core module.

* Dependencies: 

    - avl_core:

        * Non-Standard: avl_core.h (supplied)

        * Standard: stdio.h, stdlib.h (and pre-deployment: assert.h)

    - avl_visualizer:

        * Non-Standard: avl_core.h (supplied), avl_visualizer.h (supplied)

        * Standard: stdio.h, stdlib.h, math.h (and pre-deployment: assert.h)

    - test-avl.c:

        * Non-Standard: avl_core.h (supplied), avl_visualizer.h (supplied)

        * Standard: stdio.h, stdlib.h, time.h, math.h (and pre-deployment: assert.h)

* To run tests just disable your standard main method (if you have one), and include the test-avl.c to your compilation. You may modify the main method however you like, to test the AVL-Tree to your liking.

### Features ###

* Core Module:

    - Create an empty tree.

    - Create a tree from a pre-existing node.

    - Create empty nodes.

    - Search by order-key.

    - Insertion (creating an empty node) by order-key. (Keeps the tree balanced)

    - Deletion by order-key. (Keeps the tree balanced)

* Visualizer Module:

    - Inorder-, Preorder- and Postorder-Traversals of the tree to the console.

    - Graphical representation of the tree in the console.

### Contribution guidelines ###

* Writing tests:

    - If you decide to write a more thurough test, you are welcome to do so.

* Code review:

    - Please report any bugs you may find!

    - Any feedback is welcome!

* Other guidelines:

    - Please *stick to the used coding style and documentation style*

    - Please *use comprehensive naming*

    - And **PLEASE** document **WELL**

### Contact ###

* Project Admin and Author: [Philipp Schaad](mailto:philipp@schaadfamily.com)