.. include:: ../substitutions

.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomIsInAromaticRingSize

.. oe:function:: OEAtomIsInAromaticRingSize

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

      .. oe:api::

         bool OEAtomIsInAromaticRingSize(const OEAtomBase& atm,
                                         unsigned int size)
         bool OEAtomIsInAromaticRingSize(const OEAtomBase* atm,
                                         unsigned int size)

   .. oe:language:: python

      .. oe:api:: python

         OEAtomIsInAromaticRingSize(atm: OEAtomBase, size: int) -> bool

   Determines whether the given atom is in an aromatic cycle of the
   specified size.
   If the atom is not aromatic, *i.e.*
   :oe:meth:`OEChem::OEAtomBase::IsAromatic` returns ``false``, then this
   function also returns ``false``.

   .. warning::

      It is necessary to call :oe:func:`OEChem::OEFindRingAtomsAndBonds` and
      :oe:func:`OEChem::OEAssignAromaticFlags` functions prior to calling
      calling :oe:func:`OEChem::OEAtomIsInAromaticRingSize` function.

   .. seealso::

      * :ref:`chapter_ring` chapter

