.. oe:namespace:: OEGraphSim


.. _OEGraphSim_OECreateFastFPDatabaseOptions:

.. oe:class:: OECreateFastFPDatabaseOptions

   .. oe:api::

      class OECreateFastFPDatabaseOptions

   Encapsulates the options that control how the binary fingerprint database
   file is generated when calling the
   :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

   .. seealso::

      * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function
      * Example code in :ref:`section_examples_summary_makefastfp` section

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OECreateFastFPDatabaseOptions(const OEFPTypeBase* fptype)

      .. oe:language:: python

         .. oe:api:: python

            OECreateFastFPDatabaseOptions(fptype: OEFPTypeBase) -> OECreateFastFPDatabaseOptions

      Constructs an :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>`
      object with the given fingerprints type.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class

      .. note::

         **GraphSim TK** currently only supports the :term:`popcount` search method
         for fingerprints with the size of multiple of ``256``.
         This means that the :oe:const:`OEGraphSim::OEFPType::MACCS166`
         fingerprint type is currently not supported.
         When using other custom fingerprint types (see :ref:`chapter_user_defined` section)
         the size of the fingerprint must be a multiple of ``256`` in order to
         be able to search it with the :term:`popcount` method.


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

   .. oe:method:: GetFPType

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

         .. oe:api::

            const OEFPTypeBase* GetFPType() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> OEFPTypeBase

      Returns the fingerprint type in which the
      :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` was constructed.

      .. seealso::

         * :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


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

   .. oe:method:: GetNumProcessors

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

         .. oe:api::

            unsigned int GetNumProcessors() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumProcessors() -> int

      Returns the number of threads that are used to generate
      fingerprints when calling the
      :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

      .. seealso::

         * :oe:meth:`OEGraphSim::OECreateFastFPDatabaseOptions::SetNumProcessors` method


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

   .. oe:method: GetTracer DO NOT DOCUMENT

      .. oe:api::

         const OESystem::OEDots *GetTracer() const


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

   .. oe:method:: SetNumProcessors

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

         .. oe:api::

            void SetNumProcessors(unsigned int nrps)

      .. oe:language:: python

         .. oe:api:: python

            SetNumProcessors(nrps: int) -> None

      Sets the number of threads that are used to generate
      fingerprints when calling the
      :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.
      When set to ``0``, the number of processors used will be the number
      returned by the :oe:func:`OEPlatform::OEGetNumProcessors` function.

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

   .. oe:method:: SetTracer

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

         .. oe:api::

            void SetTracer(const OESystem::OEDots& dots)

      .. oe:language:: python

         .. oe:api:: python

            SetTracer(dots: OEDots) -> None

      Sets a tracer that can be used to show the progress of fingerprint
      generation.

      .. seealso::

         * :ref:`OEDots <OESystem_OEDots>` class in the **OEChem TK** manual
