pythonic-fp.containers 2.0.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

pythonic_fp/containers/__init__.py

@@ -12,7 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Developer Tools - Container-like data structures"""
+"""Package of container like data structures.
+
++------------------+--------+----------------------------------------------------+
+| Description      | Class  | Package/Module                                     |
++==================+========+====================================================+
+| Functional tuple | FTuple | module ``pythonic_fp.containers.functional_tuple`` |
++------------------+--------+----------------------------------------------------+
+| Immutable list   | IList  | module ``pythonic_fp.containers.immutable_list``   |
++------------------+--------+----------------------------------------------------+
+| Queues           |        | package ``pythonic_fp.containers.queues``          |
++------------------+--------+----------------------------------------------------+
+
+.. note::
+
+    Module ``box`` has  been moved to ``pythonic_fp.gadgets.box``.
+
+"""
 
 __author__ = 'Geoffrey R. Scheller'
 __copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'

pythonic_fp/containers/functional_tuple.py

@@ -17,24 +17,29 @@
 from __future__ import annotations
 
 from collections.abc import Callable, Iterator
-from typing import cast, Never, overload
-from pythonic_fp.iterables import FM, accumulate, concat, exhaust, merge
+from typing import cast, Never, overload, TypeVar
+from pythonic_fp.iterables.folding import accumulate
+from pythonic_fp.iterables.merging import blend, concat, MergeEnum
 
-__all__ = ['FunctionalTuple', 'functional_tuple']
+__all__ = ['FTuple']
 
-class FunctionalTuple[D](tuple[D, ...]):
+D = TypeVar('D', covariant=True)
+
+class FTuple[D](tuple[D, ...]):
     """Functional Tuple suitable for inheritance
 
     - Supports both indexing and slicing
-    - FunctionalTuple addition and int multiplication supported
+    - FTuple addition and int multiplication supported
 
       - addition concatenates results, resulting in a Union type
       - both left and right int multiplication supported
       - homogeneous in its data type
       - supports being further inherited from
       - unslotted
-    """
 
+    - Since these tuples are homogeneous, their covariance may be quirky
+
+    """
     def __reversed__(self) -> Iterator[D]:
         for ii in range(len(self) - 1, -1, -1):
             yield (self[ii])
@@ -80,19 +85,20 @@ class FunctionalTuple[D](tuple[D, ...]):
         - fold left with an optional starting value
         - first argument of function f is for the accumulated value
 
-        :raises ValueError: when FunctionalTuple empty and a start value not given
+        :raises ValueError: when FTuple empty and a start value not given
+
         """
-        it = iter(self)
+        it_self = iter(self)
         if start is not None:
             acc = start
         elif self:
-            acc = cast(L, next(it))
+            acc = cast(L, next(it_self))
         else:
             if default is None:
-                msg = 'Both start and default cannot be None for an empty FunctionalTuple'
-                raise ValueError('FunctionalTuple.foldl - ' + msg)
+                msg = 'Both start and default cannot be None for an empty FTuple'
+                raise ValueError('FTuple.foldl - ' + msg)
             acc = default
-        for v in it:
+        for v in it_self:
             acc = f(acc, v)
         return acc
 
@@ -108,29 +114,30 @@ class FunctionalTuple[D](tuple[D, ...]):
         - fold right with an optional starting value
         - second argument of function f is for the accumulated value
 
-        :raises ValueError: when FunctionalTuple empty and a start value not given
+        :raises ValueError: when FTuple empty and a start value not given
+
         """
-        it = reversed(self)
+        it_self = reversed(self)
         if start is not None:
             acc = start
         elif self:
-            acc = cast(R, next(it))
+            acc = cast(R, next(it_self))
         else:
             if default is None:
-                msg = 'Both start and default cannot be None for an empty FunctionalTuple'
-                raise ValueError('FunctionalTuple.foldR - ' + msg)
+                msg = 'Both start and default cannot be None for an empty FTuple'
+                raise ValueError('FTuple.foldR - ' + msg)
             acc = default
-        for v in it:
+        for v in it_self:
             acc = f(v, acc)
         return acc
 
-    def copy(self) -> FunctionalTuple[D]:
-        """Return a shallow copy of ``FunctionalTuple`` in O(1) time & space complexity."""
+    def copy(self) -> FTuple[D]:
+        """Return a shallow copy of ``FTuple`` in O(1) time & space complexity."""
         return self.__class__(self)
 
     def __add__(self, other: object, /) -> tuple[D, ...]:
-        if not isinstance(other, FunctionalTuple):
-            msg = 'FunctionalTuple being added to something not an FunctionalTuple'
+        if not isinstance(other, FTuple):
+            msg = 'FTuple being added to something not an FTuple'
             raise ValueError(msg)
         return self.__class__(concat(self, other))
 
@@ -142,48 +149,36 @@ class FunctionalTuple[D](tuple[D, ...]):
 
     def accummulate[L](
         self, f: Callable[[L, D], L], s: L | None = None, /
-    ) -> FunctionalTuple[L]:
+    ) -> FTuple[L]:
         """Accumulate partial folds
 
-        Accumulate partial fold results in an ``FunctionalTuple`` with an optional
+        Accumulate partial fold results in an ``FTuple`` with an optional
         starting value.
+
         """
         if s is None:
-            return FunctionalTuple(accumulate(self, f))
-        return FunctionalTuple(accumulate(self, f, s))
+            return FTuple(accumulate(self, f))
+        return FTuple(accumulate(self, f, s))
 
-    def map[U](self, f: Callable[[D], U], /) -> FunctionalTuple[U]:
-        return FunctionalTuple(map(f, self))
+    def map[U](self, f: Callable[[D], U], /) -> FTuple[U]:
+        return FTuple(map(f, self))
 
     def bind[U](
-        self, f: Callable[[D], FunctionalTuple[U]], type: FM = FM.CONCAT, /
-    ) -> FunctionalTuple[U] | Never:
-        """Bind function ``f`` to the ``FunctionalTuple``.
+            self, f: Callable[[D], FTuple[U]],
+            merge_enum: MergeEnum = MergeEnum.Concat,
+            yield_partials: bool = False,
+        ) -> FTuple[U] | Never:
+        """Bind function ``f`` to the ``FTuple``.
 
-        - FM Enum types
+        :param ds: values to instantiate FTuple
+        :return: resulting FTuple
+        :raises ValueError: if given unknown merge_type
 
-          - CONCAT: sequentially concatenate iterables one after the other
-          - MERGE: round-robin merge iterables until one is exhausted
-          - EXHAUST: round-robin merge iterables until all are exhausted
-
-        :param ds: values to instantiate FunctionalTuple
-        :return: resulting FunctionalTuple
         """
-        match type:
-            case FM.CONCAT:
-                return FunctionalTuple(concat(*map(f, self)))
-            case FM.MERGE:
-                return FunctionalTuple(merge(*map(f, self)))
-            case FM.EXHAUST:
-                return FunctionalTuple(exhaust(*map(f, self)))
-
-        raise ValueError('Unknown FM type')
-
-
-def functional_tuple[D](*ds: D):
-    """Construct a ``FunctionalTuple`` from arguments.
-
-    :param ds: values to instantiate FunctionalTuple
-    :return: resulting FunctionalTuple
-    """
-    return FunctionalTuple(ds)
+        return FTuple(
+            blend(
+                *map(f, self),
+                merge_enum=merge_enum,
+                yield_partials=yield_partials
+            )
+        )

pythonic_fp/containers/immutable_list.py

@@ -18,8 +18,8 @@
 - declared covariant in its generic datatype
   - hashability should be enforced by LSP tooling
   - hashability will be enforced at runtime
-  - ImmutableList addition supported via concatenation
-  - ImmutableList integer multiplication supported
+  - IList addition supported via concatenation
+  - IList integer multiplication supported
 
 """
 
@@ -27,14 +27,15 @@ from __future__ import annotations
 
 from collections.abc import Callable, Iterable, Iterator, Hashable
 from typing import cast, Never, overload, TypeVar
-from pythonic_fp.iterables import FM, accumulate, concat, exhaust, merge
+from pythonic_fp.iterables.folding import accumulate
+from pythonic_fp.iterables.merging import blend, concat, MergeEnum
 
-__all__ = ['ImmutableList', 'immutable_list']
+__all__ = ['IList']
 
 D = TypeVar('D', covariant=True)
 T = TypeVar('T')
 
-class ImmutableList[D](Hashable):
+class IList[D](Hashable):
     """Immutable List like data structure.
 
     - its method type parameters are also covariant
@@ -42,8 +43,8 @@ class ImmutableList[D](Hashable):
     - supports both indexing and slicing
     - addition concatenates results, resulting type a Union type
     - both left and right int multiplication supported
-    """
 
+    """
     __slots__ = ('_ds', '_len', '_hash')
     __match_args__ = ('_ds', '_len')
 
@@ -53,7 +54,7 @@ class ImmutableList[D](Hashable):
 
     def __init__(self, *dss: Iterable[D]) -> None:
         if (size := len(dss)) > 1:
-            msg = f'ImmutableList expects at most 1 iterable argument, got {size}'
+            msg = f'IList expects at most 1 iterable argument, got {size}'
             raise ValueError(msg)
         else:
             self._ds: tuple[D, ...] = tuple(dss[0]) if size == 1 else tuple()
@@ -61,7 +62,7 @@ class ImmutableList[D](Hashable):
             try:
                 self._hash = hash((self._len, 42) + self._ds)
             except TypeError as exc:
-                msg = f'ImmutableList: {exc}'
+                msg = f'IList: {exc}'
                 raise TypeError(msg)
 
     def __hash__(self) -> int:
@@ -86,7 +87,7 @@ class ImmutableList[D](Hashable):
         return '((' + ', '.join(map(repr, self)) + '))'
 
     def __eq__(self, other: object, /) -> bool:
-        if not isinstance(other, ImmutableList):
+        if not isinstance(other, IList):
             return NotImplemented  # magic object
         if self._len != other._len:
             return False
@@ -97,11 +98,11 @@ class ImmutableList[D](Hashable):
     @overload
     def __getitem__(self, idx: int, /) -> D: ...
     @overload
-    def __getitem__(self, idx: slice, /) -> ImmutableList[D]: ...
+    def __getitem__(self, idx: slice, /) -> IList[D]: ...
 
-    def __getitem__(self, idx: slice | int, /) -> ImmutableList[D] | D:
+    def __getitem__(self, idx: slice | int, /) -> IList[D] | D:
         if isinstance(idx, slice):
-            return ImmutableList(self._ds[idx])
+            return IList(self._ds[idx])
         return self._ds[idx]
 
     def foldl[L](
@@ -117,6 +118,7 @@ class ImmutableList[D](Hashable):
         - first argument of function ``f`` is for the accumulated value
         
         "raises ValueError: when empty and a start value not given
+
         """
         it = iter(self._ds)
         if start is not None:
@@ -125,9 +127,9 @@ class ImmutableList[D](Hashable):
             acc = cast(L, next(it))  # L_co = D_co in this case
         else:
             if default is None:
-                msg0 = 'ImmutableList: foldl method requires '
+                msg0 = 'IList: foldl method requires '
                 msg1 = 'either start or default to be defined for '
-                msg2 = 'an empty ImmutableList'
+                msg2 = 'an empty IList'
                 raise ValueError(msg0 + msg1 + msg2)
             acc = default
         for v in it:
@@ -147,6 +149,7 @@ class ImmutableList[D](Hashable):
         - second argument of function ``f`` is for the accumulated value
 
         "raises ValueError: when empty and a start value not given
+
         """
         it = reversed(self._ds)
         if start is not None:
@@ -155,68 +158,61 @@ class ImmutableList[D](Hashable):
             acc = cast(R, next(it))
         else:
             if default is None:
-                msg0 = 'ImmutableList: foldr method requires '
+                msg0 = 'IList: foldr method requires '
                 msg1 = 'either start or default to be defined for '
-                msg2 = 'an empty ImmutableList'
+                msg2 = 'an empty IList'
                 raise ValueError(msg0 + msg1 + msg2)
             acc = default
         for v in it:
             acc = f(v, acc)
         return acc
 
-    def __add__(self, other: ImmutableList[D], /) -> ImmutableList[D]:
-        if not isinstance(other, ImmutableList):
-            msg = 'ImmutableList being added to something not a ImmutableList'
+    def __add__(self, other: IList[D], /) -> IList[D]:
+        if not isinstance(other, IList):
+            msg = 'IList being added to something not a IList'
             raise ValueError(msg)
 
-        return ImmutableList(concat(self, other))
+        return IList(concat(self, other))
 
-    def __mul__(self, num: int, /) -> ImmutableList[D]:
-        return ImmutableList(self._ds.__mul__(num if num > 0 else 0))
+    def __mul__(self, num: int, /) -> IList[D]:
+        return IList(self._ds.__mul__(num if num > 0 else 0))
 
-    def __rmul__(self, num: int, /) -> ImmutableList[D]:
-        return ImmutableList(self._ds.__mul__(num if num > 0 else 0))
+    def __rmul__(self, num: int, /) -> IList[D]:
+        return IList(self._ds.__mul__(num if num > 0 else 0))
 
     def accummulate[L](
         self, f: Callable[[L, D], L], s: L | None = None, /
-    ) -> ImmutableList[L]:
+    ) -> IList[L]:
         """Accumulate partial folds
 
-        Accumulate partial fold results in an ImmutableList with
+        Accumulate partial fold results in an IList with
         an optional starting value.
+
         """
         if s is None:
-            return ImmutableList(accumulate(self, f))
-        return ImmutableList(accumulate(self, f, s))
+            return IList(accumulate(self, f))
+        return IList(accumulate(self, f, s))
 
-    def map[U](self, f: Callable[[D], U], /) -> ImmutableList[U]:
-        return ImmutableList(map(f, self))
+    def map[U](self, f: Callable[[D], U], /) -> IList[U]:
+        return IList(map(f, self))
 
     def bind[U](
-        self, f: Callable[[D], ImmutableList[U]], type: FM = FM.CONCAT, /
-    ) -> ImmutableList[U] | Never:
-        """Bind function `f` to the `ImmutableList`.
+            self,
+            f: Callable[[D], IList[U]],
+            merge_enum: MergeEnum = MergeEnum.Concat,
+            yield_partials: bool = False,
+        ) -> IList[U] | Never:
+        """Bind function `f` to the `IList`.
 
-        - FM Enum types
+        :param ds: values to instantiate IList
+        :return: resulting IList
+        :raises ValueError: if given unknown merge_type
 
-          - CONCAT: sequentially concatenate iterables one after the other
-          - MERGE: round-robin merge iterables until one is exhausted
-          - EXHAUST: round-robin merge iterables until all are exhausted
         """
-        match type:
-            case FM.CONCAT:
-                return ImmutableList(concat(*map(f, self)))
-            case FM.MERGE:
-                return ImmutableList(merge(*map(f, self)))
-            case FM.EXHAUST:
-                return ImmutableList(exhaust(*map(f, self)))
-
-        raise ValueError(f'ImmutableList: Unknown FM type: {type}')
-
-
-def immutable_list[T](*ts: T) -> ImmutableList[TabError]:
-    """Function to produce an ``ImmutableList`` from a variable number of arguments.
-
-    :param ds: initial values to push onto a new ImmutableList from right to left
-    """
-    return ImmutableList(ts)
+        return IList(
+            blend(
+                *map(f, self),
+                merge_enum=merge_enum,
+                yield_partials=yield_partials
+            )
+        )

pythonic_fp/containers/queues/__init__.py

@@ -0,0 +1,31 @@
+# Copyright 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.
+
+"""Three types of queues.
+
++------------------------------------+-----------+--------------------------+
+| module                             | Class     | description              |
++====================================+===========+==========================+
+| pythonic_fp.containers.queues.fifo | FIFOQueue | First-In-First-Out queue |
++------------------------------------+-----------+--------------------------+
+| pythonic_fp.containers.queues.lifo | LIFOQueue | Last-In-First-Out queue  |
++------------------------------------+-----------+--------------------------+
+| pythonic_fp.containers.queues.de   | DEQueue   | Double-Ended queue       |
++------------------------------------+-----------+--------------------------+
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp/containers/queues/de.py

@@ -0,0 +1,180 @@
+# 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.
+
+"""Stateful Double-Ended (DE) Queue data structure.
+
+- O(1) pops each end
+- O(1) amortized pushes each end
+- O(1) length determination
+- will automatically increase storage capacity when needed
+- in a Boolean context, true if not empty, false if empty
+- neither indexable nor sliceable by design
+
+"""
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator
+from typing import TypeVar
+from pythonic_fp.circulararray.auto import CA
+from pythonic_fp.fptools.maybe import MayBe
+
+__all__ = ['DEQueue', 'de_queue']
+
+D = TypeVar('D')
+
+
+class DEQueue[D]:
+
+    __slots__ = ('_ca',)
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        """Initial data in FIFO order, newest to oldest, as if
+        pushed on from the right side.
+
+        :param dss: takes up to one iterable
+        :raises ValueError: if more than 1 iterable is given
+
+        """
+        if (size := len(dss)) > 1:
+            msg = f'DEQueue expects at most 1 argument, got {size}'
+            raise ValueError(msg)
+        self._ca = CA(dss[0]) if size == 1 else CA()
+
+    def __bool__(self) -> bool:
+        return len(self._ca) > 0
+
+    def __len__(self) -> int:
+        return len(self._ca)
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, DEQueue):
+            return False
+        return self._ca == other._ca
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(list(self._ca))
+
+    def __reversed__(self) -> Iterator[D]:
+        return reversed(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'DEQueue()'
+        return 'DEQueue(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return '>< ' + ' | '.join(map(str, self)) + ' ><'
+
+    def copy(self) -> DEQueue[D]:
+        """Shallow copy.
+
+        :return: shallow copy of the DEQueue
+
+        """
+        return DEQueue(self._ca)
+
+    def pushl(self, *ds: D) -> None:
+        """Push data onto left side of DEQueue.
+
+        :param ds: items to be pushed onto DEQueue from the left
+
+        """
+        self._ca.pushl(*ds)
+
+    def pushr(self, *ds: D) -> None:
+        """Push data onto right side of DEQueue.
+
+        :param ds: items to be pushed onto DEQueue from the right
+
+        """
+        self._ca.pushr(*ds)
+
+    def popl(self) -> MayBe[D]:
+        """Pop next data item from left side DEQueue, if it exists.
+
+        :return: MayBe of popped item if queue was not empty, empty MayBe otherwise
+
+        """
+        if self._ca:
+            return MayBe(self._ca.popl())
+        return MayBe()
+
+    def popr(self) -> MayBe[D]:
+        """Pop next item off right side DEQueue.
+
+        :return: MayBe of popped item if queue was not empty, empty MayBe otherwise
+
+        """
+        if self._ca:
+            return MayBe(self._ca.popr())
+        return MayBe()
+
+    def peakl(self) -> MayBe[D]:
+        """Peak at data on left side of DEQueue.
+
+        :return: MayBe of leftmost data if queue not empty, empty MayBe otherwise
+
+        """
+        if self._ca:
+            return MayBe(self._ca[0])
+        return MayBe()
+
+    def peakr(self) -> MayBe[D]:
+        """Peak at right side of DEQueue. Does not consume item.
+
+        :return: MayBe of rightmost data if queue not empty, empty MayBe otherwise
+
+        """
+        if self._ca:
+            return MayBe(self._ca[-1])
+        return MayBe()
+
+    def foldl[L](self, f: Callable[[L, D], L], start: L | None = None) -> MayBe[L]:
+        """Reduces DEQueue left to right.
+
+        :param f: reducing function, first argument is for accumulator
+        :param start: optional starting value
+        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
+
+        """
+        if start is None:
+            if not self._ca:
+                return MayBe()
+        return MayBe(self._ca.foldl(f, start))
+
+    def foldr[R](self, f: Callable[[D, R], R], start: R | None = None) -> MayBe[R]:
+        """Reduces DEQueue right to left.
+
+        :param f: reducing function, second argument is for accumulator
+        :param start: optional starting value
+        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
+
+        """
+        if start is None:
+            if not self._ca:
+                return MayBe()
+        return MayBe(self._ca.foldr(f, start))
+
+    def map[U](self, f: Callable[[D], U]) -> DEQueue[U]:
+        """Map f over the DEQueue left to right, retain original order.
+
+        :return: new DEQueue instance
+
+        """
+        return DEQueue(map(f, self._ca))
+
+
+def de_queue[D](*ds: D) -> DEQueue[D]:
+    """DEQueue factory function."""
+    return DEQueue(ds)