.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEMakeCircularFP

.. oe:function:: OEMakeCircularFP

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

      .. oe:api::

         bool OEMakeCircularFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol)

   .. oe:language:: python

      .. oe:api:: python

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

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_circular` fingerprint using default
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|


   The following code snippet shows how to print out the string representation of
   a :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint.
   This string encodes information about default parameters used to generate
   a :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint.

   .. oe:source:: CircularFPDefaultParams.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   .. oe:source:: CircularFPDefaultParams.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   ..  oe:language:: python

        :ref:`Full listing. <listing-CircularFPDefaultParams.py>`


   .. oe:source:: CircularFPDefaultParams.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   .. oe:source:: CircularFPDefaultParams.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CIRCULAR-DEFAULT-PARAMS

   The output of the above code snippet is:

   .. code-block:: console

      Circular,ver=2.0.0,size=4096,radius=0-5,atype=AtmNum|Arom|Chiral|FCharge|HCount|EqHalo,btype=Order

   .. seealso::

      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method

   .. ############################################################################

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

      .. oe:api::

         bool OEMakeCircularFP(OEFingerPrint& fp, const OEChem::OEMolBase& mol,
                               unsigned int numbits, unsigned int minradius,
                               unsigned int maxradius, unsigned int atype,
                               unsigned int btype)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeCircularFP(fp: OEFingerPrint,
                          mol: Union[OEGraphMol,OEMol,OEQMol], numbits: int,
                          minradius: int, maxradius: int, atype: int,
                          btype: int) -> bool

   Generates the :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object as a
   :ref:`section_fingerprint_circular` fingerprint using the given
   parameters.

   *fp*
      |makefp|

   *mol*
      |makefpmol|

   *numbits*
      |makefpnumbits|

   *minradius*, *maxradius*
      The smallest and largest circular fragments (in radius) that are
      enumerated during the fingerprint generation.
      All enumerated circular fragments are hashed into the
      :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object.

   *atype*
      |makefpatomtype|

   *btype*
      |makefpbondtype|

   .. note::

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


   .. seealso::

      * :ref:`chapter_user_defined` chapter
      * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
      * :oe:constns:`OEGraphSim::OEFPBondType` namespace

