# rose_tree [![Actions Status](https://github.com/mitchmindtree/rose_tree/workflows/rose_tree/badge.svg)](https://github.com/mitchmindtree/rose_tree/actions) [![Crates.io](https://img.shields.io/crates/v/rose_tree.svg)](https://crates.io/crates/rose_tree) [![Crates.io](https://img.shields.io/crates/l/rose_tree.svg)](https://github.com/mitchmindtree/rose_tree-rs/blob/master/LICENSE-MIT) [![docs.rs](https://docs.rs/rose_tree/badge.svg)](https://docs.rs/rose_tree/)

An implementation of the [**rose tree** (aka **multi-way tree**) data structure](https://en.wikipedia.org/wiki/Rose_tree) for Rust.

An indexable tree data structure with a variable and unbounded number of branches per node.

It is Implemented on top of [petgraph](https://github.com/bluss/petulant-avenger-graphlibrary)'s [Graph](http://bluss.github.io/petulant-avenger-graphlibrary/doc/petgraph/graph/struct.Graph.html) data structure and attempts to follow similar conventions where suitable.


Usage
-----

Please see the [tests directory](https://github.com/mitchmindtree/rose_tree-rs/tree/master/tests) for some basic usage examples.

License
-------

Dual-licensed to be compatible with the petgraph and Rust projects.

Licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0 or the MIT license http://opensource.org/licenses/MIT, at your option. This file may not be copied, modified, or distributed except according to those terms.


[Beautiful ascii source](http://www.chris.com/ascii/joan/www.geocities.com/SoHo/7373/flowers.html).