irsim.util.random
=================

.. py:module:: irsim.util.random


Attributes
----------

.. autoapisummary::

   irsim.util.random.rng


Functions
---------

.. autoapisummary::

   irsim.util.random.set_seed
   irsim.util.random.random_uniform


Module Contents
---------------

.. py:data:: rng

.. py:function:: set_seed(seed: int | None = None) -> None

.. py:function:: random_uniform(low=None, high=None, size=(3, 1), min_distance=1.0)

   Sample random points uniformly with a pairwise min-distance constraint.

   :param low: Lower bound as a 3D vector (x, y, theta).
               Default is [0.5, 0.5, 0.0].
   :type low: list | np.ndarray
   :param high: Upper bound as a 3D vector (x, y, theta).
                Default is [9.5, 9.5, 6.28].
   :type high: list | np.ndarray
   :param size: (dim, n) where dim is 2 or 3 and n is the number of
                points to sample. When dim == 2, only x and y are sampled and
                theta is set to 0. Default is (3, 1).
   :type size: tuple
   :param min_distance: Minimum pairwise distance in the xy plane.
                        Default is 1.0.
   :type min_distance: float

   :returns: Random points of shape (3, n).
   :rtype: np.ndarray