freeflux.core.emu
=================

.. py:module:: freeflux.core.emu

.. autoapi-nested-parse::

   Define the EMU class.



Attributes
----------

.. autoapisummary::

   freeflux.core.emu.__author__


Classes
-------

.. autoapisummary::

   freeflux.core.emu.EMU


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

.. py:data:: __author__
   :value: 'Chao Wu'


.. py:class:: EMU(id, metabolite, atom_nos)

   Define EMU (i.e., elementary metabolite unit) object and its operations.

   EMUs in the same metabolite and with the same atom NOs are considered as identical,
   while metabolites which they derived from could be different.

   EMUs can be compared based self.metabolite_id and self.atom_nos.
   EMU and iterable object of EMUs can also be compared. In this case EMU will be put into
   the same iterable object with single item, and comparison between two iterables are performed.

   Currently only binary equivalents are considered.

   :param id: EMU ID
   :type id: str
   :param metabolite: Which metabolite the EMU comes from.
   :type metabolite: Metabolite or str
   :param atom_nos: Atom NOs, sorted by number.
   :type atom_nos: list of int or str

   .. attribute:: id

      EMU ID

      :type: str

   .. attribute:: metabolite

      Which metabolite the EMU comes from.

      :type: Metabolite

   .. attribute:: metabolite_id

      Metabolite ID.

      :type: str

   .. attribute:: atom_nos

      Atom NOs, sorted by number.

      :type: list of int

   .. attribute:: size

      Size of EMU.

      :type: int

   .. attribute:: equivalent_atom_nos

      Equivalent atom NOs, sorted by number.

      :type: None or list of int

   .. attribute:: equivalent

      Equivalent of EMU.

      :type: EMU


   .. py:attribute:: id


   .. py:attribute:: size


   .. py:method:: __hash__()


   .. py:method:: __eq__(other)

      :param other:
      :type other: EMU or iterable



   .. py:method:: __lt__(other)

      :param other:
      :type other: EMU or iterable



   .. py:method:: __gt__(other)

      :param other:
      :type other: EMU or iterable



   .. py:property:: equivalent_atom_nos

      returns: **equivAtomNOs** -- Equivalent atom NOs, sorted by number.
      :rtype: list of int or None


   .. py:property:: equivalent

      returns: **EMU** -- Equivalent of current EMU.
      :rtype: EMU


   .. py:method:: __repr__()