.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPCoverage

.. oe:function:: OEGetFPCoverage

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

      .. oe:api::

         OESystem::OEIterBase<OEChem::OEAtomBondSet>* OEGetFPCoverage(const OEChem::OEMolBase& mol,
                                                                      const OEFPTypeBase* fptype,
                                                                      bool unique = false)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPCoverage(mol: Union[OEGraphMol,OEMol,OEQMol],
                         fptype: OEFPTypeBase, unique: bool = False) -> OEAtomBondSetIter

   Returns an iterator over the fragments that are generated when a
   fingerprint is constructed.

   *mol*
      The :ref:`OEMolBase <OEChem_OEMolBase>` objects from which the fingerprint
      fragments are generated.

   *fptype*
      The type of the fingerprint that also stores the parameters that
      are used when the fingerprint is generated.

   *unique*
      If true, then the :oe:func:`OEGraphSim::OEGetFPCoverage`
      function returns only unique fragments. A fragment (i.e. a subgraph)
      is considered unique if it differs from all other subgraphs
      identified previously by at least one atom or bond.

   .. note::

      The :oe:func:`OEGraphSim::OEGetFPCoverage` function is not
      available for the :oe:const:`OEGraphSim::OEFPType::Lingo`
      fingerprint type.

   .. seealso::

      * :ref:`chapter_coverage` chapter
      * :oe:func:`OEGraphSim::OEGetFPOverlap` function
      * :oe:func:`OEGraphSim::OEGetFPPatterns` function
