sortedcollections

Python Sorted Collections

Sorted Collections_ is an Apache2 licensed Python sorted collections library.

Features

• Pure-Python
• Depends on the Sorted Containers <http://www.grantjenks.com/docs/sortedcontainers/>_ module.
• ValueSortedDict - Dictionary with (key, value) item pairs sorted by value.
• ItemSortedDict - Dictionary with key-function support for item pairs.
• NearestDict - Dictionary with nearest-key lookup.
• OrderedDict - Ordered dictionary with numeric indexing support.
• OrderedSet - Ordered set with numeric indexing support.
• IndexableDict - Dictionary with numeric indexing support.
• IndexableSet - Set with numeric indexing support.
• SegmentList - List with fast random access insertion and deletion.
• 100% code coverage testing.
• Developed on Python 3.9
• Tested on CPython 3.6, 3.7, 3.8, and 3.9

.. image:: https://github.com/grantjenks/python-sortedcollections/workflows/integration/badge.svg :target: https://github.com/grantjenks/python-sortedcollections/actions?query=workflow%3Aintegration

.. image:: https://github.com/grantjenks/python-sortedcollections/workflows/release/badge.svg :target: https://github.com/grantjenks/python-sortedcollections/actions?query=workflow%3Arelease

Quickstart

Installing Sorted Collections_ is simple with pip <http://www.pip-installer.org/>_::

$ pip install sortedcollections

You can access documentation in the interpreter with Python's built-in help function:

.. code-block:: python

>>> from sortedcollections import ValueSortedDict
>>> help(ValueSortedDict)  # doctest: +SKIP

.. _Sorted Collections: http://www.grantjenks.com/docs/sortedcollections/

Recipes

• Value Sorted Dictionary Recipe_
• Item Sorted Dictionary Recipe_
• Nearest Dictionary Recipe_
• Ordered Dictionary Recipe_
• Ordered Set Recipe_
• Indexable Dictionary Recipe_
• Indexable Set Recipe_
• Segment List Recipe_

.. _Value Sorted Dictionary Recipe: http://www.grantjenks.com/docs/sortedcollections/valuesorteddict.html .. _Item Sorted Dictionary Recipe: http://www.grantjenks.com/docs/sortedcollections/itemsorteddict.html .. _Nearest Dictionary Recipe: http://www.grantjenks.com/docs/sortedcollections/nearestdict.html .. _Ordered Dictionary Recipe: http://www.grantjenks.com/docs/sortedcollections/ordereddict.html .. _Ordered Set Recipe: http://www.grantjenks.com/docs/sortedcollections/orderedset.html .. _Indexable Dictionary Recipe: http://www.grantjenks.com/docs/sortedcollections/indexabledict.html .. _Indexable Set Recipe: http://www.grantjenks.com/docs/sortedcollections/indexableset.html .. _Segment List Recipe: http://www.grantjenks.com/docs/sortedcollections/segmentlist.html

Reference and Indices

• Sorted Collections Documentation_
• Sorted Collections at PyPI_
• Sorted Collections at Github_
• Sorted Collections Issue Tracker_

.. _Sorted Collections Documentation: http://www.grantjenks.com/docs/sortedcollections/ .. _Sorted Collections at PyPI: https://pypi.python.org/pypi/sortedcollections/ .. _Sorted Collections at Github: https://github.com/grantjenks/python-sortedcollections .. _Sorted Collections Issue Tracker: https://github.com/grantjenks/python-sortedcollections/issues

Sorted Collections License

Copyright 2015-2021 Grant Jenks

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.