.. include:: ../substitutions

.. oe:namespace:: OEChem

.. meta::
   :keywords: OESymmetryNumber

.. oe:function:: OESymmetryNumber

   .. oe:language:: c++ java csharp

      .. oe:api::

         unsigned OESymmetryNumber(const OEMolBase& mol, bool useH = true,
                                   double threshold = 0.05)
         bool OESymmetryNumber(const OEMCMolBase& mol, unsigned* symCtArray,
                               bool useH = true, double threshold = 0.05)

   .. oe:language:: python

      .. oe:api:: python

         OESymmetryNumber(mol: Union[OEGraphMol,OEMol,OEQMol],
                          useH: bool = True, threshold: float = 0.05) -> int
         OESymmetryNumber(mol: OEMol, symCtArray: int, useH: bool = True,
                          threshold: float = 0.05) -> bool


   Calculates the symmetry number of the molecule.
   For the overload with :ref:`OEMolBase <OEChem_OEMolBase>` as input molecule,
   the symmetry number is the return value.  For the 
   :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` overload, the symmetry 
   numbers are returned in the `symCtdArray` array.  The `symCtArray` passed to this
   function should be of length ``fit.GetMaxConfIdx()``.  The `useH`
   flag indicates whether symmetry calculation should use the hydrogen atoms
   of the molecule or ignore them.  Root mean squared deviation between 
   conformations are performed internally and accepted as identical based on the
   specified `threshold`. For the :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` 
   overload the return value is ``True`` if calculation completes successfully,
   and ``False`` otherwise.

   *mol*
      The molecule to calculate symmetry number.

   *useH*
      Flag indicating if hydrogen atoms should be considered explicitly.

   *threshold*
      Threshold for root mean squared deviation (RMSD) comparison.

   *symCtArray*
      Array containing calculated symmetry numbers in a multi-conformer input molecule.



