pythonic-fp.splitends 0.30.0__py3-none-any.whl

pythonic_fp/splitends/__init__.py

@@ -0,0 +1,23 @@
+# Copyright 2024-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.
+
+"""Pythonic FP - Splitends
+
+Package implementing a singularly linked LIFO queue called a SplitEnd. These
+data structures can safely share data nodes between themselves.
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp/splitends/splitend.py

@@ -0,0 +1,133 @@
+# 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.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Hashable, Iterator
+from typing import Never, TypeVar
+from pythonic_fp.containers.maybe import MayBe as MB
+from .splitend_node import SENode as Node
+
+__all__ = ['SplitEnd']
+
+D = TypeVar('D', bound=Hashable)
+T = TypeVar('T')
+
+
+class SplitEnd[D]:
+    """LIFO stacks which can safely share immutable data between themselves.
+
+    - each SplitEnd is a very simple stateful (mutable) LIFO stack
+    - data can be pushed and popped to the stack
+    - the first value pushed onto the SplitEnd becomes it "root"
+    - 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 the "root"
+    """
+    __slots__ = '_count', '_top', '_root'
+
+    def __init__(self, root_data: D, *ds: D) -> None:
+        node = Node(root_data, MB[Node[D]]())
+        self._root = MB(node)
+        self._top, self._count = self._root, 1
+        for d in ds:
+            node = Node(d, self._top)
+            self._top, self._count = MB(node), self._count + 1
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(self._top.get())
+
+    def __reversed__(self) -> Iterator[D]:
+        return reversed(list(self))
+
+    def __bool__(self) -> bool:
+        # Returns true until all data is exhausted
+        return bool(self._top.get())
+
+    def __len__(self) -> int:
+        return self._count
+
+    def __repr__(self) -> str:
+        return 'SplitEend(' + ', '.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._root != other._root:
+            return False
+
+        left = self._top.get()
+        right = other._top.get()
+        for _ in range(self._count):
+            if left is right:
+                return True
+            if left.peak() != right.peak():
+                return False
+            if left:
+                left = left._prev.get()
+                right = right._prev.get()
+        return True
+
+    def push(self, *ds: D) -> None:
+        """Push data onto the top of the SplitEnd."""
+        for d in ds:
+            node = Node(d, self._top)
+            self._top, self._count = MB(node), self._count + 1
+
+    def pop(self) -> D | Never:
+        """Pop data off of the top of the SplitEnd.
+        Re-root SplitEnd if root is popped off.
+        """
+        data, self._top, self._count = self._top.get().pop2() + (self._count - 1,)
+        if self._count == 0:
+            self._count, self._top = 1, self._root
+        return data
+
+    def peak(self) -> D:
+        """Return the data at the top of the SplitEnd, doesn't consume it."""
+        return self._top.get().peak()
+
+    def copy(self) -> SplitEnd[D]:
+        """Return a copy of the SplitEnd.
+
+        - O(1) space & time complexity.
+        - returns a new instance with same data, including the root
+        """
+        se: SplitEnd[D] = SplitEnd(self._root.get().peak())
+        se._count, se._top, se._root = self._count, self._top, self._root
+        return se
+
+    def fold[T](self, f: Callable[[T, D], T], init: T | None = None, /) -> T | Never:
+        """Reduce with a function, fold in natural LIFO Order."""
+        if self._top:
+            return self._top.get().fold(f, init)
+        if init is not None:
+            return init
+        msg = 'SE: Folding empty SplitEnd but no initial value supplied'
+        raise ValueError(msg)

pythonic_fp/splitends/splitend_node.py

@@ -0,0 +1,112 @@
+# 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.
+
+"""Data node class used privately by class SplitEnd.
+
+Node classes used with graph-like data structures. API designed to be used by
+other data structures which contain these data structures.
+"""
+
+from __future__ import annotations
+from collections.abc import Callable, Hashable, Iterator
+from typing import cast, TypeVar
+from pythonic_fp.containers.maybe import MayBe as MB
+
+__all__ = ['SENode']
+
+D = TypeVar('D', bound=Hashable)
+T = TypeVar('T')
+
+
+class SENode[D]:
+    """Data node for class SplitEnd
+
+    - hashable data node for a end-to-root singularly linked list.
+    - designed so multiple splitends can safely share the same data
+    - this type of node always
+
+      - contain data
+      - potential link to previous node
+
+    - nodes point towards a unique "bottom node" with no predecessor
+
+      - in a Boolean context returns true if not at the bottom
+      - multiple bottom nodes can exist
+
+    - 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 proceeding node
+
+      - forming bush like graphs
+    """
+
+    __slots__ = '_data', '_prev'
+
+    def __init__(self, data: D, prev: MB[SENode[D]] = MB()) -> None:
+        self._data: D = data
+        self._prev: MB[SENode[D]] = 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 __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._prev != other._prev:
+            return False
+        if self._data == other._data:
+            return True
+        return False
+
+    def peak(self) -> D:
+        """Return contained data"""
+        return self._data
+
+    def pop2(self) -> tuple[D, MB[SENode[D]]]:
+        """Return the data at the *end* and potential *tail*."""
+        return self._data, self._prev
+
+    def push(self, data: D) -> SENode[D]:
+        """Push data onto the queue and return a new node containing the data."""
+        return SENode(data, MB(self))
+
+    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

pythonic_fp_splitends-0.30.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: pythonic-fp.splitends
+Version: 0.30.0
+Summary: Pythonic FP - Splitends
+Keywords: SplitEnd,lifo,stack
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+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
+License-File: LICENSE
+Requires-Dist: pythonic-fp.containers >=2.0.0
+Project-URL: Changelog, https://grscheller.github.io/pythonic-fp-splitends/html/changelog.html
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-splitends/html/
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-splitends
+
+# Pythonic FP - SplitEnds
+
+PyPI project
+[pythonic-fp.splitends](https://pypi.org/project/pythonic-fp.splitends/)
+implementing a singularly linked data structures allowing data to be
+safely shared between multiple instances.
+
+- Singularly link stack with shareable data nodes
+  - *module* `pythonic_fp.splitends.splitend`
+  - *class* `SplitEnd`
+
+- Shareable nodes used by SplitEnd instances
+  - *module* `pythonic_fp.splitends.splitend_node`
+  - *class* `SENode`
+    - shareable nodes used by SplitEnd instances
+      - this class is designed to be inaccessible to client code
+
+This PyPI project is part of of the grscheller
+[pythonic-fp namespace projects](https://github.com/grscheller/pythonic-fp/blob/main/README.md).
+
+**Warning:** This PyPI project is Alpha level software and subject to
+change. It will probably remain Alpha for quite a while.
+
+## Documentation
+
+Documentation hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp-splitends/html).
+
+## Copyright and License
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_splitends-0.30.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pythonic_fp/splitends/__init__.py,sha256=hAswthv0JMpJlJqid_hwgIO1OEYRqGSRKcACKBdvmUw,898
+pythonic_fp/splitends/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/splitends/splitend.py,sha256=C4Zw_s02oAo9ivItinbeavJWFSuyWRx8QdLxa9MQAe0,4608
+pythonic_fp/splitends/splitend_node.py,sha256=T0bAGMY4dL8Vv5w5z6BYX6pUrNQhXHaLVZo2XTtmvFI,3362
+pythonic_fp_splitends-0.30.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_splitends-0.30.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_splitends-0.30.0.dist-info/METADATA,sha256=nYdAplEfe5m2LH5X2Yc1fOIZ3lPijnVa-jbfzjJ4vUs,2091
+pythonic_fp_splitends-0.30.0.dist-info/RECORD,,

pythonic_fp_splitends-0.30.0.dist-info/WHEEL

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

pythonic_fp_splitends-0.30.0.dist-info/licenses/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-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.