Metadata-Version: 2.1
Name: grscheller.circular-array
Version: 0.1.1
Summary: Module grscheller.circular_array - circlar array datastructure
Keywords: circular-array,circular_array,circular array
Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Requires-Dist: pytest >=7.4 ; extra == "test"
Project-URL: Changelog, https://github.com/grscheller/circular-array/blob/main/CHANGELOG.md
Project-URL: Documentation, https://grscheller.github.io/circular-array/
Project-URL: Source, https://github.com/grscheller/circular-array
Provides-Extra: test

# PyPI grscheller.circular-array Project

Python package containing the CircularArray data structure.

## Overview

The CircularArray class implements an auto-resizing, indexable, double
sided queue data structure. O(1) indexing and O(1) pushes and pops
either end. Useful as an improved version of a Python list. Used in
a has-a relationship by grscheller.datastructure when implementing other
data structures where its functionality is more likely restricted than
augmented.

For detailed API documentation click [here][1].

## Usage

from grscheller.circular_array.circulararray import CircularArray

---

[1]: https://grscheller.github.io/circular-array/API/development/html/grscheller/circular_array/index.html

