.. oe:namespace:: OEGraphSim


.. meta::
   :keywords: OEFPTypeParams, FPTypeParams


.. _OEGraphSim_OEFPTypeParams:

.. oe:class:: OEFPTypeParams

   .. oe:api::

      class OEFPTypeParams

   This class represents :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>`.

   .. seealso::

      * :ref:`section_fptype_parameters` section

   .. oe:method:: Constructors

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

         .. oe:api::

            OEFPTypeParams(const std::string& typestr)

      .. oe:language:: python

         .. oe:api:: python

            OEFPTypeParams(typestr: str) -> OEFPTypeParams

      Constructor that parses the given string as a
      representation of a fingerprint and extracts the parameters that
      are used to generate the fingerprint.

      .. seealso::

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


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

         .. oe:api::

            OEFPTypeParams(const OEFPTypeBase* fptype)

      .. oe:language:: python

         .. oe:api:: python

            OEFPTypeParams(fptype: OEFPTypeBase) -> OEFPTypeParams

      Constructor that extracts the parameters that
      are used to generate the fingerprint type.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


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

      .. oe:api::

         OEFPTypeParams & operator=(const OEFPTypeParams & rhs)

      Assignment operator.


   .. oe:method:: GetAtomTypes

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

         .. oe:api::

            unsigned int GetAtomTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomTypes() -> int

      Returns

      * the atom types extracted from the string for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

      The return value is taken from the :oe:constns:`OEGraphSim::OEFPAtomType`
      namespace.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFPAtomType` function


   .. oe:method:: GetBondTypes

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

         .. oe:api::

            unsigned int GetBondTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondTypes() -> int

      Returns

      * the bond types extracted from the string for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types

      The return value is taken from the :oe:constns:`OEGraphSim::OEFPBondType`
      namespace.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFPBondType` function


   .. oe:method:: GetFPType

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

         .. oe:api::

            unsigned int GetFPType() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> int

      Returns the fingerprint type extracted from the string.
      The return value is taken from the :oe:constns:`OEGraphSim::OEFPType`
      namespace.


   .. oe:method:: GetMaxDistance

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

         .. oe:api::

            unsigned int GetMaxDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxDistance() -> int

      Returns:

      * the size of the largest path fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Path`
      * the size of the largest circular fragments (in radius),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Circular`
      * the size of the largest tree fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Tree`
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types


   .. oe:method:: GetMinDistance

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

         .. oe:api::

            unsigned int GetMinDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinDistance() -> int

      Returns:

      * the size of the smallest path fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Path`
      * the size of the smallest circular fragments (in radius),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Circular`
      * the size of the smallest tree fragments (in bonds),
        if the fingerprint type is :oe:const:`OEGraphSim::OEFPType::Tree`
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` and
        :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint types


   .. oe:method:: GetNumBits

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

         .. oe:api::

            unsigned int GetNumBits() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumBits() -> int

      Returns:

      * the size of the fingerprint in bits for
        :oe:const:`OEGraphSim::OEFPType::Path`,
        :oe:const:`OEGraphSim::OEFPType::Circular` and
        :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint types
      * 166 for :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint type
      * zero for :oe:const:`OEGraphSim::OEFPType::Lingo` fingerprint type


   .. oe:method:: GetVersion

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

         .. oe:api::

            unsigned short GetVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetVersion() -> short

      Returns the version number.

      .. seealso::

         * :oe:func:`OEGraphSim::OEGetFingerPrintVersionString` function


   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the string was valid from which the
      :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` object was initialized.
