iter_utils
==========

.. py:module:: iter_utils


Functions
---------

.. autoapisummary::

   iter_utils.all_equal
   iter_utils.flatten
   iter_utils.symmetrical_iter


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

.. py:function:: all_equal(iterable)

   Check if all elements in an iterable are equal.

   :param iterable: The iterable to check.
   :type iterable: iterable

   :returns: True if all elements are equal, False otherwise.
   :rtype: bool


.. py:function:: flatten(lst)

   Flatten a nested list.

   :param lst: The list to flatten.
   :type lst: list

   :returns: The flattened list.
   :rtype: list


.. py:function:: symmetrical_iter(lst)

   Iterate over an iterable from both ends simultaneously.

   :param lst: The iterable to iterate over.
   :type lst: iterable