GraphSim TK 2.3.0
================================================================================

New features
--------------------------------------------------------------------------------

* A new API has been added to perform rapid searching
  of fingerprints using the :term:`popcount` method:

  * :oe:func:`OEGraphSim::OECreateFastFPDatabaseFile` function and
    :ref:`OECreateFastFPDatabaseOptions <OEGraphSim_OECreateFastFPDatabaseOptions>` class to generate
    binary fingerprint files
  * :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class and
    :oe:constns:`OEGraphSim::OEFastFPDatabaseMemoryType` namespace
    to perform rapid in-memory or memory-mapped fingerprint searches
    using the :term:`popcount` method
  * :ref:`OEFastFPDatabaseParams <OEGraphSim_OEFastFPDatabaseParams>` utility class
    and :oe:func:`OEGraphSim::OEAreCompatibleDatabases` utility function
  * :oe:func:`OEGraphSim::OEIsFastFPDatabaseReady` and
    :oe:func:`OEGraphSim::OEGetPopCountMethod` functions and
    :oe:constns:`OEGraphSim::OEPopCountMethod` namespace to check whether
    the :term:`popcount` method is supported on the current hardware

  .. note::

     **GraphSim TK** currently only supports the :term:`popcount`
     search method for fingerprints where the size is multiple of ``256``.
     This means that the :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint
     type is currently not supported.  See the :ref:`chapter_user_defined`
     section.

  .. note::

      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` gives identical results
      to :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>`.
      However :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` calculates similarity
      scores in single precision (float) while
      :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` uses double precision.
      As a result small similarity score differences can be observed.



API Change
--------------------------------------------------------------------------------

* The :ref:`OESimScore <OEGraphSim_OESimScore>` class, which is utilized by both
  the :ref:`OEFPDatabase <OEGraphSim_OEFPDatabase>` class and the new
  :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class, stores a similarity
  value with a corresponding molecule index.  This pair is now stored as
  "double" and "size_t" rather than "float" and "unsigned int".  This
  **non-breaking** API change allows **GraphSim TK** to support molecular
  files that contain more than :math:`2^{32}` entries and supports double
  precision similarity scores calculated using the new
  :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.

C++-specific changes
--------------------------------------------------------------------------------

* The above-mentioned :ref:`OESimScore <OEGraphSim_OESimScore>` class API change
  means that the following warning messages could be encountered
  when compiling old code with the new **GraphSim TK**:

  * ``implicit conversion loses floating point precision: 'double' to 'float'``

    .. code-block:: c++

       for (OEIter<OESimScore> si = fpdb.GetScores(mol); si; ++si)
         float score = si->GetScore(); // GetScore() now returns double

  * ``implicit conversion loses integer precision : 'size_t' to 'unsigned int'``

    .. code-block:: c++

        for (OEIter<OESimScore> si = fpdb.GetScores(mol); si; ++si)
          unsigned int molidx = si->GetIdx(); // GetIdx() now returns size_t

Java-specific changes
--------------------------------------------------------------------------------

* The above-mentioned :ref:`OESimScore <OEGraphSim_OESimScore>` class API change
  means that a similarity value with a corresponding molecule index is now
  expected to be "double" and "long", respectively.

Documentation changes
--------------------------------------------------------------------------------

* A new section, :ref:`section_examples_summary_searchfp`, has been added.

* New :ref:`section_examples_summary_makefastfp` and
  :ref:`section_examples_summary_searchfastfp` sections have been added
  with examples showing generation and searching of fingerprints
  using the :ref:`OEFastFPDatabase <OEGraphSim_OEFastFPDatabase>` class.
