# TreeEditDistance [![docs.badge]][docs.home] [![codecov.badge]][codecov.home]

This crate provides an algorithm to compute the lowest cost sequence of edits between two trees.
It is based on a recursive generalized version of the [Levenshtein distance][levenshtein] for
arbitrary sequences, where inserting/deleting nodes may have an arbitrary user-defined cost.

## Using TreeEditDistance

TreeEditDistance is available on [crates.io], simply add it as a dependency in your `Cargo.toml`:

```
[dependencies]
tree-edit-distance = "0.4"
```

The full API documentation is available on [docs.rs][docs.home]

## Contribution

TreeEditDistance is an open source project and you're very welcome to contribute to this project by
opening [issues] and/or [pull requests][pulls], see [CONTRIBUTING] for general
guidelines.

## License

TreeEditDistance is distributed under the terms of the MIT license, see [LICENSE] for details.

[crates.io]:        https://crates.io/crates/tree-edit-distance

[docs.home]:        https://docs.rs/tree-edit-distance
[docs.badge]:       https://docs.rs/tree-edit-distance/badge.svg

[codecov.home]:     https://codecov.io/gh/brunocodutra/tree-edit-distance
[codecov.badge]:    https://codecov.io/gh/brunocodutra/tree-edit-distance/branch/master/graph/badge.svg

[issues]:           https://github.com/brunocodutra/tree-edit-distance/issues
[pulls]:            https://github.com/brunocodutra/tree-edit-distance/pulls

[LICENSE]:          https://github.com/brunocodutra/tree-edit-distance/blob/master/LICENSE
[CONTRIBUTING]:     https://github.com/brunocodutra/tree-edit-distance/blob/master/CONTRIBUTING.md

[levenshtein]:      https://en.wikipedia.org/wiki/Levenshtein_distance