.. oe:namespace:: OEGraphSim


.. _OEGraphSim_OEFPPattern:

.. oe:class:: OEFPPattern

   .. oe:api::

      class OEFPPattern : public OEChem::OEAtomBondSet

   A container that stores patterns that are enumerated when fingerprints such as
   :oe:const:`OEGraphSim::OEFPType::Path`, :oe:const:`OEGraphSim::OEFPType::Circular`
   and :oe:const:`OEGraphSim::OEFPType::Tree` are generated.

   .. seealso::

      * :ref:`chapter_patterns` chapter
      * :oe:func:`OEGraphSim::OEGetFPPatterns` function


   The following methods are publicly inherited from :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>`:

   ======================================================================== ======================================================================== ======================================================================== 
   :oe:meth:`operator=<OEChem::OEAtomBondSet::operator=>`                   :oe:meth:`ClearBonds<OEChem::OEAtomBondSet::ClearBonds>`                 :oe:meth:`Remove<OEChem::OEAtomBondSet::Remove>`
   :oe:meth:`Add<OEChem::OEAtomBondSet::Add>`                               :oe:meth:`CreateCopy<OEChem::OEAtomBondSet::CreateCopy>`                 :oe:meth:`RemoveAtom<OEChem::OEAtomBondSet::RemoveAtom>`
   :oe:meth:`AddAtom<OEChem::OEAtomBondSet::AddAtom>`                       :oe:meth:`GetAtoms<OEChem::OEAtomBondSet::GetAtoms>`                     :oe:meth:`RemoveAtoms<OEChem::OEAtomBondSet::RemoveAtoms>`
   :oe:meth:`AddAtoms<OEChem::OEAtomBondSet::AddAtoms>`                     :oe:meth:`GetBonds<OEChem::OEAtomBondSet::GetBonds>`                     :oe:meth:`RemoveBond<OEChem::OEAtomBondSet::RemoveBond>`
   :oe:meth:`AddBond<OEChem::OEAtomBondSet::AddBond>`                       :oe:meth:`HasAtom<OEChem::OEAtomBondSet::HasAtom>`                       :oe:meth:`RemoveBonds<OEChem::OEAtomBondSet::RemoveBonds>`
   :oe:meth:`AddBonds<OEChem::OEAtomBondSet::AddBonds>`                     :oe:meth:`HasBond<OEChem::OEAtomBondSet::HasBond>`                       :oe:meth:`Sweep<OEChem::OEAtomBondSet::Sweep>`
   :oe:meth:`Clear<OEChem::OEAtomBondSet::Clear>`                           :oe:meth:`IsEmpty<OEChem::OEAtomBondSet::IsEmpty>`                       :oe:meth:`Translate<OEChem::OEAtomBondSet::Translate>`
   :oe:meth:`ClearAtoms<OEChem::OEAtomBondSet::ClearAtoms>`                 :oe:meth:`NumAtoms<OEChem::OEAtomBondSet::NumAtoms>`
   :oe:meth:`ClearAtomsAndBonds<OEChem::OEAtomBondSet::ClearAtomsAndBonds>` :oe:meth:`NumBonds<OEChem::OEAtomBondSet::NumBonds>`
   ======================================================================== ======================================================================== ======================================================================== 
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFPPattern(OESystem::OEIter<OEChem::OEAtomBase>& atoms,
                        OESystem::OEIter<OEChem::OEBondBase>& bonds,
                        const std::string& smarts, unsigned int unhashed,
                        unsigned int setbit)

      .. oe:language:: python

         .. oe:api:: python

            OEFPPattern(atoms: OEAtomIter, bonds: OEBondIter, smarts: str,
                        unhashed: int, setbit: int) -> OEFPPattern

      Constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEFPPattern &operator=(const OEFPPattern &rhs)

      Assignment operator.

   .. oe:method:: GetBit

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

         .. oe:api::

            unsigned int GetBit() const

      .. oe:language:: python

         .. oe:api:: python

            GetBit() -> int

      Returns the bit that is set when the given pattern is hashed into fixed-length
      bitvector.

   .. oe:method:: GetSmarts

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

         .. oe:api::

            std::string GetSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetSmarts() -> str

      Returns the smarts representation of the given pattern.

   .. oe:method:: GetUnhashed

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

         .. oe:api::

            unsigned int GetUnhashed() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnhashed() -> int

      Returns the unhashed unique integer representation of the given pattern.
