andreasarne/treeviz

Repo for visualizing tree datasctructures in Python. Is using iGraph and Graphviz to create pictures.

treeviz's Issues

Better Error message when can't find graphviz

Add proper error message when cant find dot graphviz for image creation.

Support for dubble linked list

Add a previous edge if previous attribute exist.

Support for circular lists?

Current implementation of linked list builder will result in a forever loop if the structure is a circular list.

How to avoid a for ever loop from end to start? Can it be done or should we actively not support circular lists.

Support for visualizing recursive function calls

Is it possible to visualize recursive function calls using graphviz in a good way?

Could maybe create a decorator function which the students can add to their recursive function. Each time their function is called, create a .dot node.
In outer decorator function we can setup a new builder object for recursion. And everytime inner is called, add node to builder. Can inner be a instance method? Since it the the sudents function becomes the returned method, will it work correctly with the instance?

Producing gifs are slow

Add progression bar when creating gifs?
https://github.com/tqdm/tqdm

Handle render recursion when the function wasn't called

@recursion_viz
def a_func():
    a_func()
recursion_to_png("a_func")
# index out of range error

If the decorated function isn't called before trying to render it. We get an IndexError.

Check that function was called and if not give indication about it.

Create GIF of how the strucutre is built

It would be cool if we could create a .gif of how the structure is built.

For each "event"/node added, create a picture and then turn all of the pictures into a .gif.

Better error for "Graph already contain vertex X".

Now it just say key already exist. Would be helpful if direction to and from was printed or adding it to graph but with unique name to show how it looks.

ID for vertexes can't handle two vertexes with same key, shows them as one instead of two different vertexes.

For BBT, if two vertexes has the same key but are two different vertexes they are shown as one vertex instead of 2 in image.
A students tree looked correct, however is_bst() returned false. After a remove the student forgot to update parent referens to new node. But the old and the new parent both had the same key so treevizer showed a correct tree instead of showing two vertexes with the same key.

Use repr on Nodes for values in the label

Use the repr function to get the values used in the label.

Document that repr is used for deciding what to show.

Know errors and warnings

Warning: node '', graph '%3' size too small for label

The size of the nodes in graph is to small for content. Increase width of node in configuration.

Replace os.system call with subprocess.call

os.system() is deprecated and should be replaced with subprcess.run().
https://docs.python.org/3/library/subprocess.html?#replacing-older-functions-with-the-subprocess-module

https://github.com/AndreasArne/treeviz/blob/master/treevizer/exporters/png.py#L21

Rename balanced binary tree to binary tree

There is nothing in the code that makes BBT fulfill the balance part. It just as well can handle a Binary tree. Rename it to make that clear.