sequince.utils.bounds
=====================

.. py:module:: sequince.utils.bounds


Functions
---------

.. autoapisummary::

   sequince.utils.bounds.in_bounds


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

.. py:function:: in_bounds(particles, bounds, xp = None)

   Check if particles are within the specified bounds.

   Bounds are assumed to be rectilinear, with shape (2, n_dimensions).


   :param particles: Array of shape (n_particles, n_dimensions) representing the particles.
   :param bounds: Array of shape (2, n_dimensions) where bounds[0] are the lower bounds
                  and bounds[1] are the upper bounds for each dimension.

   :returns: Boolean array of shape (n_particles,) indicating whether each particle
             is within bounds.
   :rtype: Array