********************************************************************************
Version 2.3.0
********************************************************************************

.. _section_oechem_releasenotes_230:

OEChem TK 2.3.0
================================================================================

New features (Preliminary)
--------------------------------------------------------------------------------

* The following preliminary APIs have been added to perform fast substructure searches:

  * A new class, :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>`, has been added that stores
    bit-vector screens. In addition, a new :oe:constns:`OEChem::OESubSearchScreenType`
    namespace and :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class have been added that
    handle various screen types.

  * Two new low-level functions, :oe:func:`OEChem::OEMakeSubSearchQueryScreen`
    and :oe:func:`OEChem::OEMakeSubSearchTargetScreen`, have been added that
    generate query and target molecule screens, respectively. The
    :oe:func:`OEChem::OEScreen` low-level function can be used to determine
    whether a query molecule can potentially be matched to a target molecule by
    comparing their screens.

  * A new function, :oe:func:`OEChem::OEIsComplementaryScreenType`, has been
    added that determines which screen types are suited for a specific
    query molecule.

  * New helper functions, :oe:func:`OEChem::OESameSubSearchScreenTypes`,
    :oe:func:`OEChem::OEGetSubSearchScreenType`, and
    :oe:func:`OEChem::OEIsValidSubSearchScreenString`, have been added.

  * A new :ref:`OECreateSubSearchDatabaseOptions <OEChem_OECreateSubSearchDatabaseOptions>` option class
    and :oe:func:`OEChem::OECreateSubSearchDatabaseFile` function have
    been added that pre-generate databases for substructure search.
    A new :oe:func:`OEChem::OEIsValidSubSearchDatabase` function also has
    been added that checks whether a molecule file is valid for substructure search.

  * The :ref:`OESubSearchDatabase <OEChem_OESubSearchDatabase>` class is designed to perform
    rapid substructure searches. A new :oe:constns:`OEChem::OESubSearchDatabaseType`
    namespace has been added to this class that enables various database implementations.

  * A new class, :ref:`OESubSearchQuery <OEChem_OESubSearchQuery>`, has been added that
    sets up search queries. In addition, a new :ref:`OESubSearchResult <OEChem_OESubSearchResult>` class has
    been added that reports the progress of the search and retrieves the matches.

  * A new :oe:constns:`OEChem::OESubSearchStatus` namespace and
    :oe:func:`OEChem::OESubSearchStatusToName` helper function have been
    added that monitor the search progress.

* A new low-level function, :oe:func:`OEChem::OEReadCIFFile`, has been added that
  reads both small and macromolecule Crystallographic Information File
  (CIF and mmCIF) formats.


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

* Two new classes, :ref:`OEConfRMSDOptions <OEChem_OEConfRMSDOptions>` and :ref:`OEConfRMSD <OEChem_OEConfRMSD>`,
  have been added that set up :ref:`OEConfRMSD <OEChem_OEConfRMSD>` calculations and provide fast
  RMSD calculation of conformers of the same molecule, respectively.

* A new function, :oe:func:`OEChem::OEFastaToMol`, has been added that converts a
  FASTA sequence into a molecule.

* A new optional sorting argument has been added to the
  :oe:func:`OEChem::OEGetNearestNbrs` function that allows returned atom pairs
  to be sorted based on distance.

* :ref:`OEIsAlphaCarbon <OEBio_OEIsAlphaCarbon>` has been deprecated. The
  :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>` predicate should be used instead.

* New :oe:func:`OEChem::OEUncolorMol` overload functions have been added to
  :ref:`OEMCMolBase <OEChem_OEMCMolBase>`. A new constant, :oe:const:`OEChem::OEUncolorStrategy::RemoveDimension`,
  has been added that invalidates 3D coordinates and sets the dimension to ``0``
  when uncoloring molecules.

* Support has been added to :oe:func:`OEChem::OEReadMolecule` that enables reading
  both CIF and mmCIF files.

* Updates have been made to the :ref:`the OEFormat namespace <OEChem_OEFormat>` to include
  new CIF and mmCIF formats. Corresponding updates have also been added to
  :oe:constns:`OEChem::OEIFlavor` and :oe:constns:`OEChem::OEOFlavor`.

* Updates have been made to the :oe:constns:`OEChem::OEResidueIndex` namespace to
  include residue IDs for metals observed in PDB files.

* The formal charge assignment for less common metals observed in PDB files has been expanded.

* Updates have been made to the :oe:constns:`OEChem::OEExprType` namespace to allow for more
  fuzzy searches. For example, :oe:constns:`OEChem::OEExprType::ElemMinHCount` or
  :oe:constns:`OEChem::OEExprType::ElemMinDegree` can now be used to specify an atom's minimum
  hydrogen count or minimum degree.

* Changes have been made to the :ref:`OEResidue <OEChem_OEResidue>` class to support the mmCIF format.
  These changes include the following three new string member variables, with the appropriate
  getter and setter functions:

  * ``SequenceID`` captures the mmCIF field, `label_seq_id`, which is the sequential number of
    residues from 1.

  * ``ExtChainID`` captures the fact that the previous chainID in the `auth_asym_id` field can
    now have multiple characters. The :oe:meth:`OEChem::OEResidue::GetChainID` function now
    returns the first character of the ``ExtChainID`` variable, and
    :oe:meth:`OEChem::OEResidue::SetChainID` now overwrites and sets the ``ExtChainID``.

  * ``SubChainID`` captures the `label_asym_id` field, which commonly seems to be a further
    subdividing of the `auth_asym_id` field.


Minor bug fixes
--------------------------------------------------------------------------------

* A bug that caused :oe:const:`OEChem::OEWriteMolReturnCode::Success` to be returned
  even though an invalid output stream was used has been fixed.

* A bug that caused broken perception after implicit hydrogen assignment in the
  :oe:func:`OEChem::OEAssignImplicitHydrogens` and :oe:func:`OEChem::OEAssignMDLHydrogens`
  functions has been fixed.

* Handling of partially resonant nitrogen stereo perception in
  :oe:func:`OEChem::OE3DToAtomStereo` and :oe:func:`OEChem::OE3DToInternalStereo`
  has been improved.

* An issue that caused :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` to misperceive a minor
  number of C-terminal atoms has been fixed.

* Unpaired interactions are no longer triggered on ligands due to nearby water
  molecules. Similarly, water molecules can no longer present as having unpaired
  interactions.

Python-specific changes
--------------------------------------------------------------------------------

* Support for making custom MCS scoring functions from :ref:`OEMCSFunc <OEChem_OEMCSFunc>`
  has been added.

* New functions, :oe:func:`OESystem::OEGetBytesFromGrid`, :oe:func:`OESystem::OEGetScalarGridFromBytes`,
  and :oe:func:`OESystem::OEGetSkewGridFromBytes`, have been added to support
  the conversion between byte[] and grids (:ref:`OESkewGrid <OESystem_OESkewGrid>` or
  :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).

* :oe:meth:`OEChem::OETrans::Extract` is now available in Python.


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

* New functions, :oe:func:`OESystem::OEGetByteArrayFromScalarGrid`, :oe:func:`OESystem::OEGetByteArrayFromSkewGrid`,
  :oe:func:`OESystem::OEGetScalarGridFromByteArray`, and :oe:func:`OESystem::OEGetSkewGridFromByteArray`,
  have been added to support the conversion between byte[] and grids (:ref:`OESkewGrid <OESystem_OESkewGrid>` or
  :ref:`OEScalarGrid <OESystem_OEScalarGrid>`).


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

* Two new examples have been added that demonstrate performing fast substructure
  searches:

  * :ref:`section_example_oechem_makefastss`
  * :ref:`section_example_oechem_searchfastss`

* A new example program, :ref:`section_example_oebio_reshist`, has been added
  that demonstrates printing a histogram of the occurrences of various amino acids
  in a protein.

* The :ref:`section_example_oechem_oecheminfo` example program has been updated
  to demonstrate using the :oe:func:`OEPlatform::OEToolkitsGetRelease` function.

* New code snippets have been added to the :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class
  that demonstrate finding the two conformers of a molecule with the smallest
  RMSD.

* New code snippets have been added to the :oe:func:`OEChem::OEFastaToMol`
  function that demonstrate creating a molecule from a FASTA sequence.

* New code snippets have been added to the section, :ref:`section_molreadwrite_stringinputandoutput`,
  that demonstrate reading and writing molecules from memory buffers.

* New code snippets (in C++ and Python) have been added to the
  :ref:`OEMCSFunc <OEChem_OEMCSFunc>` class that demonstrate using custom scoring functions.

* **OEChem TK** examples have been cleaned up to use the new C++11 style.


OEBio TK 2.3.0
================================================================================

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

* The following APIs have been added for perceiving non-ideal hydrogen bond
  interactions (i.e., hydrogen bonds with long donor-acceptor distances or
  poor geometries):

   * A new functor, :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>`, has been added
     that easily identifies non-ideal hydrogen bonds.
   * New interaction types, :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`
     and :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`, have been added.
   * The following methods have been added that customize the non-ideal hydrogen
     bond perceptions:

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealDonorAngle`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealDonorAngle`

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealAcceptorAngle`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealAcceptorAngle`

      * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxNonIdealHBondDistance`
        and :oe:meth:`OEBio::OEPerceiveInteractionOptions::GetMaxNonIdealHBondDistance`


* A new functor, :ref:`OEIsHetAtom <OEBio_OEIsHetAtom>`, has been added that identifies atoms with the
  `hetero atom` property in an :oe:cls:`OEResidues<OEChem::OEResidue>` object.

* A new functor, :ref:`OEIsDisulfideBond <OEBio_OEIsDisulfideBond>`, has been added that identifies disulfide
  bonds.

* A new function, :oe:func:`OEBio::OECalculateDPI`, has been added that calculates the
  diffraction-component precision index (DPI) value.

* New categories, :oe:const:`OEBio::OEResidueDatabaseCategory::Lipid`
  and :oe:const:`OEBio::OEMolComplexFilterCategory::Lipid`, have been
  introduced that enable splitting lipids from a system.

* A new method, :oe:meth:`OEBio::OEInteractionHintContainer::DeleteInteractions`, has been added that
  removes all interactions.

* The functional group perception in :oe:func:`OEBio::OEPlaceHydrogens` has been improved.


Minor bug fixes
--------------------------------------------------------------------------------

* Perception of hydrogen bonds involving sulfur and anions in
  :oe:func:`OEBio::OEPerceiveInteractionHints` has been improved.

* The precedence of :ref:`OEInteractionHint <OEBio_OEInteractionHint>` perception has been improved.
  Chelation interactions now take precedence over charge-charge interactions.

* A check has been added to the :oe:func:`OEBio::OEPlaceHydrogens` function that
  causes it to exit early if two heavy atoms are within 0.5A of each other, since
  this is considered to be bad input and causes unspecified behavior.


OESystem TK 2.3.0
================================================================================

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

* The performance of :oe:func:`OESystem::OEGetDataType`, especially on
  Windows, has been improved. :oe:func:`OESystem::OEGetDataType` is now at
  least 500X faster when used with a single thread and about 2X faster with
  many simultaneous threads on Windows.

* A new method, :oe:meth:`OESystem::OEBitVector::CountRangeBits`, has been added that identifies the
  number of bits that are set to ``1`` in the given bit range.

* A new class, :ref:`OEConsoleProgressTracer <OESystem_OEConsoleProgressTracer>`, has been added that tracks
  the current progress of a task.

* A new function, :oe:func:`OESystem::OEStringEquals`, has been added that determines
  whether two strings are equivalent using a case-insensitive comparison.

* A new function, :oe:func:`OEMath::OEGeom3DReflectCoord`, has been added that
  reflects coordinates around a plane for a hydrogen atom.

* A new function, :oe:func:`OESystem::OEBitIsPowerOf2`, has been added that
  determines if a bitmask is a power of 2.


OEPlatform TK 2.3.0
================================================================================

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

* A new :oe:func:`OEPlatform::OEToolkitsGetRelease` function has been added that
  displays the release name of the overall toolkit version being used.


OEGrid TK 1.6.4
================================================================================

* Minor internal improvements have been made.
