Update: rename

Author: heptaflar

kaleidoscope/generators.py

@@ -58,7 +58,7 @@ def __init__(self, seed: int | np.ndarray | BitGenerator | None = None):
         self._g = default_generator(seed)
 
     @overrides
-    def random(self) -> int:
+    def next_int64(self) -> int:
         return self._g.integers(0x8000000000000000)
 
 
@@ -80,13 +80,13 @@ def get(self, i: int) -> Univariate:
         return self
 
     @overrides
-    def random(self) -> float:
+    def next_double(self) -> float:
         return self._g.random()
 
     @overrides
-    def randoms(self, randoms: np.ndarray) -> np.ndarray:
-        self._g.random(out=randoms)
-        return randoms
+    def next_doubles(self, doubles: np.ndarray) -> np.ndarray:
+        self._g.random(out=doubles)
+        return doubles
 
 
 class DefaultNormal(Normal):
@@ -107,10 +107,10 @@ def get(self, i: int) -> Univariate:
         return self
 
     @overrides
-    def random(self) -> float:
+    def next_double(self) -> float:
         return self._g.standard_normal()
 
     @overrides
-    def randoms(self, randoms: np.ndarray) -> np.ndarray:
-        self._g.standard_normal(out=randoms)
-        return randoms
+    def next_doubles(self, doubles: np.ndarray) -> np.ndarray:
+        self._g.standard_normal(out=doubles)
+        return doubles

kaleidoscope/interface/generating.py

@@ -15,12 +15,12 @@ class Generating(ABC):
     """Random number generating interface."""
 
     @abstractmethod
-    def random(self) -> int:
+    def next_int64(self) -> int:
         """
         Returns a new integer random number.
 
         Generated random numbers are uniformly distributed in the
-        interval [0, 9223372036854775808).
+        interval [0, 9223372036854775807].
 
         :return: The new integer random number.
         """
@@ -30,19 +30,19 @@ class Univariate(ABC):
     """Univariate random deviates."""
 
     @abstractmethod
-    def random(self) -> float:
+    def next_double(self) -> float:
         """
         Returns a new random number.
 
         :return: The new random number.
         """
 
     @abstractmethod
-    def randoms(self, randoms: np.ndarray) -> np.ndarray:
+    def next_doubles(self, doubles: np.ndarray) -> np.ndarray:
         """
         Returns a sequence of newly generated random numbers.
 
-        :param randoms: To store the sequence.
+        :param doubles: To store the sequence.
         :return: The sequence of newly generated random numbers.
         """
 

test/kaleidoscope/test_generators.py

@@ -14,12 +14,12 @@ class DefaultGeneratorTest(unittest.TestCase):
 
     def test_random(self):
         rng = DefaultGenerator(42)
-        self.assertEqual(6164909031098000398, rng.random())
-        self.assertEqual(62765134502071353, rng.random())
-        self.assertEqual(6068961337446000720, rng.random())
-        self.assertEqual(3424215743300924766, rng.random())
-        self.assertEqual(1906168894638979906, rng.random())
-        self.assertEqual(1787925334117997081, rng.random())
+        self.assertEqual(6164909031098000398, rng.next_int64())
+        self.assertEqual(62765134502071353, rng.next_int64())
+        self.assertEqual(6068961337446000720, rng.next_int64())
+        self.assertEqual(3424215743300924766, rng.next_int64())
+        self.assertEqual(1906168894638979906, rng.next_int64())
+        self.assertEqual(1787925334117997081, rng.next_int64())
 
 
 if __name__ == "__main__":