dtools.circular-array 3.9.0__py3-none-any.whl

dtools/circular_array/__init__.py

@@ -0,0 +1,27 @@
+# Copyright 2016-2025 Geoffrey R. Scheller
+#
+# 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.
+
+"""### Circular Array
+
+Package for an indexable circular array data structure.
+
+#### Modules
+
+* module dtools.circular_array.ca: circular array Python data structure
+
+"""
+__version__ = "3.9.0"
+__author__ = "Geoffrey R. Scheller"
+__copyright__ = "Copyright (c) 2023-2025 Geoffrey R. Scheller"
+__license__ = "Apache License 2.0"

dtools/circular_array/ca.py

@@ -0,0 +1,429 @@
+# Copyright 2023-2025 Geoffrey R. Scheller
+#
+# 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.
+
+"""### Indexable circular array data structure module."""
+from __future__ import annotations
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import Any, cast, Never, overload
+
+__all__ = [ 'ca', 'CA' ]
+
+class ca[D](Sequence[D]):
+    """
+    #### Indexable circular array data structure
+
+    * generic, stateful data structure
+    * amortized O(1) pushing and popping from either end
+    * O(1) random access any element
+    * will resize itself as needed
+    * sliceable
+    * makes defensive copies of contents for the purposes of iteration
+    * in boolean context returns true if not empty, false if empty
+    * in comparisons compare identity before equality (like Python built-ins do)
+    * lowercase class name choosen to match built-ins like `list` and `tuple`
+    * raises `IndexError` for out-of-bounds indexing
+    * raises `ValueError` for popping from or folding an empty `ca`
+    * raises `TypeError` if more than 2 arguments are passed to constructor
+
+    """
+    __slots__ = '_data', '_cnt', '_cap', '_front', '_rear'
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if len(dss) < 2:
+            self._data: list[D|None] = [None] + cast(list[D|None], list(*dss)) + [None]
+        else:
+            msg = f'ca expected at most 1 argument, got {len(dss)}'
+            raise TypeError(msg)
+        self._cap = cap = len(self._data)
+        self._cnt = cap - 2
+        if cap == 2:
+            self._front = 0
+            self._rear = 1
+        else:
+            self._front = 1
+            self._rear = cap - 2
+
+    def _double_storage_capacity(self) -> None:
+        if self._front <= self._rear:
+            self._data += [None]*self._cap
+            self._cap *= 2
+        else:
+            self._data = self._data[:self._front] + [None]*self._cap + self._data[self._front:]
+            self._front, self._cap = self._front + self._cap, 2*self._cap
+
+    def _compact_storage_capacity(self) -> None:
+        """Compact the ca."""
+        match self._cnt:
+            case 0:
+                self._cap, self._front, self._rear, self._data = \
+                    2, 0, 1, [None, None]
+            case 1:
+                self._cap, self._front, self._rear, self._data = \
+                    3, 1, 1, [None, self._data[self._front], None]
+            case _:
+                if self._front <= self._rear:
+                    self._cap, self._front, self._rear, self._data = \
+                        self._cnt+2, 1, self._cnt, [None] + self._data[self._front:self._rear+1] + [None]
+                else:
+                    self._cap, self._front, self._rear, self._data = \
+                        self._cnt+2, 1, self._cnt, [None] + self._data[self._front:] + self._data[:self._rear+1] + [None]
+
+    def __iter__(self) -> Iterator[D]:
+        if self._cnt > 0:
+            capacity, rear, position, current_state = \
+                self._cap, self._rear, self._front, self._data.copy()
+
+            while position != rear:
+                yield cast(D, current_state[position])
+                position = (position + 1) % capacity
+            yield cast(D, current_state[position])
+
+    def __reversed__(self) -> Iterator[D]:
+        if self._cnt > 0:
+            capacity, front, position, current_state = \
+                self._cap, self._front, self._rear, self._data.copy()
+
+            while position != front:
+                yield cast(D, current_state[position])
+                position = (position - 1) % capacity
+            yield cast(D, current_state[position])
+
+    def __repr__(self) -> str:
+        return 'CA(' + ', '.join(map(repr, self)) + ')'
+
+    def __str__(self) -> str:
+        return '(|' + ', '.join(map(str, self)) + '|)'
+
+    def __bool__(self) -> bool:
+        return self._cnt > 0
+
+    def __len__(self) -> int:
+        return self._cnt
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> ca[D]: ...
+
+    def __getitem__(self, idx: int|slice, /) -> D|ca[D]:
+        if isinstance(idx, slice):
+            return ca(list(self)[idx])
+
+        cnt = self._cnt
+        if 0 <= idx < cnt:
+            return cast(D, self._data[(self._front + idx) % self._cap])
+        elif -cnt <= idx < 0:
+            return cast(D, self._data[(self._front + cnt + idx) % self._cap])
+        else:
+            if cnt > 0:
+                foo = [1, 2, 3]
+                foo.__setitem__
+                msg1 = 'Out of bounds: '
+                msg2 = f'index = {idx} not between {-cnt} and {cnt-1} '
+                msg3 = 'while getting value from a ca.'
+                raise IndexError(msg1 + msg2 + msg3)
+            else:
+                msg0 = 'Trying to get a value from an empty ca.'
+                raise IndexError(msg0)
+
+    @overload
+    def __setitem__(self, idx: int, vals: D, /) -> None: ...
+    @overload
+    def __setitem__(self, idx: slice, vals: Iterable[D], /) -> None: ...
+
+    def __setitem__(self, idx: int|slice, vals: D|Iterable[D], /) -> None:
+        if isinstance(idx, slice):
+            if isinstance(vals, Iterable):
+                data = list(self)
+                data[idx] = vals
+                _ca = ca(data)
+                self._data, self._cnt, self._cap, self._front, self._rear = \
+                            _ca._data, _ca._cnt, _ca._cap, _ca._front, _ca._rear
+                return
+            else:
+                msg = 'must assign iterable to extended slice'
+                foo = [1,2,3]
+                foo.__delitem__(2)
+                raise TypeError(msg)
+
+        cnt = self._cnt
+        if 0 <= idx < cnt:
+            self._data[(self._front + idx) % self._cap] = cast(D, vals)
+        elif -cnt <= idx < 0:
+            self._data[(self._front + cnt + idx) % self._cap] = cast(D, vals)
+        else:
+            if cnt > 0:
+                msg1 = 'Out of bounds: '
+                msg2 = f'index = {idx} not between {-cnt} and {cnt-1} '
+                msg3 = 'while setting value from a ca.'
+                raise IndexError(msg1 + msg2 + msg3)
+            else:
+                msg0 = 'Trying to set a value from an empty ca.'
+                raise IndexError(msg0)
+
+    @overload
+    def __delitem__(self, idx: int) -> None: ...
+    @overload
+    def __delitem__(self, idx: slice) -> None: ...
+
+    def __delitem__(self, idx: int|slice) -> None:
+        data = list(self)
+        del data[idx]
+        _ca = ca(data)
+        self._data, self._cnt, self._cap, self._front, self._rear = \
+                    _ca._data, _ca._cnt, _ca._cap, _ca._front, _ca._rear
+        return
+
+    def __eq__(self, other: object, /) -> bool:
+        if self is other:
+            return True
+        if not isinstance(other, type(self)):
+            return False
+
+        frontL, frontR, \
+        countL, countR, \
+        capacityL, capacityR = \
+            self._front, other._front, \
+            self._cnt, other._cnt, \
+            self._cap, other._cap
+
+        if countL != countR:
+            return False
+
+        for nn in range(countL):
+            if self._data[(frontL+nn)%capacityL] is other._data[(frontR+nn)%capacityR]:
+                continue
+            if self._data[(frontL+nn)%capacityL] != other._data[(frontR+nn)%capacityR]:
+                return False
+        return True
+
+    def pushL(self, *ds: D) -> None:
+        """Push data from the left onto the ca."""
+        for d in ds:
+            if self._cnt == self._cap:
+                self._double_storage_capacity()
+            self._front = (self._front - 1) % self._cap
+            self._data[self._front], self._cnt = d, self._cnt + 1
+
+    def pushR(self, *ds: D) -> None:
+        """Push data from the right onto the ca."""
+        for d in ds:
+            if self._cnt == self._cap:
+                self._double_storage_capacity()
+            self._rear = (self._rear + 1) % self._cap
+            self._data[self._rear], self._cnt = d, self._cnt + 1
+
+    def popL(self) -> D|Never:
+        """Pop one value off the left side of the ca.
+
+        * raises `ValueError` when called on an empty ca
+        """
+        if self._cnt > 1:
+            d, self._data[self._front], self._front, self._cnt = \
+                self._data[self._front], None, (self._front+1) % self._cap, self._cnt - 1
+        elif self._cnt < 1:
+            msg = 'Method popL called on an empty ca'
+            raise ValueError(msg)
+        else:
+            d, self._data[self._front], self._cnt, self._front, self._rear = \
+                self._data[self._front], None, 0, 0, self._cap - 1
+        return cast(D, d)
+
+    def popR(self) -> D|Never:
+        """Pop one value off the right side of the ca.
+
+        * raises `ValueError` when called on an empty ca
+        """
+        if self._cnt > 0:
+            d, self._data[self._rear], self._rear, self._cnt = \
+                self._data[self._rear], None, (self._rear - 1) % self._cap, self._cnt - 1
+        elif self._cnt < 1:
+            msg = 'Method popR called on an empty ca'
+            raise ValueError(msg)
+        else:
+            d, self._data[self._front], self._cnt, self._front, self._rear = \
+                self._data[self._front], None, 0, 0, self._cap - 1
+        return cast(D, d)
+
+    def popLD(self, default: D, /) -> D:
+        """Pop one value from left, provide a mandatory default value.
+
+        * safe version of popL
+        * returns a default value in the event the `ca` is empty
+        """
+        try:
+            return self.popL()
+        except ValueError:
+            return default
+
+    def popRD(self, default: D, /) -> D:
+        """Pop one value from right, provide a mandatory default value.
+
+        * safe version of popR
+        * returns a default value in the event the `ca` is empty
+        """
+        try:
+            return self.popR()
+        except ValueError:
+            return default
+
+    def popLT(self, max: int) -> tuple[D, ...]:
+        """Pop multiple values from left side of ca.
+
+        * returns the results in a tuple of type `tuple[~D, ...]`
+        * returns an empty tuple if `ca` is empty
+        * pop no more that `max` values
+        * will pop less if `ca` becomes empty
+        """
+        ds: list[D] = []
+
+        while max > 0:
+            try:
+                ds.append(self.popL())
+            except ValueError:
+                break
+            else:
+                max -= 1
+
+        return tuple(ds)
+
+    def popRT(self, max: int) -> tuple[D, ...]:
+        """Pop multiple values from right side of `ca`.
+
+        * returns the results in a tuple of type `tuple[~D, ...]`
+        * returns an empty tuple if `ca` is empty
+        * pop no more that `max` values
+        * will pop less if `ca` becomes empty
+        """
+        ds: list[D] = []
+        while max > 0:
+            try:
+                ds.append(self.popR())
+            except ValueError:
+                break
+            else:
+                max -= 1
+
+        return tuple(ds)
+
+    def rotL(self, n: int=1) -> None:
+        """Rotate ca arguments left n times."""
+        if self._cnt < 2:
+            return
+        while n > 0:
+            self.pushR(self.popL())
+            n -= 1
+
+    def rotR(self, n: int=1) -> None:
+        """Rotate ca arguments right n times."""
+        if self._cnt < 2:
+            return
+        while n > 0:
+            self.pushL(self.popR())
+            n -= 1
+
+    def map[U](self, f: Callable[[D], U], /) -> ca[U]:
+        """Apply function f over contents, returns new `ca` instance.
+
+        * parameter `f` function of type `f[~D, ~U] -> ca[~U]`
+        * returns a new instance of type `ca[~U]`
+        """
+        return ca(map(f, self))
+
+    def foldL[L](self, f: Callable[[L, D], L], /, initial: L|None=None) -> L:
+        """Left fold ca via function and optional initial value.
+
+        * parameter `f` function of type `f[~L, ~D] -> ~L`
+          * the first argument to `f` is for the accumulated value.
+        * parameter `initial` is an optional initial value
+        * returns the reduced value of type `~L`
+          * note that `~L` and `~D` can be the same type
+          * if an initial value is not given then by necessity `~L = ~D`
+        * raises `ValueError` when called on an empty `ca` and `initial` not given
+        """
+        if self._cnt == 0:
+            if initial is None:
+                msg = 'Method foldL called on an empty ca without an initial value.'
+                raise ValueError(msg)
+            else:
+                return initial
+        else:
+            if initial is None:
+                acc = cast(L, self[0])  # in this case D = L
+                for idx in range(1, self._cnt):
+                    acc = f(acc, self[idx])
+                return acc
+            else:
+                acc = initial
+                for d in self:
+                    acc = f(acc, d)
+                return acc
+
+    def foldR[R](self, f: Callable[[D, R], R], /, initial: R|None=None) -> R:
+        """Right fold ca via function and optional initial value.
+
+        * parameter `f` function of type `f[~D, ~R] -> ~R`
+          * the second argument to f is for the accumulated value
+        * parameter `initial` is an optional initial value
+        * returns the reduced value of type `~R`
+          * note that `~R` and `~D` can be the same type
+          * if an initial value is not given then by necessity `~R = ~D`
+        * raises `ValueError` when called on an empty `ca` and `initial` not given
+        """
+        if self._cnt == 0:
+            if initial is None:
+                msg = 'Method foldR called on an empty ca without an initial value.'
+                raise ValueError(msg)
+            else:
+                return initial
+        else:
+            if initial is None:
+                acc = cast(R, self[-1])  # in this case D = R
+                for idx in range(self._cnt-2, -1, -1):
+                    acc = f(self[idx], acc)
+                return acc
+            else:
+                acc = initial
+                for d in reversed(self):
+                    acc = f(d, acc)
+                return acc
+
+    def capacity(self) -> int:
+        """Returns current capacity of the ca."""
+        return self._cap
+
+    def empty(self) -> None:
+        """Empty the ca, keep current capacity."""
+        self._data, self._front, self._rear = [None]*self._cap, 0, self._cap
+
+    def fractionFilled(self) -> float:
+        """Returns fractional capacity of the ca."""
+        return self._cnt/self._cap
+
+    def resize(self, minimum_capacity: int=2) -> None:
+        """Compact `ca` and resize to `min_cap` if necessary.
+
+        * to just compact the `ca`, do not provide a min_cap
+        """
+        self._compact_storage_capacity()
+        if (min_cap := minimum_capacity) > self._cap:
+            self._cap, self._data = \
+                min_cap, self._data + [None]*(min_cap - self._cap)
+            if self._cnt == 0:
+                self._front, self._rear = 0, self._cap - 1
+
+def CA[D](*ds: D) -> ca[D]:
+    """Function to produce a `ca` array from a variable number of arguments."""
+    return ca(ds)
+

dtools_circular_array-3.9.0.dist-info/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2023-2024 Geoffrey R. Scheller
+
+   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.

dtools_circular_array-3.9.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: dtools.circular-array
+Version: 3.9.0
+Summary: ### Circular Array
+Keywords: circular array,circle array,CA,double ended queue,dequeue,dqueue,pop,push,popL,popR,pushL,pushR,indexable,auto-resizing,auto resizing,resizing
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+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.13
+Classifier: Typing :: Typed
+Requires-Dist: pytest >=8.3.2 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/dtools-circular-array/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/dtools-docs/circular-array
+Project-URL: Source, https://github.com/grscheller/dtools-circular-array
+Provides-Extra: test
+
+# Python Circular Array Implementation
+
+Python module implementing an indexable, double sided,
+auto-resizing queue data structure.
+
+* **Repositories**
+  * [dtools.circular-array][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* **Detailed documentation**
+  * [Detailed API documentation][3] on *GH-Pages*
+
+### Overview
+
+Useful if used directly as an improved version of a Python List or in
+a "has-a" relationship when implementing other data structures.
+
+* O(1) pushes and pops either end.
+* O(1) indexing
+* now fully supports slicing!
+
+### Usage
+
+```python
+from dtools.circular_array.ca import CA
+
+ca = CA(1, 2, 3)
+assert ca.popL() == 1
+assert ca.popR() == 3
+ca.pushR(42, 0)
+ca.pushL(0, 1)
+assert repr(ca) == 'CA(1, 0, 2, 42, 0)'
+assert str(ca) == '(|1, 0, 2, 42, 0|)'
+
+ca = CA(*range(1,11))
+assert repr(ca) == 'CA(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)'
+assert str(ca) == '(|1, 2, 3, 4, 5, 6, 7, 8, 9, 10|)'
+assert len(ca) == 10
+tup3 = ca.popLT(3)
+tup4 = ca.popRT(4)
+assert tup3 == (1, 2, 3)
+assert tup4 == (10, 9, 8, 7)
+
+assert ca == CA(4, 5, 6)
+four, *rest = ca.popFT(1000)
+assert four == 4
+assert rest == [5, 6]
+assert len(ca) == 0
+
+ca = CA(1, 2, 3)
+assert ca.popLD(42) == 1
+assert ca.popRD(42) == 3
+assert ca.popLD(42) == 2
+assert ca.popRD(42) == 42
+assert ca.popLD(42) == 42
+assert len(ca) == 0
+```
+
+---
+
+[1]: https://pypi.org/project/dtools.circular-array
+[2]: https://github.com/grscheller/dtools-circular-array
+[3]: https://grscheller.github.io/dtools-namespace-docs/circular-array/
+
+

dtools_circular_array-3.9.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+dtools/circular_array/__init__.py,sha256=yHBn_zsWPfiTPmcdYe4XyO6I6tbx9RTMDBukau6zXWg,917
+dtools/circular_array/ca.py,sha256=qoOjG-m_Z2XlYqRAA4w0HxSUaqz_U3E-7bpzqK-vtQY,15646
+dtools/circular_array/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtools_circular_array-3.9.0.dist-info/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
+dtools_circular_array-3.9.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+dtools_circular_array-3.9.0.dist-info/METADATA,sha256=UgiPcUtbURZgznj3dUJjcOB5LDfEQeisr5vpN2PoAa4,2512
+dtools_circular_array-3.9.0.dist-info/RECORD,,

dtools_circular_array-3.9.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.10.1
+Root-Is-Purelib: true
+Tag: py3-none-any