symmray.index_common
====================

.. py:module:: symmray.index_common

.. autoapi-nested-parse::

   General interface for index objects.



Classes
-------

.. autoapisummary::

   symmray.index_common.Index
   symmray.index_common.SubInfo


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

.. py:class:: Index

   .. py:property:: dual
      :type: bool


      Whether the index flows 'outwards' / (+ve) / ket-like = ``False`` or
      'inwards' / (-ve) / bra-like= ``True``. The charge sign is given by
      ``(-1) ** dual``.


   .. py:property:: subinfo
      :type: SubInfo


      Information about the subindices of this index and their extents if
      this index was formed from fusing.


.. py:class:: SubInfo

   .. py:property:: indices
      :type: tuple[Index, Ellipsis]


      The indices that were fused to make this index.