.. include:: ../substitutions

.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardNucleicAcidResidue

.. oe:function:: OEIsStandardNucleicAcidResidue

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

      .. oe:api::

         bool OEIsStandardNucleicAcidResidue(const OEHierResidue& res)
         bool OEIsStandardNucleicAcidResidue(const OEChem::OEResidue& res)
         bool OEIsStandardNucleicAcidResidue(unsigned int resIdx)
         bool OEIsStandardNucleicAcidResidue(const OEChem::OEAtomBase& atom)
         bool OEIsStandardNucleicAcidResidue(const OESystem::OEIter<OEHierResidue>& hit)

   .. oe:language:: python

      .. oe:api:: python

         OEIsStandardNucleicAcidResidue(res: OEResidue) -> bool
         OEIsStandardNucleicAcidResidue(resIdx: int) -> bool
         OEIsStandardNucleicAcidResidue(atom: OEAtomBase) -> bool
         OEIsStandardNucleicAcidResidue(hit: OEHierResidueIter) -> bool

   Returns whether the residue referred to is one of:
   A, C, G, I, T, U, DA, DC, DG, DI, DT, DU Residue indices are provided by
   :oe:func:`OEChem::OEGetResidueIndex`.

   .. seealso::

      * :ref:`OEIsStandardNucleicAcid <OEBio_OEIsStandardNucleicAcid>` class for use as a predicate

