xorshift 1.0.0__tar.gz

xorshift-1.0.0/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.3
+Name: xorshift
+Version: 1.0.0
+Summary: Random values library using `XorShift128+` under the hood.
+Author: Xenely
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+

xorshift-1.0.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "xorshift"
+version = "1.0.0"
+description = "Random values library using `XorShift128+` under the hood."
+authors = [
+    {name = "Xenely"}
+]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+
+[project.scripts]
+xorshift = "xorshift:main"
+
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"

xorshift-1.0.0/src/xorshift/__init__.py

@@ -0,0 +1,104 @@
+import time
+import typing
+
+
+class Xorshift:
+    """Class of random vairables generator, uses `xorshift` alghoritm for random."""
+
+    # ==-----------------------------------------------------------------------------== #
+    # Public methods                                                                    #
+    # ==-----------------------------------------------------------------------------== #
+    def __init__(self, seed: int | None = None):
+        """Creates instance to generate random values, collections."""
+
+        # Save of initial state
+        state = int(seed if seed is not None else time.time() * 1_000) & 0xFFFFFFFFFFFFFFFF
+
+        # Split state into two parts
+        self.state = [
+            state ^ 0xA5A5A5A5A5A5A5A5,
+            (state >> 1) ^ 0x5555555555555555 ^ 0x14057B7EF767814F
+        ]
+
+        # If state values is null
+        if not self.state[0] and not self.state[1]:
+            self.state = [1, 0x14057B7EF767814F]
+
+    def randint(self, start: int, end: int) -> int:
+        """Gets random integer value from [start, end] range."""
+
+        # If start less than end
+        if start > end:
+            start, end = end, start
+
+        # Random value generation
+        if (offset := self.__get_next() % (span := end - start + 1)) < 0:
+            offset += span
+
+        # Return generated random integer value
+        return start + offset
+
+    def randfloat(self, start: float, end: float) -> float:
+        """Gets random float value from [start, end) range."""
+
+        # Start and end of range to generate random values
+        start = min(start, end)
+        end = max(start, end)
+
+        # Generate and return random float value
+        return start + (end - start) * ((self.__get_next() >> 11) / ((1 << 53) - 1.0))
+
+    def sample(self, values: list[typing.Any], n: int | None = None) -> list[typing.Any]:
+        """Gets `N` random values from source list and creates new one. If `N` is `None` samples the whole list."""
+
+        # Get min-max avaiable `N` value
+        n = max(0, min(len(values), n if n is not None else len(values)))
+
+        # If sampling is not required
+        if not n:
+            return list()
+
+        # Result list
+        result = values[:]
+
+        # Sample list values
+        for index in range(len(values) - 1, len(values) - n - 1, -1):
+
+            # Get random value
+            random_value = self.__get_next() % (index + 1)
+
+            # Shuffle values
+            result[index], result[random_value] = result[random_value], result[index]
+
+        # Return `N` last values in sampled list
+        return result[-n:]
+
+    def choice(self, values: typing.Iterable[typing.Any]) -> typing.Any:
+        """Chooses random value from collection."""
+
+        # If collection is empty
+        if not values:
+            raise Exception("Collection is empty, unable to chose random value")
+
+        # Get and return random collection value
+        return values[self.randint(0, len(values) - 1)]
+
+    # ==-----------------------------------------------------------------------------== #
+    # Private methods                                                                   #
+    # ==-----------------------------------------------------------------------------== #
+    def __get_next(self) -> int:
+        """Генерирует следующее псеводо-случайное число."""
+
+        # Извлечение текущего состояния
+        state_0, state_1 = self.state
+
+        # Генерация случайного числа
+        result = (state_0 + state_1) & 0xFFFFFFFFFFFFFFFF
+
+        # Обновление состояния
+        state_1 ^= state_0
+        self.state[0] = ((state_0 << 24) | (state_0 >> 40)) ^ state_1 ^ (state_1 << 16)
+        self.state[1] = (state_1 << 37) | (state_1 >> 27)
+
+        # Возврат результата
+        return result