core-data-structures 1.2.0__tar.gz → 1.2.1__tar.gz

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-data-structures
-Version: 1.2.0
+Version: 1.2.1
 Summary: This project/library contains commons data structures...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -25,9 +25,10 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: core-mixins>=3.2.0
 Requires-Dist: typing-extensions>=4.8.0
 Provides-Extra: dev
-Requires-Dist: core-dev-tools>=2.0.0; extra == "dev"
+Requires-Dist: core-dev-tools>=2.1.0; extra == "dev"
 Requires-Dist: core-tests>=2.1.0; extra == "dev"
 Dynamic: license-file
 
@@ -39,6 +40,10 @@ with built-in traversal and path-finding algorithms.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-data-structures?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-data-structures
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-data-structures.svg
     :target: https://pypi.org/project/core-data-structures/
     :alt: Python Versions

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/README.rst

@@ -6,6 +6,10 @@ with built-in traversal and path-finding algorithms.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-data-structures?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-data-structures
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-data-structures.svg
     :target: https://pypi.org/project/core-data-structures/
     :alt: Python Versions

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/core_data_structures.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: core-data-structures
-Version: 1.2.0
+Version: 1.2.1
 Summary: This project/library contains commons data structures...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
@@ -25,9 +25,10 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: core-mixins>=3.2.0
 Requires-Dist: typing-extensions>=4.8.0
 Provides-Extra: dev
-Requires-Dist: core-dev-tools>=2.0.0; extra == "dev"
+Requires-Dist: core-dev-tools>=2.1.0; extra == "dev"
 Requires-Dist: core-tests>=2.1.0; extra == "dev"
 Dynamic: license-file
 
@@ -39,6 +40,10 @@ with built-in traversal and path-finding algorithms.
 
 ===============================================================================
 
+.. image:: https://static.pepy.tech/personalized-badge/core-data-structures?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
+    :target: https://pepy.tech/projects/core-data-structures
+    :alt: PyPI Downloads
+
 .. image:: https://img.shields.io/pypi/pyversions/core-data-structures.svg
     :target: https://pypi.org/project/core-data-structures/
     :alt: Python Versions

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/core_data_structures.egg-info/SOURCES.txt

@@ -8,10 +8,13 @@ core_data_structures.egg-info/dependency_links.txt
 core_data_structures.egg-info/requires.txt
 core_data_structures.egg-info/top_level.txt
 data_structures/__init__.py
+data_structures/base.py
 data_structures/py.typed
 data_structures/graphs/__init__.py
 data_structures/graphs/graphs.py
 data_structures/graphs/vertex.py
+data_structures/lists/__init__.py
+data_structures/lists/singly_linked_list.py
 data_structures/trees/__init__.py
 data_structures/trees/binary_tree.py
 data_structures/trees/simple_tree.py

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/core_data_structures.egg-info/requires.txt

@@ -1,5 +1,6 @@
+core-mixins>=3.2.0
 typing-extensions>=4.8.0
 
 [dev]
-core-dev-tools>=2.0.0
+core-dev-tools>=2.1.0
 core-tests>=2.1.0

core_data_structures-1.2.1/data_structures/base.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+"""Base node used as a building block across data structures."""
+
+from typing import Generic
+from typing import Optional
+from typing import TypeVar
+
+
+__all__ = [
+    "Node",
+    "T",
+]
+
+T = TypeVar("T")
+
+
+class Node(Generic[T]):  # pylint: disable=too-few-public-methods
+    """
+    Generic container for a single value, meant to be
+    subclassed by concrete node types.
+    """
+
+    def __init__(self, value: Optional[T] = None) -> None:
+        self._value = value
+
+    def __repr__(self):
+        return f"[{self._value}]"
+
+    @property
+    def value(self) -> Optional[T]:
+        """ The value held by the node. """
+        return self._value
+
+    @value.setter
+    def value(self, value: T) -> None:
+        self._value = value

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/data_structures/graphs/vertex.py

@@ -7,7 +7,7 @@ from typing import Dict, List
 
 if sys.version_info >= (3, 11):
     from typing import Self
-else:
+else:  # pragma: no cover
     from typing_extensions import Self
 
 

core_data_structures-1.2.1/data_structures/lists/singly_linked_list.py

@@ -0,0 +1,308 @@
+# -*- coding: utf-8 -*-
+
+"""
+A linked list is a linear data structure composed of a sequence
+of nodes where each node contains data and a pointer (or reference)
+to the next node. Unlike arrays, elements in a linked list are not
+stored in contiguous memory locations, meaning they can be scattered
+across your system's RAM.
+"""
+
+from contextlib import suppress
+from typing import Generic, Optional, Iterator
+from typing import cast
+
+from core_mixins.compatibility import Self
+
+from data_structures.base import Node as BaseNode
+from data_structures.base import T
+
+
+class Node(BaseNode[T]):
+    """
+    Node in a singly linked list, holding a value and a
+    reference to the next node.
+    """
+
+    def __init__(
+        self,
+        value: Optional[T] = None,
+        next_node: Optional[Self] = None,
+    ) -> None:
+        super().__init__(value=value)
+        self._next = next_node
+
+    @property
+    def next(self) -> Optional[Self]:
+        """The next node in the list, if any."""
+        return self._next
+
+    @next.setter
+    def next(self, next_node: Optional[Self]) -> None:
+        self._next = next_node
+
+
+class SinglyLinkedList(Generic[T]):
+    """
+    Singly linked list that tracks its head node and supports
+    forward iteration. Positions are 0-indexed.
+    """
+
+    def __init__(self, value: Optional[T] = None) -> None:
+        self._head: Optional[Node[T]] = None if value is None else Node(value)
+        self._length = 0 if value is None else 1
+        self._end = self._head
+
+    def __len__(self):
+        """Returns the length of the list."""
+        return self._length
+
+    def __getitem__(self, item: int) -> T:
+        """Returns the value at the given position."""
+        return self.get(item)
+
+    def __iter__(self) -> Iterator[T]:
+        """Iterates over the values in the list, starting from the head."""
+
+        pointer = self._head
+        while pointer:
+            yield cast(T, pointer.value)
+            pointer = pointer.next
+
+    def __contains__(self, item: T) -> bool:
+        with suppress(ValueError):
+            self.index(item)
+            return True
+        return False
+
+    @classmethod
+    def from_list(cls, a_list: list) -> Self:
+        """Creates the singly linked list from a python list."""
+
+        new_list = cls()
+        for value in a_list:
+            new_list.append(value)
+        return new_list
+
+    @property
+    def length(self) -> int:
+        """The number of nodes in the list."""
+        return self._length
+
+    @property
+    def is_empty(self) -> bool:
+        """Whether the list has no nodes."""
+        return self._head is None
+
+    @property
+    def head(self) -> Optional[Node[T]]:
+        """The first node in the list."""
+        return self._head
+
+    @property
+    def end(self) -> Optional[Node[T]]:
+        """The end node in the list."""
+        return self._end
+
+    def clear(self) -> None:
+        """Removes all nodes from the list."""
+        self._head = self._end = None
+        self._length = 0
+
+    def to_list(self) -> list:
+        """Materializes the list's values into a python list."""
+        return list(self)
+
+    def _node_at(self, pos: int) -> Node[T]:
+        """Returns the actual node at the given position."""
+
+        if pos < 0 or pos >= self._length:
+            raise IndexError("Invalid position!")
+
+        index, pointer = 0, cast(Node[T], self._head)
+        while index < pos:
+            pointer = cast(Node[T], pointer.next)
+            index += 1
+
+        return pointer
+
+    def get(self, pos: int) -> T:
+        """Returns the value at the given position."""
+        return cast(T, self._node_at(pos).value)
+
+    def index(self, value: T) -> int:
+        """Returns the position of the first occurrence of the given value."""
+
+        for pos, value_ in enumerate(self):
+            if value_ == value:
+                return pos
+
+        raise ValueError(f"{value!r} is not in list")
+
+    def prepend(self, value: T) -> None:
+        """Adds a value to the front of the list."""
+
+        if self._head is None:
+            self.append(value)
+
+        else:
+            self._head = Node(value, next_node=self._head)
+            self._length += 1
+
+    def append(self, value: T) -> None:
+        """Adds a value to the end of the list."""
+
+        new_node = Node(value)
+
+        if self._end is None:
+            self._head = new_node
+        else:
+            self._end.next = new_node
+
+        self._end = new_node
+        self._length += 1
+
+    def insert(self, value: T, pos: int) -> None:
+        """Inserts a value at the given position."""
+
+        if pos == 0:
+            self.prepend(value)
+
+        elif pos == self._length:
+            self.append(value)
+
+        else:
+            pointer = self._node_at(pos - 1)
+            pointer.next = Node(value, next_node=pointer.next)
+            self._length += 1
+
+    def extend(self, a_list: Self) -> None:
+        """Appends a copy of each value from another list."""
+
+        for value in a_list:
+            self.append(value)
+
+    def pop_front(self) -> T:
+        """Removes and return the value at the front of the list."""
+
+        if self.is_empty:
+            raise IndexError("Empty list!")
+
+        head = cast(Node[T], self._head)
+        value = cast(T, head.value)
+
+        if self._length == 1:
+            self._head = None
+            self._end = None
+        else:
+            self._head = head.next
+
+        self._length -= 1
+        return value
+
+    def pop_back(self) -> T:
+        """Removes and returns the value at the end of the list."""
+
+        if self.is_empty:
+            raise IndexError("Empty list!")
+
+        value = cast(T, cast(Node[T], self._end).value)
+        if self._length == 1:
+            self.clear()
+            return value
+
+        pointer = cast(Node[T], self._head)
+        while pointer.next is not self._end:
+            pointer = cast(Node[T], pointer.next)
+
+        pointer.next = None
+        self._end = pointer
+        self._length -= 1
+        return value
+
+    def pop(self, index: int) -> T:
+        """Removes and returns the value at the given position."""
+
+        if index < 0 or index >= self._length:
+            raise IndexError("Index error!")
+
+        if index == 0:
+            return self.pop_front()
+
+        if index == self._length - 1:
+            return self.pop_back()
+
+        pointer = self._node_at(index - 1)
+        removed = cast(Node[T], pointer.next)
+        pointer.next = removed.next
+        self._length -= 1
+        return cast(T, removed.value)
+
+    def remove(self, value: T, all_values: bool = False) -> None:
+        """Removes the first occurrence of the value, or all occurrences if `all_values` is set."""
+
+        was_found = False
+
+        while self._head is not None and self._head.value == value:
+            self._head = self._head.next
+            self._length -= 1
+            was_found = True
+
+            if self._head is None:
+                self._end = None
+
+            if not all_values:
+                return
+
+        if self._head is not None:
+            left = self._head
+            right = left.next
+
+            while right:
+                if right.value == value:
+                    left.next = right.next
+                    self._length -= 1
+                    was_found = True
+
+                    if right is self._end:
+                        self._end = left
+
+                    right = left.next
+
+                    if not all_values:
+                        return
+
+                else:
+                    left = right
+                    right = right.next
+
+        if not was_found:
+            raise ValueError(f"{value!r} is not in list")
+
+    def reverse(self) -> None:
+        """Reverses the list in place."""
+
+        if self.is_empty or self._length == 1:
+            return
+
+        if self._length == 2:
+            head, end = cast(Node[T], self._head), cast(Node[T], self._end)
+            self._head, self._end = end, head
+            self._head.next = self._end
+            self._end.next = None
+            return
+
+        new_end = left = cast(Node[T], self._head)
+        new_head = cast(Node[T], new_end.next)
+        right = new_head.next
+
+        while new_head is not self._end:
+            new_head.next = left
+            left = new_head
+            new_head = cast(Node[T], right)
+            right = new_head.next
+
+        new_head.next = left
+        new_end.next = None
+        self._end = new_end
+        self._head = new_head

{core_data_structures-1.2.0 → core_data_structures-1.2.1}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "core-data-structures"
 description = "This project/library contains commons data structures..."
-version = "1.2.0"
+version = "1.2.1"
 
 authors = [
     {name = "Alejandro Cora González", email = "alek.cora.glez@gmail.com"}
@@ -40,12 +40,13 @@ classifiers = [
 ]
 
 dependencies = [
+    "core-mixins>=3.2.0",
     "typing-extensions>=4.8.0",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "core-dev-tools>=2.0.0",
+    "core-dev-tools>=2.1.0",
     "core-tests>=2.1.0",
 ]