manwar / avltree Goto Github PK

AVLTree - Efficient AVL Balanced Binary Trees in Perl

Perl extension for efficient creation and manipulation of AVL balanced binary trees.

AVLTree provides a simple and fast implementation of AVL balanced trees.
It uses the Perl XS extension mechanism by providing a tiny wrapper around
an efficient C library which does the core of the work. Preliminary benchmarking
shows this module is one order of magnitude faster than a pure perl implementation.

The nodes of an AVL tree object can hold any kind of item, as long as each 
one of these has an element which can be used to define a partial order on 
the set of possible items. This is specified by providing, upon tree construction,
a reference to a function for comparing any two of the possible items.

The underlying C library is a reinterpretation of the C library originally 
developed by Julienne Walker. This library has been adapted for dealing 
directly with Perl (SV) variables.

The module at the moment is in beta stage but it is usable. It provides methods
for creating and querying an AVL tree, get its size and insert and remove elements
from it. No methods exist to traverse the tree at this stage, but I promise this
functionality is going to be implemented very soon.

INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make
	make test
	make install

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for this module with the
perldoc command.

    perldoc AVLTree

You can also look for information at:

    RT, CPAN's request tracker (report bugs here)
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=AVLTree

    AnnoCPAN, Annotated CPAN documentation
        http://annocpan.org/dist/AVLTree

    CPAN Ratings
        http://cpanratings.perl.org/d/AVLTree

    Search CPAN
        http://search.cpan.org/dist/AVLTree/

AUTHOR

Alessandro Vullo <[email protected]>

CONTRIBUTING

You can obtain the most recent development version of this module via the GitHub
repository at https://github.com/avullo/AVLTree. Please feel free to submit bug
reports, patches etc.

LICENSE AND COPYRIGHT

Copyright (C) 2017 Alessandro Vullo

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.