hikari.symmetry.hall
====================

.. py:module:: hikari.symmetry.hall


Classes
-------

.. autoapisummary::

   hikari.symmetry.hall.HallSymbol


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

.. py:class:: HallSymbol(hall_symbol)

   Parse, interpret, and convert Hall symbol to `hikari.symmetry.Group`


   .. py:exception:: HallSymbolException

      Bases: :py:obj:`Exception`


      Exception raised when group can't be generated from the symbol



   .. py:attribute:: REGEX

      This is a regex which matches every possible lowercase Hall symbol for
      classical 3D space groups. It matches up to 17 groups in total as follows:

      1. Centrosymmetry: `[-]?`
      2. Lattice symbol: `[pabcirstf]` (required)
      3. Generator 1 inversion component: `[-]?`
      4. Generator 1 rotation fold: `\d` (required)
      5. Generator 1 rotation direction: `[*xyz]?`
      6. Generator 1 translation components: `[12345abcnuvwd]*`
      7. Generator 2 inversion component: `[-]?`
      8. Generator 2 rotation fold: `\d`
      9. Generator 2 rotation direction: `['"xyz]?`
      10. Generator 2 translation components: `[12345abcnuvwd]*`
      11. Generator 3 inversion component: `[-]?`
      12. Generator 3 rotation fold: `\d`
      13. Generator 3 translation components: `[12345abcnuvwd]*`
      14. Generator 4 rotation fold: `\d`
      15. Generator 4 translation components: `[12345abcnuvwd]*`
      16. Origin shift constituent 1 expressed as count of 1/12 shifts: `\d`
      17. Origin shift constituent 2 expressed as count of 1/12 shifts: `\d`
      18. Origin shift constituent 3 expressed as count of 1/12 shifts: `\d`


   .. py:attribute:: DIRECTION_SYMBOLS
      :value: ("'", '"', '*')



   .. py:attribute:: TRANSLATION_SYMBOLS
      :value: '12345abcnuvwd'



   .. py:attribute:: LATTICE_GENERATORS


   .. py:attribute:: UNIVERSAL_MATRICES


   .. py:attribute:: PRINCIPAL_ROTATIONS


   .. py:attribute:: FACE_X_DIAGONAL_ROTATIONS


   .. py:attribute:: FACE_Y_DIAGONAL_ROTATIONS


   .. py:attribute:: FACE_Z_DIAGONAL_ROTATIONS


   .. py:attribute:: BODY_DIAGONAL_ROTATIONS


   .. py:attribute:: STATIC_TRANSLATIONS


   .. py:attribute:: DYNAMIC_TRANSLATIONS


   .. py:property:: symbol
      :type: str



   .. py:property:: elements
      :type: Union[None, Match]


      Return `self.symbol` elements indexed as in `self.HALL_REGEX` doc


   .. py:property:: generators
      :type: List[hikari.symmetry.operations.BoundedOperation]