``collections_extended`` documentation
======================================

``collections_extended`` is a pure Python module with no dependencies providing
	- a ``bag`` class, AKA **multiset**,
	- a ``setlist`` class, which is a **unique list** or **ordered set**,
	- a ``bijection`` class,
	- a ``RangeMap`` which is a mapping from ranges to values, and
	- a ``IndexedDict`` class.

There are also frozen (hashable) varieties of bags and setlists.

It is `tested against`_ CPython 3.6, 3.7, 3.8, 3.9, 3.10, PyPy3.6, PyPy3.7, & PyPy3.8.
The current version no longer supports Python 2, install a
1.x version for a Python 2.7 compatible version. New features will
not be developed but serious bugs may be fixed.

Contents:

.. toctree::
	:maxdepth: 3

	getting_started
	setlists
	bags
	range_map
	bijection
	indexed_dict
	sentinel
	factory
	contributing
	changelog

Other Packages of Interest
==========================

- http://stutzbachenterprises.com/blist/ - b+ trees
- https://bitbucket.org/mozman/bintrees - Binary search trees
- https://bidict.readthedocs.org/en/master/ - bijections
- http://www.grantjenks.com/docs/sortedcollections/ - sortedcollections
- http://www.grantjenks.com/docs/sortedcontainers/ - sortedcontainers

:Author: Michael Lenzen
:Copyright: 2022 Michael Lenzen
:License: Apache License, Version 2.0

.. _`tested against`: https://travis-ci.org/mlenzen/collections-extended