Metadata-Version: 2.4
Name: pythonic-fp-circulararray
Version: 6.2.0
Summary: Circular array datastructures.
Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
Requires-Python: >=3.14
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Typing :: Typed
License-File: LICENSE
Requires-Dist: pythonic-fp-gadgets>=4.0.2
Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.md
Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-circulararray/release/html/
Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray

# Pythonic FP - Circular Array

Stateful circular array data structures.

PyPI project
[pythonic-fp-circulararray](https://pypi.org/project/pythonic-fp-circulararray).
Part of the
[pythonic-fp](https://grscheller.github.io/pythonic-fp/)
PyPI projects.

## Description

- variable storage capacity circular array
  - O(1) pops either end 
  - O(1) amortized pushes either end 
  - O(1) indexing, fully supports slicing
  - auto-resizing more storage capacity when necessary, manually compatible
  - iterable, safely mutates while iterators iterating over previous state
  - comparisons compare identity before equality, like builtins
  - in boolean context, falsy when empty, otherwise truthy
  - function ``ca`` produces auto-resizing circular array from arguments
- fixed storage capacity circular array
  - O(1) pops and pushes either end 
  - O(1) indexing, does not support slicing
  - fixed total storage capacity
  - iterable, safely mutates while iterators iterating over previous state
  - comparisons compare identity before equality, like builtins
  - in boolean context, falsy when either empty or full, otherwise truthy
  - function ``caf`` produces fixed capacity circular array from arguments

## Copyright and License

Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
License, Version 2.0. See the LICENSE file for details.

