:py:mod:`kosmos.utils.rng`
==========================

.. py:module:: kosmos.utils.rng







Classes
-------

.. py:class:: RNG


   Random number generator manager.





   |

   .. rubric:: Methods

   .. py:method:: initialize(seed: int = 1) -> None

      Set global RNG seed for reproducibility.

      :param seed: Random number generator seed. Defaults to 1.
      :type seed: int


   .. py:method:: is_initialized() -> bool

      Check whether a global RNG seed has been set (via RNG.initialize(...)).

      :returns: True if RNG.initialize(...) has been called, else False.
      :rtype: bool


   .. py:method:: get_seed() -> int | None

      Get the RNG seed used for initialization.

      :returns: The RNG seed.
      :rtype: int | None


   .. py:method:: np_generator() -> numpy.random.Generator

      NumPy generator initialized with the RNG seed.

      :returns: The NumPy generator instance.
      :rtype: np.random.Generator