dtools.datastructures 0.25.0__py3-none-any.whl

dtools/datastructures/__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.
+
+"""
+### package datastructures
+
+Designed to be helpful when using and implementation algorithms.
+
+#### Modules and sub-packages
+
+* module dtools.datastructures.nodes: nodes for graph-like data structures
+* package dtools.datastructures.splitends: data sharing between mutable objects
+* module dtools.datastructures.tuples: tuple-like data structures
+* module dtools.datastructures.queues: queue data structures
+
+"""
+__version__ = "0.25.0"
+__author__ = "Geoffrey R. Scheller"
+__copyright__ = "Copyright (c) 2023-2024 Geoffrey R. Scheller"
+__license__ = "Apache License 2.0"

dtools/datastructures/nodes.py

@@ -0,0 +1,189 @@
+# 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.
+
+"""
+### Nodes for Graphs
+
+Node classes used with graph-like data structures. API designed to be used by
+other data structures which contain these data structures.
+
+#### Node types
+
+* class **SL_Node:**
+* class **DL_Node:**
+* class **Tree_Node:**
+
+"""
+from __future__ import annotations
+from collections.abc import Callable, Iterator
+from typing import Callable, cast, Iterator
+from dtools.fp.err_handling import MB
+
+__all__ = ['SL_Node', 'DL_Node', 'Tree_Node']
+
+class SL_Node[D]():
+    """Data node for rearward Pointing (tip-to-root) singularly linked graphs.
+
+    * for mutable and immutable linear data structures
+    * designed so multiple instances can safely share the same data
+    * this type of node always contain data and optionally a previous Node
+    * nodes point towards a unique "root node" with no predecessor
+      * in a Boolean context return false only if only at a root
+      * multiple root nodes can exist
+      * empty data structures can be "re-rooted"
+    * two nodes compare as equal if
+      * both their previous Nodes are the same
+      * their data compares as equal
+    * more than one node can point to the same node forming bush like graphs
+
+    """
+    __slots__ = '_data', '_prev'
+
+    def __init__(self, data: D, prev: MB[SL_Node[D]]) -> None:
+        self._data = data
+        self._prev = prev
+
+    def __iter__(self) -> Iterator[D]:
+        node = self
+        while node:
+            yield node._data
+            node = node._prev.get()
+        yield node._data
+
+    def __bool__(self) -> bool:
+        return self._prev != MB()
+
+    def data_eq(self, other: SL_Node[D]) -> bool:
+        if self._data is other._data:
+            return True
+        elif self._data == other._data:
+            return True
+        else:
+            return False
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._prev is not other._prev:
+            return False
+        else:
+            return self.data_eq(other)
+
+    def get_data(self) -> D:
+        return self._data
+
+    def fold[T](self,  f: Callable[[T, D], T], init: T|None=None) -> T:
+        """Reduce data across linked nodes.
+
+        * with a function and an optional starting value
+        * reduces in natural LIFO order
+          * from self to the root
+
+        """
+        if init is None:
+            acc: T = cast(T, self._data)
+            node = self._prev.get()
+        else:
+            acc = init
+            node = self
+
+        while node:
+            acc = f(acc, node._data)
+            node = node._prev.get()
+        acc = f(acc, node._data)
+        return acc
+
+    def pop2(self) -> tuple[D, MB[SL_Node[D]]]:
+        """Return the *head* and, if it exists, the top node of the *tail*."""
+        return self._data, self._prev
+
+    def push_data(self, data: D) -> SL_Node[D]:
+        """Push data onto the stack and return a new node containing the data."""
+        return SL_Node(data, MB(self))
+
+class DL_Node[D]():
+    """Doubly Linked Node.
+
+    Doubly linked nodes for graph-like data structures.
+
+    * this type of node always contain data, even if that data is None
+      * in a Boolean context return true if both left and right nodes exist
+    * doubly link lists possible
+    * circular graphs are possible
+    * simple recursive binary trees possible
+
+    """
+    __slots__ = '_left', '_data', '_right'
+
+    def __init__(self, left: MB[DL_Node[D]], data: D, right: MB[DL_Node[D]]):
+        self._left = left
+        self._data = data
+        self._right = right
+
+    def __bool__(self) -> bool:
+        if self._left == MB() or self._right == MB():
+            return False
+        return True
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._left is not other._left:
+            return False
+        if self._right is not other._right:
+            return False
+        if self._data is other._data:
+            return True
+        elif self._data == other._data:
+            return True
+
+        return False
+
+    def has_left(self) -> bool:
+        return self._left != MB()
+
+    def has_right(self) -> bool:
+        return self._right != MB()
+
+class Tree_Node[D, M]():
+    """Binary Tree Node with metadata.
+
+    Nodes useful for binary trees.
+
+    * this type of node always contain data, even if that data is None
+    * in a Boolean context return true if not at the top of the tree
+    * potential uses of metadata can be for re-balancing or repeat counts
+    """
+    __slots__ = '_data', '_left', '_right', '_up'
+
+    def __init__(self, data: D,
+                 up: MB[Tree_Node[D,M]],
+                 left: MB[Tree_Node[D,M]],
+                 right: MB[Tree_Node[D,M]],
+                 meta: tuple[M, ...] = ()):
+        self._data = data
+        self._up = up
+        self._left = left
+        self._right = right
+
+    def __bool__(self) -> bool:
+        if self._up == MB():
+            return False
+        else:
+            return True
+
+    def is_top(self) -> bool:
+        return self._up == MB()

dtools/datastructures/queues.py

@@ -0,0 +1,420 @@
+# 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.
+
+"""### Queue based data structures
+
+* stateful queue data structures with amortized O(1) pushes and pops each end
+* obtaining length (number of elements) of a queue is an O(1) operation
+* implemented in a "has-a" relationship with a Python list based circular array
+* these data structures will resize themselves larger as needed
+
+#### FIFOQueue
+
+* class **FIFOQueue:** First-In-First-Out Queue
+* function **FQ:** Constructs a FIFOQueue from a variable number of arguments
+
+---
+
+#### LIFOQueue
+
+* class **LIFOQueue:** Last-In-First-Out Queue
+* function **LQ:** Constructs a LIFOQueue from a variable number of arguments
+
+---
+
+#### DoubleQueue
+
+* class **DoubleQueue:** Double-Ended Queue
+* function **DQ:** Constructs a DoubleQueue from a variable number of arguments
+
+"""
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import Never, overload
+from dtools.circular_array.ca import ca, CA
+from dtools.fp.err_handling import MB
+
+__all__ = [ 'DoubleQueue', 'FIFOQueue', 'LIFOQueue', 'QueueBase',
+            'DQ', 'FQ', 'LQ' ]
+
+class QueueBase[D](Sequence[D]):
+    """Base class for circular area based queues.
+
+    * implemented with a dtools.circular-array in a "has-a" relationship
+    * order of initial data retained
+    * slicing not yet implemented
+
+    """
+    __slots__ = '_ca'
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if len(dss) < 2:
+            self._ca = ca(*dss)
+        else:
+            msg1 = f'{type(self).__name__}: expected at most 1 '
+            msg2 = f'iterable argument, got {len(dss)}.'
+            raise TypeError(msg1+msg2)
+
+    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, type(self)):
+            return False
+        return self._ca == other._ca
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> Sequence[D]: ...
+
+    def __getitem__(self, idx: int|slice, /) -> D|Sequence[D]|Never:
+        if isinstance(idx, slice):
+            raise NotImplementedError
+        return self._ca[idx]
+
+class FIFOQueue[D](QueueBase[D]):
+    """FIFO Queue
+
+    * stateful First-In-First-Out (FIFO) data structure
+    * initial data pushed on in natural FIFO order
+
+    """
+    __slots__ = ()
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'FQ()'
+        else:
+            return 'FQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return "<< " + " < ".join(map(str, self)) + " <<"
+
+    def copy(self) -> FIFOQueue[D]:
+        """Return a shallow copy of the `FIFOQueue`."""
+        return FIFOQueue(self._ca)
+
+    def push(self, *ds: D) -> None:
+        """Push data onto `FIFOQueue`.
+
+        * like a Python List, does not return a value
+
+        """
+        self._ca.pushR(*ds)
+
+    def pop(self) -> MB[D]:
+        """Pop data from `FIFOQueue`.
+
+        * pop item off queue, return item in a maybe monad
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca.popL())
+        else:
+            return MB()
+
+    def peak_last_in(self) -> MB[D]:
+        """Peak last data into `FIFOQueue`.
+
+        * return a maybe monad of the last item pushed to queue
+        * does not consume the data
+        * if item already popped, return `MB()`
+
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        else:
+            return MB()
+
+    def peak_next_out(self) -> MB[D]:
+        """Peak next data out of `FIFOQueue`.
+
+        * returns a maybe monad of the next item to be popped from the queue.
+        * does not consume it the item
+        * returns `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca[0])
+        else:
+            return MB()
+
+    def fold[L](self, f: Callable[[L, D], L], initial: L|None=None, /) -> MB[L]:
+        """Fold `FIFOQueue` in natural order.
+
+        Reduce with `f` using an optional initial value.
+
+        * folds in natural FIFO Order (oldest to newest)
+        * note that when an initial value is not given then `~L = ~D`
+        * if iterable empty & no initial value given, return `MB()`
+        * traditional FP type order given for function `f`
+
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldL(f, initial=initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> FIFOQueue[U]:
+        """Map over the `FIFOQueue`.
+
+        * map function `f` over the queue
+          * oldest to newest
+          * retain original order
+        * returns a new instance
+
+        """
+        return FIFOQueue(map(f, self._ca))
+
+class LIFOQueue[D](QueueBase[D]):
+    """LIFO Queue.
+
+    * stateful Last-In-First-Out (LIFO) data structure
+    * initial data pushed on in natural LIFO order
+
+    """
+    __slots__ = ()
+
+    def __iter__(self) -> Iterator[D]:
+        return reversed(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'LQ()'
+        else:
+            return 'LQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return "|| " + " > ".join(map(str, self)) + " ><"
+
+    def copy(self) -> LIFOQueue[D]:
+        """Return a shallow copy of the `LIFOQueue`."""
+        return LIFOQueue(reversed(self._ca))
+
+    def push(self, *ds: D) -> None:
+        """Push data onto `LIFOQueue`.
+
+        * like a Python List, does not return a value
+
+        """
+        self._ca.pushR(*ds)
+
+    def pop(self) -> MB[D]:
+        """Pop data from `LIFOQueue`.
+
+        * pop item off of queue, return item in a maybe monad
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca.popR())
+        else:
+            return MB()
+
+    def peak(self) -> MB[D]:
+        """Peak next data out of `LIFOQueue`.
+
+        * return a maybe monad of the next item to be popped from the queue
+        * does not consume the item
+        * returns `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        else:
+            return MB()
+
+    def fold[R](self, f: Callable[[D, R], R], initial: R|None=None, /) -> MB[R]:
+        """Fold `LIFOQueue` in natural order.
+
+        Reduce with `f` using an optional initial value.
+
+        * folds in natural LIFO Order (newest to oldest)
+        * note that when an initial value is not given then `~R = ~D`
+        * if iterable empty & no initial value given, return `MB()`
+        * traditional FP type order given for function `f`
+
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldR(f, initial=initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> LIFOQueue[U]:
+        """Map Over the `LIFOQueue`.
+
+        * map the function `f` over the queue
+          * newest to oldest
+          * retain original order
+        * returns a new instance
+
+        """
+        return LIFOQueue(reversed(CA(*map(f, reversed(self._ca)))))
+
+class DoubleQueue[D](QueueBase[D]):
+    """Double Ended Queue
+
+    * stateful Double-Ended (DEQueue) data structure
+    * order of initial data retained
+
+    """
+    __slots__ = ()
+
+    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 'DQ()'
+        else:
+            return 'DQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return ">< " + " | ".join(map(str, self)) + " ><"
+
+    def copy(self) -> DoubleQueue[D]:
+        """Return a shallow copy of the `DoubleQueue`."""
+        return DoubleQueue(self._ca)
+
+    def pushL(self, *ds: D) -> None:
+        """Push data onto left side (front) of `DoubleQueue`.
+
+        * like a Python List, does not return a value
+
+        """
+        self._ca.pushL(*ds)
+
+    def pushR(self, *ds: D) -> None:
+        """Push data onto right side (rear) of `DoubleQueue`.
+
+        * like a Python List, does not return a value
+
+        """
+        self._ca.pushR(*ds)
+
+    def popL(self) -> MB[D]:
+        """Pop Data from left side (front) of `DoubleQueue`.
+
+        * pop left most item off of queue, return item in a maybe monad
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca.popL())
+        else:
+            return MB()
+
+    def popR(self) -> MB[D]:
+        """Pop Data from right side (rear) of `DoubleQueue`.
+
+        * pop right most item off of queue, return item in a maybe monad
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca.popR())
+        else:
+            return MB()
+
+    def peakL(self) -> MB[D]:
+        """Peak left side of `DoubleQueue`.
+
+        * return left most value in a maybe monad
+        * does not consume the item
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca[0])
+        else:
+            return MB()
+
+    def peakR(self) -> MB[D]:
+        """Peak right side of `DoubleQueue`.
+
+        * return right most value in a maybe monad
+        * does not consume the item
+        * returns an empty `MB()` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        else:
+            return MB()
+
+    def foldL[L](self, f: Callable[[L, D], L], initial: L|None=None, /) -> MB[L]:
+        """Fold `DoubleQueue` left to right.
+
+        Reduce left with `f` using an optional initial value.
+
+        * note that when an initial value is not given then `~L = ~D`
+        * if iterable empty & no initial value given, return `MB()`
+        * traditional FP type order given for function `f`
+
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldL(f, initial=initial))
+
+    def foldR[R](self, f: Callable[[D, R], R], initial: R|None=None, /) -> MB[R]:
+        """Fold `DoubleQueue` right to left.
+
+        Reduce right with `f` using an optional initial value.
+
+        * note that when an initial value is not given then `~R = ~D`
+        * if iterable empty & no initial value given, return `MB()`
+        * traditional FP type order given for function `f`
+
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldR(f, initial=initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> DoubleQueue[U]:
+        """`Map a function over `DoubleQueue`.
+
+        * map the function `f` over the `DoubleQueue`
+          * left to right
+          * retain original order
+        * returns a new instance
+
+        """
+        return DoubleQueue(map(f, self._ca))
+
+def FQ[D](*ds: D) -> FIFOQueue[D]:
+    """Return a FIFOQueue where data is pushed on in natural FIFO order."""
+    return FIFOQueue(ds)
+
+def LQ[D](*ds: D) -> LIFOQueue[D]:
+    """Return a LIFOQueue where data is pushed on in natural LIFO order."""
+    return LIFOQueue(ds)
+
+def DQ[D](*ds: D) -> DoubleQueue[D]:
+    """Return a DoubleQueue whose data is pushed on from the right."""
+    return DoubleQueue(ds)
+

dtools/datastructures/splitends/__init__.py

@@ -0,0 +1,27 @@
+# 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.
+
+"""
+### package splitends
+
+Singularly linked datastructures that can safely share data between themselves.
+
+#### Package splitend modules
+
+* module **dtools.datastructures.splitends.se: Basic SplitEnd data structure
+
+"""
+__author__ = "Geoffrey R. Scheller"
+__copyright__ = "Copyright (c) 2024 Geoffrey R. Scheller"
+__license__ = "Apache License 2.0"

dtools/datastructures/splitends/se.py

@@ -0,0 +1,179 @@
+# 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.
+
+"""### SplitEnd stack related data structures
+
+With use I am finding this data structure needs some sort of supporting
+infrastructure. Hence I split the original splitend module out to be its own
+subpackage.
+
+#### SplitEnd Stack type and SE factory function
+
+* class SplitEnd: Singularly linked stack with shareable data nodes
+* function SE: create SplitEnd from a variable number of arguments
+
+"""
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator
+from typing import cast, Never
+from ..nodes import SL_Node
+from dtools.fp.err_handling import MB
+
+__all__ = [ 'SplitEnd', 'SE' ]
+
+class SplitEnd[D]():
+    """Class SplitEnd
+
+    LIFO stacks which can safely share immutable data between themselves.
+
+    * each SplitEnd is a very simple stateful (mutable) LIFO stack
+      * top of the stack is the "top"
+    * data can be pushed and popped to the stack
+    * different mutable split ends can safely share the same "tail"
+    * each SplitEnd sees itself as a singularly linked list
+    * bush-like datastructures can be formed using multiple SplitEnds
+    * len() returns the number of elements on the SplitEnd stack
+    * in boolean context, return true if split end is not empty
+
+    """
+    __slots__ = '_count', '_tip'
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if length:=len(dss) < 2:
+            self._tip: MB[SL_Node[D]] = MB()
+            self._count: int = 0
+            if length == 1:
+                self.pushI(*dss)
+        else:
+            msg1 = 'SplitEnd: expected at most 1 '
+            msg2 = f'iterable argument, got {length}.'
+            raise TypeError(msg1+msg2)
+
+    def __iter__(self) -> Iterator[D]:
+        if self._tip == MB():
+            empty: tuple[D, ...] = ()
+            return iter(empty)
+        return iter(self._tip.get())
+
+    def __reversed__(self) -> Iterator[D]:
+        return reversed(list(self))
+
+    def __bool__(self) -> bool:
+        # Returns true if not a root node
+        return bool(self._tip)
+
+    def __len__(self) -> int:
+        return self._count
+
+    def __repr__(self) -> str:
+        return 'SE(' + ', '.join(map(repr, reversed(self))) + ')'
+
+    def __str__(self) -> str:
+        return ('>< ' + ' -> '.join(map(str, self)) + ' ||')
+
+    def __eq__(self, other: object, /) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._count != other._count:
+            return False
+        if self._count == 0:
+            return True
+
+        left = self._tip.get()
+        right = other._tip.get()
+        for _ in range(self._count):
+            if left is right:
+                return True
+            if not left.data_eq(right):
+                return False
+            if left:
+                left = left._prev.get()
+                right = right._prev.get()
+
+        return True
+
+    def pushI(self, ds: Iterable[D], /) -> None:
+        """Push data onto the top of the SplitEnd."""
+        for d in ds:
+            node = SL_Node(d, self._tip)
+            self._tip, self._count = MB(node), self._count+1
+
+    def push(self, *ds: D) -> None:
+        """Push data onto the top of the SplitEnd."""
+        for d in ds:
+            node = SL_Node(d, self._tip)
+            self._tip, self._count = MB(node), self._count+1
+
+    def pop(self, default: D|None = None, /) -> D|Never:
+        """Pop data off of the top of the SplitEnd.
+
+        * raises ValueError if
+          * popping from an empty SplitEnd
+          * and no default value was given
+
+        """
+        if self._count == 0:
+            if default is None:
+                raise ValueError('SE: Popping from an empty SplitEnd')
+            else:
+                return default
+
+        data, self._tip, self._count = self._tip.get().pop2() + (self._count-1,)
+        return data
+
+    def peak(self, default: D|None = None, /) -> D:
+        """Return the data at the top of the SplitEnd.
+
+        * does not consume the data
+        * raises ValueError if peaking at an empty SplitEnd
+
+        """
+        if self._count == 0:
+            if default is None:
+                raise ValueError('SE: Popping from an empty SplitEnd')
+            else:
+                return default
+
+        return self._tip.get().get_data()
+
+    def copy(self) -> SplitEnd[D]:
+        """Return a copy of the SplitEnd.
+
+        * O(1) space & time complexity.
+        * returns a new instance
+
+        """
+        se: SplitEnd[D] = SE()
+        se._tip, se._count = self._tip, self._count
+        return se
+
+    def fold[T](self, f:Callable[[T, D], T], init: T|None = None, /) -> T|Never:
+        """Reduce with a function.
+
+        * folds in natural LIFO Order
+
+        """
+        if self._tip != MB():
+            return self._tip.get().fold(f, init)
+        elif init is not None:
+            return init
+        else:
+            msg = 'SE: Folding empty SplitEnd but no initial value supplied'
+            raise ValueError(msg)
+
+def SE[D](*ds: D) -> SplitEnd[D]:
+    return SplitEnd(ds)
+

dtools/datastructures/tuples.py

@@ -0,0 +1,203 @@
+# 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.
+
+"""### Tuple based data structures
+
+Only example here is the ftuple, basically an FP interface wrapping a tuple.
+Originally it inherited from tuple, but I found containing the tuple in a 
+"has-a" relationship makes for a faster implementation. Buried in the git
+history is another example called a "process array" (parray) which I might
+return to someday. The idea of the parray is a fixed length sequence with
+sentinel values. 
+
+#### FTuple and FT factory function.
+
+* class FTuple: Wrapped tuple with a Functional Programming API
+* function FE: 
+
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import cast, overload
+from dtools.fp.iterables import FM, accumulate, concat, exhaust, merge
+
+__all__ = ['FTuple', 'FT']
+
+class FTuple[D](Sequence[D]):
+    """
+    #### Functional Tuple
+
+    * immutable tuple-like data structure with a functional interface
+    * supports both indexing and slicing
+    * `FTuple` addition & `int` multiplication supported
+      * addition concatenates results, resulting type a Union type
+      * both left and right int multiplication supported
+
+    """
+    __slots__ = '_ds'
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if len(dss) < 2:
+            self._ds: tuple[D, ...] = tuple(*dss)
+        else:
+            msg = f'FTuple expected at most 1 iterable argument, got {len(dss)}'
+            raise TypeError(msg)
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(self._ds)
+
+    def __reversed__(self) -> Iterator[D]:
+        return reversed(self._ds)
+
+    def __bool__(self) -> bool:
+        return bool(len(self._ds))
+
+    def __len__(self) -> int:
+        return len(self._ds)
+
+    def __repr__(self) -> str:
+        return 'FT(' + ', '.join(map(repr, self)) + ')'
+
+    def __str__(self) -> str:
+        return "((" + ", ".join(map(repr, self)) + "))"
+
+    def __eq__(self, other: object, /) -> bool:
+        if self is other:
+            return True
+        if not isinstance(other, type(self)):
+            return False
+        return self._ds == other._ds
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> FTuple[D]: ...
+
+    def __getitem__(self, idx: slice|int, /) -> FTuple[D]|D:
+        if isinstance(idx, slice):
+            return FTuple(self._ds[idx])
+        else:
+            return self._ds[idx]
+
+    def foldL[L](self,
+              f: Callable[[L, D], L], /,
+              start: L|None=None,
+              default: L|None=None) -> L|None:
+        """
+        **Fold Left**
+
+        * fold left with an optional starting value
+        * first argument of function `f` is for the accumulated value
+        * throws `ValueError` when `FTuple` empty and a start value not given
+
+        """
+        it = iter(self._ds)
+        if start is not None:
+            acc = start
+        elif self:
+            acc = cast(L, next(it))  # L = D in this case
+        else:
+            if default is None:
+                msg = 'Both start and default cannot be None for an empty FTuple'
+                raise ValueError('FTuple.foldL - ' + msg)
+            acc = default
+        for v in it:
+            acc = f(acc, v)
+        return acc
+
+    def foldR[R](self,
+              f: Callable[[D, R], R], /,
+              start: R|None=None,
+              default: R|None=None) -> R|None:
+        """
+        **Fold Right**
+
+        * fold right with an optional starting value
+        * second argument of function `f` is for the accumulated value
+        * throws `ValueError` when `FTuple` empty and a start value not given
+
+        """
+        it = reversed(self._ds)
+        if start is not None:
+            acc = start
+        elif self:
+            acc = cast(R, next(it))  # R = D in this case
+        else:
+            if default is None:
+                msg = 'Both start and default cannot be None for an empty FTuple'
+                raise ValueError('FTuple.foldR - ' + msg)
+            acc = default
+        for v in it:
+            acc = f(v, acc)
+        return acc
+
+    def copy(self) -> FTuple[D]:
+        """
+        **Copy**
+
+        Return a shallow copy of the FTuple in O(1) time & space complexity.
+
+        """
+        return FTuple(self)
+
+    def __add__[E](self, other: FTuple[E], /) -> FTuple[D|E]:
+        return FTuple(concat(self, other))
+
+    def __mul__(self, num: int, /) -> FTuple[D]:
+        return FTuple(self._ds.__mul__(num if num > 0 else 0))
+
+    def __rmul__(self, num: int, /) -> FTuple[D]:
+        return FTuple(self._ds.__mul__(num if num > 0 else 0))
+
+    def accummulate[L](self, f: Callable[[L, D], L], s: L|None=None, /) -> FTuple[L]:
+        """
+        **Accumulate partial folds**
+
+        Accumulate partial fold results in an FTuple with an optional starting
+        value.
+
+        """
+        if s is None:
+            return FTuple(accumulate(self, f))
+        else:
+            return FTuple(accumulate(self, f, s))
+
+    def map[U](self, f: Callable[[D], U], /) -> FTuple[U]:
+        return FTuple(map(f, self))
+
+    def bind[U](self, f: Callable[[D], FTuple[U]], type: FM=FM.CONCAT, /) -> FTuple[U]:
+        """
+        Bind function `f` to the `FTuple`.
+
+        * type = CONCAT: sequentially concatenate iterables one after the other
+        * type = MERGE: merge iterables together until one is exhausted
+        * type = Exhaust: merge iterables together until all are exhausted
+
+        """
+        match type:
+            case FM.CONCAT:
+                return FTuple(concat(*map(lambda x: iter(x), map(f, self))))
+            case FM.MERGE:
+                return FTuple(merge(*map(lambda x: iter(x), map(f, self))))
+            case FM.EXHAUST:
+                return FTuple(exhaust(*map(lambda x: iter(x), map(f, self))))
+            case '*':
+                raise ValueError('Unknown FM type')
+
+def FT[D](*ds: D) -> FTuple[D]:
+    """Return an FTuple whose values are the function arguments."""
+    return FTuple(ds)
+

dtools_datastructures-0.25.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_datastructures-0.25.0.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.3
+Name: dtools.datastructures
+Version: 0.25.0
+Summary: ### package datastructures
+Keywords: datastructures,data structures,fifo,lifo,stack,queue,SplitEnd
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+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: dtools.circular-array >= 3.9.0, < 3.10
+Requires-Dist: dtools.fp >= 1.3.0, < 1.4
+Requires-Dist: pytest >=8.3.2 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/dtools-datastructures/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/dtools-docs/datastructures
+Project-URL: Source, https://github.com/grscheller/dtools-datastructures
+Provides-Extra: test
+
+# Python Datastructures Useful for Algorithms
+
+Python package of data structures which support the use and
+implementation of algorithms.
+
+* **Repositories**
+  * [dtools.datastructures][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* **Detailed documentation**
+  * [Detailed API documentation][3] on *GH-Pages*
+
+
+### Overview
+
+Data structures allowing developers to focus on the algorithms they are
+using instead of all the "bit fiddling" required to implement behaviors,
+perform memory management, and handle coding edge cases. These data
+structures allow iterators to leisurely iterate over inaccessible copies
+of internal state while the data structures themselves are free to
+safely mutate. They are designed to be reasonably "atomic" without
+introducing inordinate complexity. Some of these data structures allow
+data to be safely shared between multiple data structure instances by
+making shared data immutable and inaccessible to client code.
+
+* functional & imperative programming styles supported
+  * functional programming encouraged
+  * project endeavors to remain Pythonic
+    * methods which mutate objects don't return anything
+      * like Python lists
+    * in caparisons identity is considered before equality
+      * like Python builtins
+
+Sometimes the real power of a data structure comes not from what it
+empowers you to do, but from what it prevents you from doing to
+yourself.
+
+---
+
+[1]: https://pypi.org/project/grscheller.dtools-datastructures/
+[2]: https://github.com/grscheller/dtools-datastructures/
+[3]: https://grscheller.github.io/dtools-docs/datastructures/
+

dtools_datastructures-0.25.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+dtools/datastructures/__init__.py,sha256=6GNS6Y94Af0IeRhKdQlUoPsKK1BLfpeSa_wjxXjz4uw,1163
+dtools/datastructures/nodes.py,sha256=surkupETxZUAZeuhf8wM8BUWbP98trmqx5fczx32IU4,5695
+dtools/datastructures/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtools/datastructures/queues.py,sha256=30rBRKZRCwYLLog2SIFLxqb5RzMvTfxroZK_K2FOfoM,12119
+dtools/datastructures/tuples.py,sha256=88-e9Dpoeku8sYa3cmDFX17D80LiIb7lFHC2CGa6OnU,6583
+dtools/datastructures/splitends/__init__.py,sha256=y0BpPKBg6g9GtcHwhEhQTwnAIdpxvhVD09vE1AMPYPM,940
+dtools/datastructures/splitends/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtools/datastructures/splitends/se.py,sha256=Anm7fWa9A0hB6v6I3SVg-ZMm47J5LblAyyOV5gMnli8,5600
+dtools_datastructures-0.25.0.dist-info/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
+dtools_datastructures-0.25.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+dtools_datastructures-0.25.0.dist-info/METADATA,sha256=reT_ouL-PHBhasetsZDmhTrjrwqp6aXAvhMe2PA18f4,2625
+dtools_datastructures-0.25.0.dist-info/RECORD,,

dtools_datastructures-0.25.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