piel.models.logic.photonic.switch_lattice
=========================================

.. py:module:: piel.models.logic.photonic.switch_lattice


Functions
---------

.. autoapisummary::

   piel.models.logic.photonic.switch_lattice.compose_switch_position_list


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

.. py:function:: compose_switch_position_list(network: numpy.array, gap_elements: list = None, cross_elements: list = None, *args, **kwargs)

   This function returns a list of the switch positions in the network, the corresponding instance, and the 2D position in the network.

   :param network: The network array.
   :type network: np.array
   :param gap_elements: The gap elements in the network. Defaults to None.
   :type gap_elements: list, optional
   :param cross_elements: The cross elements in the network. Defaults to None.
   :type cross_elements: list, optional

   :returns: A list of tuples of the form (switch_instance, (row, col)).
   :rtype: switch_position_list (list)