https://github.com/yusinv/priority-search-tree

priority search tree data structure
https://github.com/yusinv/priority-search-tree

binary-search-tree data-structures priority-queue priority-search-tree python python3 sorted

Last synced: 7 months ago
JSON representation

priority search tree data structure

• Host: GitHub
• URL: https://github.com/yusinv/priority-search-tree
• Owner: yusinv
• License: other
• Created: 2024-03-04T09:19:52.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T17:01:53.000Z (over 1 year ago)
• Last Synced: 2025-05-13T19:34:21.579Z (7 months ago)
• Topics: binary-search-tree, data-structures, priority-queue, priority-search-tree, python, python3, sorted
• Language: Python
• Homepage:
• Size: 113 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - docs

      - |docs|

    * - tests

      - |github-actions| |codecov|

    * - package

      - |version| |wheel| |supported-versions| |supported-implementations| |commits-since|

.. |docs| image:: https://readthedocs.org/projects/priority-search-tree/badge/?style=flat

    :target: https://readthedocs.org/projects/priority-search-tree/

    :alt: Documentation Status

.. |github-actions| image:: https://github.com/yusinv/priority-search-tree/actions/workflows/build.yml/badge.svg

    :alt: GitHub Actions Build Status

    :target: https://github.com/yusinv/priority-search-tree/actions

.. |codecov| image:: https://codecov.io/gh/yusinv/priority-search-tree/branch/main/graphs/badge.svg?branch=main

    :alt: Coverage Status

    :target: https://app.codecov.io/github/yusinv/priority-search-tree

.. |version| image:: https://img.shields.io/pypi/v/priority-search-tree.svg

    :alt: PyPI Package latest release

    :target: https://pypi.org/project/priority-search-tree

.. |wheel| image:: https://img.shields.io/pypi/wheel/priority-search-tree.svg

    :alt: PyPI Wheel

    :target: https://pypi.org/project/priority-search-tree

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/priority-search-tree.svg

    :alt: Supported versions

    :target: https://pypi.org/project/priority-search-tree

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/priority-search-tree.svg

    :alt: Supported implementations

    :target: https://pypi.org/project/priority-search-tree

.. |commits-since| image:: https://img.shields.io/github/commits-since/yusinv/priority-search-tree/v0.1.0.svg

    :alt: Commits since latest release

    :target: https://github.com/yusinv/priority-search-tree/compare/v0.1.0...main

.. end-badges

The priority search tree (PST) is data structure (mutable mapping {**key**: **priority**}) with the following properties:

* Keys are stored in binary search tree (red-black tree in this case).

* Maintains max heap properties (can return **key** with max **priority** in constant time).

* Ability to perform efficient 3-sided search (finds items with **key** in interval `[min_tree_key,max_tree_key]` and **priority** is grater or equal to `bottom_priority`).

For example PST can store 2 dimensional points `P(X,Y)` using X coordinate as **key** and Y coordinate as **priority**.  Such PST can perform 3 sided search to find points with `X in [X_MIN,X_MAX]` and `Y >= Y_BOTTOM`.

Installation

============

::

    pip install priority-search-tree

You can also install the in-development version with::

    pip install https://github.com/yusinv/priority-search-tree/archive/develop.zip

Documentation

=============

https://priority-search-tree.readthedocs.io/

Development

===========

To run all the tests run::

    tox

Licence

=======

Free software: GNU Lesser General Public License v3 or later (LGPLv3+)