[tie-hash-sorted-xs.git] / README

Tie-Hash-Sorted-XS version 0.000_001
====================================

This module is not yet fully implemented. Current limitations include
the CLEAR function not being implemented (meaning it is impossible to
assign a list to a tied hash) and iteration being slow (O(n log n) to
iterate over the whole hash). The latter is due to lack of suitable
methods in the underlying Tree::SizeBalanced.

Tree::SizeBalanced is an implementation of a size-balanced tree, a
kind of self-balanced binary search tree. This is a data structure
similar to a Perl hash that permits O(log n) insertion, deletion, and
random access while keeping the keys sorted.

This module is a tie interface to Tree::SizeBalanced. It allows one to
create a hash that is implemented by a Tree::SizeBalanced.
These hashes should work similarly to regular Perl hashes except that
keys will be ordered, keys can be any objects (not just strings), and
they have different performance characteristics.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

This module requires these other modules and libraries:

* Tie::Hash::Sorted::XS

COPYRIGHT AND LICENCE

Copyright (C) 2018 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.24.3 or,
at your option, any later version of Perl 5 you may have available.
Commit	Line	Data
f0a05402 MG	1	Tie-Hash-Sorted-XS version 0.000_001
	2	====================================
	3
	4	This module is not yet fully implemented. Current limitations include
	5	the CLEAR function not being implemented (meaning it is impossible to
	6	assign a list to a tied hash) and iteration being slow (O(n log n) to
	7	iterate over the whole hash). The latter is due to lack of suitable
	8	methods in the underlying Tree::SizeBalanced.
	9
	10	Tree::SizeBalanced is an implementation of a size-balanced tree, a
	11	kind of self-balanced binary search tree. This is a data structure
	12	similar to a Perl hash that permits O(log n) insertion, deletion, and
	13	random access while keeping the keys sorted.
	14
	15	This module is a tie interface to Tree::SizeBalanced. It allows one to
	16	create a hash that is implemented by a Tree::SizeBalanced.
	17	These hashes should work similarly to regular Perl hashes except that
	18	keys will be ordered, keys can be any objects (not just strings), and
	19	they have different performance characteristics.
	20
	21	INSTALLATION
	22
	23	To install this module type the following:
	24
	25	perl Makefile.PL
	26	make
	27	make test
	28	make install
	29
	30	DEPENDENCIES
	31
	32	This module requires these other modules and libraries:
	33
	34	* Tie::Hash::Sorted::XS
	35
	36	COPYRIGHT AND LICENCE
	37
	38	Copyright (C) 2018 by Marius Gavrilescu
	39
	40	This library is free software; you can redistribute it and/or modify
	41	it under the same terms as Perl itself, either Perl version 5.24.3 or,
	42	at your option, any later version of Perl 5 you may have available.
	43
	44