.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeFP

.. oe:function:: OEMakeFP

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

      .. oe:api::

         bool OEMakeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                       const unsigned fptype, const bool vs = false)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                  fptype: int, vs: bool = False) -> bool

   Generates a fingerprint from the given molecule.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.

   *vs*
      If ``true`` and the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree` or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other cases this parameter will be ignored.

      .. note::

         The boolean argument signature for this function to request virtual screening
         fingerprints will be deprecated in favor of the explicit API
         function :oe:func:`OEGraphSim::OEMakeVSFP` in future toolkit releases.

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEMakeVSFP`

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

      .. oe:api::

         bool OEMakeFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                       const OEFPTypeBase* fptype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeFP(fp: OEFingerPrint, mol: Union[OEGraphMol,OEMol,OEQMol],
                  fptype: OEFPTypeBase) -> bool

   Generates a fingerprint from the given molecule.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *fptype*
      The type of the fingerprint specified by an
      :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` pointer.

   .. note::

      For an empty molecule, both :oe:func:`OEGraphSim::OEMakeFP`
      function will return ``false`` and the type of the fingerprint
      will be set to ``0``
      (:oe:meth:`OEGraphSim::OEFingerPrint::GetFPTypeBase`).

