
Bioisostere TK 5.0.0
================================================================================

New Features
--------------------------------------------------------------------------------

* The following new classes have been added as preliminary API:
  
  * :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>`
  * :ref:`OEBroodCluster <OEBioisostere_OEBroodCluster>`
  * :ref:`OEBroodClusterBuilder <OEBioisostere_OEBroodClusterBuilder>`
  * :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>`
  * :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>`
  * :ref:`OEHitlistBase <OEBioisostere_OEHitlistBase>`
  * :ref:`OEScoreHitlist <OEBioisostere_OEScoreHitlist>`
  * :ref:`OEBroodHitlist <OEBioisostere_OEBroodHitlist>`
  * :ref:`OEMolCTBuilder <OEBioisostere_OEMolCTBuilder>`
  * :ref:`OESimilarity <OEBioisostere_OESimilarity>`

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetQueryID <OEBioisostere_OEBroodQuery_GetQueryID>`
  * :ref:`SetQueryID <OEBioisostere_OEBroodQuery_SetQueryID>`

* A new constructor overload has been added to :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
  that takes a :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>` as an argument.

* A new overload of :ref:`Setup <OEBioisostere_OEBroodDBFilter_Setup>` has been added to
  :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>` that takes a molecule as argument.

* The following new methods have been added to :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`:

  * :ref:`GetBuildRes <OEBioisostere_OEBroodHit_GetBuildRes>`
  * :ref:`GetScores <OEBioisostere_OEBroodHit_GetScores>`

* The following new methods have been added to :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`:

  * :ref:`Add <OEBioisostere_OEBroodScore_Add>`
  * :ref:`GetQueryIDs <OEBioisostere_OEBroodScore_GetQueryIDs>`

* The following new functions have been added:

  * :ref:`OECreateFlipperOptions <OEBioisostere_OECreateFlipperOptions>`
  * :ref:`OECreateFragFilter <OEBioisostere_OECreateFragFilter>`
  * :ref:`OEIsFragment <OEBioisostere_OEIsFragment>`

* The following methods have been removed from the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`,
  as they are no longer relevant:

  * GetTrimmedCount
  * TrimHitlist
  * An overload of GetHits that took a vector of :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` as an argument.
  * GetRemovedHits


Minor Bug Fixes
--------------------------------------------------------------------------------

* The :ref:`OECreateBroodQuery <OEBioisostere_OECreateBroodQuery>` method now
  keeps any incoming color atoms associated with the query selection, when available, and
  does not add any additional color atoms to the query.  The behavior is unchanged
  when no color atoms are present with the incoming selection.

* A bug in fragment property filtering has been resolved. Now by setting the
  :ref:`SetUseProperty <OEBioisostere_OEBroodScoreOptions_SetUseProperty>` option in
  :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` to true, you can activate
  the fragment filtering based on the properties defined by
  :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>` and
  :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>`.
  Previously, the filter was not being applied correctly, which could lead to unexpected
  fragments being included in the results.

* An issue has been fixed related to proper usage of 
  :ref:`SetRangeSize<OEBioisostere_OEBroodGeneralOptions_SetRangeSize>` and
  :ref:`SetRangeOffset<OEBioisostere_OEBroodGeneralOptions_SetRangeOffset>` so that
  fragment retrieval from the database during the overlay step now properly respects
  the specified range boundaries.

* A bug has been fixed where the color score reported by
  :ref:`GetColorScore <OEBioisostere_OEBroodScore_GetColorScore>` could exceed its valid
  range in ROCS mode, causing the combined score to exceed its range as well. The color
  Tanimoto is now computed consistently from the scored conformer.

