.. oe:namespace:: OEGraphSim


.. _OEGraphSim_OEFastFPDatabaseParams:

.. oe:class:: OEFastFPDatabaseParams

   .. oe:api::

      class OEFastFPDatabaseParams


   Stores parameters retrieved from a binary fingerprint database file
   generated with the :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function.

   .. seealso::

      * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function


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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEFastFPDatabaseParams(const std::string& fpdbfname)

      .. oe:language:: python

         .. oe:api:: python

            OEFastFPDatabaseParams() -> OEFastFPDatabaseParams
            OEFastFPDatabaseParams(fpdbfname: str) -> OEFastFPDatabaseParams

      Constructor that parses the header of the given fingerprint file.


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

   .. oe:method:: GetFPTypeBase

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

         .. oe:api::

            const OEFPTypeBase* GetFPTypeBase() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeBase() -> OEFPTypeBase

      Returns the type of fingerprints stored in the file.

      .. seealso::

         :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class


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

   .. oe:method: GetFileSize DO NOT DOCUMENT

      .. oe:api::

         size_t GetFileSize() const

   .. oe:method: GetFingerPrintSizeIn32 DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeIn32() const

   .. oe:method: GetFingerPrintSizeIn64 DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeIn64() const

   .. oe:method: GetFingerPrintSizeInBits DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeInBits() const

   .. oe:method: GetFingerPrintSizeInBytes DO NOT DOCUMENT

      .. oe:api::

         size_t GetFingerPrintSizeInBytes() const

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

   .. oe:method:: GetMolDatabaseFilename

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

         .. oe:api::

            const std::string& GetMolDatabaseFilename() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolDatabaseFilename() -> str

      Returns the name of the molecule file from which the fingerprint
      file has been generated.


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

   .. oe:method: IsInLittleEndian DO NOT DOCUMENT

      .. oe:api::

         bool IsInLittleEndian() const

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

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the header of the fingerprint file can be
      successfully parsed.


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

   .. oe:method:: NumFingerPrints

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

         .. oe:api::

            size_t NumFingerPrints() const

      .. oe:language:: python

         .. oe:api:: python

            NumFingerPrints() -> int

      Returns the number of fingerprints stored in the fingerprint
      file.
