Drop custom ordered set in favor of orderedsets

Author: inducer

pyproject.toml

@@ -36,6 +36,7 @@ dependencies = [
     "pytools>=2024.1",
     "pymbolic>=2024.2",
     "sympy>=0.7.2",
+    "orderedsets",
 ]
 
 [dependency-groups]

sumpy/cse.py

@@ -318,7 +318,7 @@ def match_common_args(func_class, funcs, opt_subs):
 
     changed = set()
 
-    from sumpy.tools import OrderedSet
+    from orderedsets import OrderedSet
 
     for i in range(len(funcs)):
         common_arg_candidates_counts = arg_tracker.get_common_arg_candidates(
@@ -331,7 +331,7 @@ def match_common_args(func_class, funcs, opt_subs):
                 key=lambda k: (common_arg_candidates_counts[k], k)))
 
         while common_arg_candidates:
-            j = common_arg_candidates.pop(last=False)
+            j = common_arg_candidates.pop()
 
             com_args = arg_tracker.func_to_argset[i].intersection(
                     arg_tracker.func_to_argset[j])
@@ -391,7 +391,7 @@ def opt_cse(exprs: Sequence[sym.Basic]) -> dict[sym.Basic, sym.Basic | Unevaluat
     """
     opt_subs: dict[sym.Basic, sym.Basic | Unevaluated] = {}
 
-    from sumpy.tools import OrderedSet
+    from orderedsets import OrderedSet
     adds: OrderedSet[sym.Add] = OrderedSet()
     muls: OrderedSet[sym.Mul] = OrderedSet()
 

sumpy/tools.py

@@ -31,17 +31,16 @@
 import logging
 import warnings
 from abc import ABC, abstractmethod
-from collections.abc import Hashable, Iterable, Iterator, Sequence, Set as AbstractSet
+from collections.abc import Hashable, Sequence, Set as AbstractSet
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, TypeAlias, cast
 
 import numpy as np
-from typing_extensions import override
 
 import loopy as lp
 from pymbolic.mapper.dependency import DependencyMapper
 from pyopencl.characterize import get_pocl_version
-from pytools import T, memoize_method
+from pytools import memoize_method
 from pytools.tag import Tag, tag_dataclass
 
 import sumpy.symbolic as sym
@@ -71,7 +70,6 @@
 
 .. autofunction:: to_complex_dtype
 .. autofunction:: is_obj_array_like
-.. autoclass:: OrderedSet
 
 Multi-index Helpers
 -------------------
@@ -368,94 +366,6 @@ def get_kernel(self) -> lp.TranslationUnit:
 # }}}
 
 
-# {{{ OrderedSet
-
-# Source: https://code.activestate.com/recipes/576694-orderedset/
-# Author: Raymond Hettinger
-# License: MIT
-
-from collections.abc import MutableSet
-
-
-Link: TypeAlias = "list[Any]"
-
-
-class OrderedSet(MutableSet[T]):
-    end: Link
-    map: dict[T, Link]
-
-    def __init__(self, iterable: Iterable[T] | None = None) -> None:
-        self.end = end = []
-        end += [None, end, end]         # sentinel node for doubly linked list
-        self.map = {}                   # key --> [key, prev, next]
-
-        if iterable is not None:
-            self |= iterable
-
-    @override
-    def __len__(self) -> int:
-        return len(self.map)
-
-    @override
-    def __contains__(self, key: object) -> bool:
-        return key in self.map
-
-    @override
-    def add(self, value: T) -> None:
-        if value not in self.map:
-            end = self.end
-            curr = end[1]
-            curr[2] = end[1] = self.map[value] = [value, curr, end]
-
-    @override
-    def discard(self, value: T) -> None:
-        if value in self.map:
-            _key, prev, next = self.map.pop(value)
-            prev[2] = next
-            next[1] = prev
-
-    @override
-    def __iter__(self) -> Iterator[T]:
-        end = self.end
-        curr = end[2]
-        while curr is not end:
-            yield curr[0]
-            curr = curr[2]
-
-    def __reversed__(self) -> Iterator[T]:
-        end = self.end
-        curr = end[1]
-        while curr is not end:
-            yield curr[0]
-            curr = curr[1]
-
-    @override
-    def pop(self, last: bool = True) -> T:
-        if not self:
-            raise KeyError("set is empty")
-
-        key = self.end[1][0] if last else self.end[2][0]
-        self.discard(key)
-
-        return key
-
-    @override
-    def __repr__(self) -> str:
-        if not self:
-            return f"{self.__class__.__name__}()"
-
-        return f"{self.__class__.__name__}({list(self)!r})"
-
-    @override
-    def __eq__(self, other: object) -> bool:
-        if isinstance(other, OrderedSet):
-            return len(self) == len(other) and list(self) == list(other)
-
-        return set(self) == set(other)
-
-# }}}
-
-
 class KernelCacheMixin(ABC):
     name: str