.. oe:namespace:: OEChem


.. oe:constnamespace:: OEResidueIndex


   The :oe:constns:`OEChem::OEResidueIndex` namespace encodes symbolic
   constants representing residue indices returned by the
   :oe:func:`OEChem::OEGetResidueIndex` function(s).

   If the biopolymer residue name is not recognized, the
   :oe:func:`OEChem::OEGetResidueIndex` function returns either a zero
   or a unsigned integer value other than the values listed below.

   .. note::

      As future releases of **OEChem** may add to this namespace, code
      should not test for zero, but instead check against the relevant
      values and treat all other values as 'unrecognized'.

   This namespace contains the following constants:


   .. oe:constant:: ALA



   .. oe:constant:: ARG



   .. oe:constant:: ASN



   .. oe:constant:: ASP



   .. oe:constant:: CYS



   .. oe:constant:: GLN



   .. oe:constant:: GLU



   .. oe:constant:: GLY



   .. oe:constant:: HIS



   .. oe:constant:: ILE



   .. oe:constant:: LEU



   .. oe:constant:: LYS



   .. oe:constant:: MET



   .. oe:constant:: PHE



   .. oe:constant:: PRO



   .. oe:constant:: SER



   .. oe:constant:: THR



   .. oe:constant:: TRP



   .. oe:constant:: TYR



   .. oe:constant:: VAL



   .. oe:constant:: UNK



   .. oe:constant:: ASX



   .. oe:constant:: GLX



   .. oe:constant:: ASH



   .. oe:constant:: CYX



   .. oe:constant:: CYH



   .. oe:constant:: CYM



   .. oe:constant:: GLH



   .. oe:constant:: HID



   .. oe:constant:: HIE



   .. oe:constant:: HIP



   .. oe:constant:: LYN



   .. oe:constant:: TYM



   .. oe:constant:: A



   .. oe:constant:: C



   .. oe:constant:: G



   .. oe:constant:: I



   .. oe:constant:: T



   .. oe:constant:: U



   .. oe:constant:: DA



   .. oe:constant:: DC



   .. oe:constant:: DG



   .. oe:constant:: DI



   .. oe:constant:: DU



   .. oe:constant:: _1MA



   .. oe:constant:: _2MG



   .. oe:constant:: _5MC



   .. oe:constant:: _5MU



   .. oe:constant:: _7MG



   .. oe:constant:: H2U



   .. oe:constant:: M2G



   .. oe:constant:: OMC



   .. oe:constant:: OMG



   .. oe:constant:: PSU



   .. oe:constant:: YG



   .. oe:constant:: ABA



   .. oe:constant:: ACE



   .. oe:constant:: CGU



   .. oe:constant:: CME



   .. oe:constant:: CSD



   .. oe:constant:: FOR



   .. oe:constant:: HSE



   .. oe:constant:: HYP



   .. oe:constant:: HYL



   .. oe:constant:: LYZ



   .. oe:constant:: MEN



   .. oe:constant:: MLE



   .. oe:constant:: MLY



   .. oe:constant:: MSE



   .. oe:constant:: ORN



   .. oe:constant:: PCA



   .. oe:constant:: PTR



   .. oe:constant:: SAR



   .. oe:constant:: SEP



   .. oe:constant:: TAU



   .. oe:constant:: TPO



   .. oe:constant:: LIG



   .. oe:constant:: MOL



   .. oe:constant:: UNL



   .. oe:constant:: BR



   .. oe:constant:: CL



   .. oe:constant:: ADP



   .. oe:constant:: AF3



   .. oe:constant:: ALF



   .. oe:constant:: ATP



   .. oe:constant:: BME



   .. oe:constant:: DMS



   .. oe:constant:: EDO



   .. oe:constant:: EOH



   .. oe:constant:: FAD



   .. oe:constant:: GOL



   .. oe:constant:: HEM



   .. oe:constant:: HOH



   .. oe:constant:: IOD



   .. oe:constant:: MOH



   .. oe:constant:: NAD



   .. oe:constant:: NAG



   .. oe:constant:: PEO



   .. oe:constant:: PER



   .. oe:constant:: PO2



   .. oe:constant:: PO4



   .. oe:constant:: SO2



   .. oe:constant:: SO4



   .. oe:constant:: SX


   .. oe:constant:: NHE


   .. oe:constant:: NME


   .. oe:constant:: CIP


   .. oe:constant:: CIM

   .. oe:constant:: RU

   .. oe:constant:: SB

   .. oe:constant::   V

   .. oe:constant::  MN

   .. oe:constant:: MN3

   .. oe:constant::  FE

   .. oe:constant:: FE2

   .. oe:constant::  CO

   .. oe:constant:: CO3

   .. oe:constant::  NI

   .. oe:constant:: _3NI

   .. oe:constant:: CU1

   .. oe:constant::  CU

   .. oe:constant::  Y1

   .. oe:constant:: YT3

   .. oe:constant:: _4MO

   .. oe:constant:: _6MO

   .. oe:constant::  EU

   .. oe:constant:: EU3

   .. oe:constant::  AU

   .. oe:constant:: AU3

   .. oe:constant:: PT4

   .. oe:constant::  PT

   .. oe:constant:: IR3

   .. oe:constant::  IR

   .. oe:constant::  OS

   .. oe:constant:: OS4

   .. oe:constant::  YB

   .. oe:constant:: YB2

   .. oe:constant:: _4TI