********************************************************************************
Version 1.7.5
********************************************************************************

OEChem 1.7.5
================================================================================

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

* :ref:`Generic Data handling <chapter_genericdata>` chapter added.
* All the ``OEChem`` examples have been overhauled. Several examples
  have been removed, new ones have been created and all the examples
  (across all the languages we support) have been reviewed to bring
  them up to a similar standard. For the details of example toolkit
  scripts see the :ref:`examples
  summary chapter<chapter_examplesoechem_summary>`. Source code
  is also included in the documentation.

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

* :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` container added.
* :ref:`OEIsAtomHybridization <OEChem_OEIsAtomHybridization>` functor added.
* :oe:meth:`OESystem::OEBase::GetDataIter` that takes an unsigned
  integer added for convenience. 
* :ref:`OEIsMember <OEChem_OEIsMember>` and :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>` can
  now be initialized with an :ref:`OEIterBase <OESystem_OEIterBase>` pointer.
* :oe:func:`OEChem::OEParseSmiles` function will now ignore extra
  leading spaces in non-strict mode.
* :oe:meth:`OEChem::OELibraryGen::SetTitleSeparator` will now store an
  internal copy of the string, fixing issues in wrapped languages. 
* :oe:func:`OEChem::OEIs3DFormat` function added as a convenience function for
  the user to determine whether a file format supports 3D coordinates.
* :oe:meth:`OEChem::OEMolBase::Clear` can now be called on a
  compressed DBMol and DBMCMol to wipe out the molecule
  entirely. 
* :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor added to
  detect atoms double bonded to a ring. Most users consider atoms
  double bonded to a ring system as part of the "scaffold". 
* MiniMols can now store coordinates, energy, and dimension. These are
  stored as generic data, so not particularly "mini". Just meant to
  allow MiniMols to be used as a more general purpose molecule
  implementation. 
* Safety precautions to prevent corrupted molecules from being written
  were placed into the OEB writer for rotor-offset-compressed
  molecules. These molecules should not be modified, and definitely
  should not be written if they were modified.
* Both old format and new format PDB hydrogen atom names are now supported.
  The new PDB naming format is used when new H atom names are assigned.
  The call :oe:func:`OEChem::OEResidueHydrogens` now supports an option
  to control which style of H atom names is assigned.
* Four new residue types have been defined:
  :oe:const:`OEChem::OEResidueIndex::NHE` (carboxy-terminal amine)
  :oe:const:`OEChem::OEResidueIndex::NME` (carboxy-terminal methyl amine)
  :oe:const:`OEChem::OEResidueIndex::CIP` (AmberFF's +1 ion)
  :oe:const:`OEChem::OEResidueIndex::CIM` (AmberFF's -1 ion).

.. oe:language:: python

   * The Python global interpreter lock will be released when calling
     :oe:meth:`OEMolBase::Compress<OEChem::OEMolBase::Compress>` and
     :oe:meth:`OEMolBase::UnCompress<OEChem::OEMolBase::UnCompress>` on a molecule. Since
     these are relatively expensive methods this should improve the
     performance of multi-threaded python applications. 

.. oe:language:: java

  * :ref:`OENearestNbrs <OEChem_OENearestNbrs>` now supports ``OEFloatArray`` in
     Java. 
  * All of the native array wrapper classes like ``OEFloatArray``
    have two new methods: a constructor that takes a Java array
    of the same base type, and a ``toArray`` method that will return
    a Java array of the same type. 

Major bug fixes
--------------------------------------------------------------------------------

.. oe:language:: python

   * Fixed memory leak in :oe:meth:`OEChem::OEMolBase::SetCoords` when taking a
     Python sequence or dictionary. :oe:meth:`OEChem::OEMolBase::SetCoords`
     will also throw a Python exception if the object passed does not
     conform to what is expected. 

.. oe:language:: java

  * :ref:`OENearestNbrs <OEChem_OENearestNbrs>` fixed in java to not randomly crash
    due to early garbage collection of the atoms in the returned
    iterators.

  * :oe:func:`OEChem::OENewMolBase`, :oe:func:`OEChem::OENewMCMolBase`,
    :oe:func:`OEChem::OENewQMolBase` no longer leak the memory of the
    molecules. 


* Fixed a crash in the OEB writer that occurred when very large values
  were set for the map index or isotope atom properties. 

* Fixed a bug with parity bits in SDF files. This would occur if
  :oe:func:`OEChem::OEPerceiveChiral` was called with an aromaticity
  model other than MDL before the molecule was written. The SDF writer
  now makes sure to re-perceive chirality based upon the MDL
  aromaticity model to get the correct parity bits. 

* Fixed a memory leak that would occur when reusing a
  :ref:`oemolistream <OEChem_oemolistream>` for many different files under certain
  circumstances. 

* :oe:meth:`OEChem::OEMol::operator=` fixed to not duplicate SD data
  when being assigned from an :ref:`OEGraphMol <OEChem_OEGraphMol>`.

* The FASTA reader now assigns the proper stereochemistry to the molecules
  it produces.

* The function :oe:func:`OEChem::OEPerceiveResidues` now respects the following
  data preservation flags:
  :oe:const:`OEChem::OEPreserveResInfo::Occupancy`,
  :oe:const:`OEChem::OEPreserveResInfo::BFactor`, and
  :oe:const:`OEChem::OEPreserveResInfo::FragmentNumber` both individually and
  implicitly as part of the flag:
  :oe:const:`OEChem::OEPreserveResInfo::All`.
  Using the flag
  :oe:const:`OEChem::OEPreserveResInfo::SerialNumber`
  will leave only the serial number of new atoms altered.

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

* :ref:`OELibraryGen <OEChem_OELibraryGen>` fixed when explicitly defined
  bonds on the reactant side are not set correctly. This used to
  generate products with incorrect valence.

* *OEMiniMol::Sweep()* fixed to properly re-index atoms and bonds after
  some atoms and bonds were deleted. 

* :oe:func:`OEChem::OEKekulize` will now fail if the integer bond types
  are set correctly, i.e., not between ``1`` and ``5`` inclusive. 

* :oe:const:`OEChem::OEOFlavor::Generic::Default` will now be
  consistent in molstreams for all flavors. The
  :oe:func:`OEChem::OEIsWriteable` function that takes a format and a
  flavor will now check the generic and specific flavor bits
  separately.

* :oe:func:`OEChem::OERMSD` fixed when dealing with multi-conformer
  molecules with suppressed hydrogen atoms.

* :oe:func:`OEChem::OERMSD` will now check whether the associated
  :ref:`OEMatchBase <OEChem_OEMatchBase>` actually belongs to the molecule being
  passed in. 

* :oe:func:`OEChem::OEParseSmiles` fixed to not crash when parsing
  empty strings in strict mode. 

* :oe:meth:`OEChem::OELibraryGen::GetTitleSeparator` method signature
  changed to return a string directly. The previous signature and
  function couldn't operate and didn't actually do anything.

* :oe:func:`OEChem::OESmartsLexReplace` fixed to not give incorrect
  SMARTS whenever a name appears twice in the bindings
  vector. Instead, the first pair is used, and a warning is thrown to
  indicate to the user about there being multiple pairs. 

* :ref:`OEIsHeavy <OEChem_OEIsHeavy>` is fixed to not return ``true`` for dummy
  atoms, that is, any atom with an atomic number of
  ``0``. :ref:`OEIsHeavy <OEChem_OEIsHeavy>` will only return ``true`` if the
  atomic number is greater than ``1``. 

* :oe:meth:`OEChem::oemolithread::openstring` crash fixed when used
  without a valid format being set. 

* Atom names perceived for unknown ligand types
  (:oe:const:`OEChem::OEResidueIndex::UNK` and
  :oe:const:`OEChem::OEResidueIndex::UNL`) are now
  constructed from the element name and an integer. 

* :oe:func:`OEChem::OEAddExplicitHydrogens` is fixed to produce better hydrogen
  placement geometries when adding hydrogens to sp3 carbons where the
  carbon's existing attachments vary significantly from ideal tetrahedral
  geometry.

.. oe:language:: python

   * :oe:constns:`OEChem::OEFuzzVal` namespace constants now properly
     wrapped in Python. The :oe:const:`OEChem::OEFuzzVal::True` and
     :oe:const:`OEChem::OEFuzzVal::False` constants would override the
     built in Python ``True`` and ``False`` by redefining them to the
     integral values of ``1`` and ``0`` respectively. This wouldn't
     cause any problems, in fact, Python 2.2 and previous versions
     used to define ``True`` and ``False`` exactly this way. 
  
OEBio 1.7.5
================================================================================


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

*  New :oe:meth:`OEBio::OEAltLocationFactory::GetCurrentLocations` methods
   provide a way to determine which alternate locations are selected. A new
   :oe:meth:`OEBio::OEAltLocationFactory::GetGroup` method is provided to
   convert from an :ref:`OEAltLocation <OEBio_OEAltLocation>` to an :ref:`OEAltGroup <OEBio_OEAltGroup>`.

*  A new :oe:func:`OEBio::OEGetRotamers` call that takes an
   :ref:`OEResidue <OEChem_OEResidue>` is now provided as a convenience.

*  A new :oe:func:`OEBio::OEExpandCrystalSymmetry` function expands the crystal
   symmetry of the source molecule into different conformers in the destination
   molecule.

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

.. oe:language:: python

   * :ref:`OERotamer <OEBio_OERotamer>` is now properly wrapped in Python.

.. oe:language:: java

   * :ref:`OERotamer <OEBio_OERotamer>` is now properly wrapped in Java.
   * Crystal symmetry API is now properly wrapped in Java.

*  :meth:`OEBio::OEHierResidue::GetOEResidue` now returns a reference to a blank
   residue when the class is uninitialized instead of a reference to random memory.

*  Adding :oe:meth:`OEBio::OESequenceAlignment::operator bool` method.
   An :ref:`OESequenceAlignment <OEBio_OESequenceAlignment>` object is considered invalid
   until its implementation is set.        
   Both the :oe:func:`OEBio::OEWriteAlignment` and the
   :oe:func:`OEBio::OERMSD` functions checks
   whether the passed alignment is valid and throw a warning if it is
   not.



OEGrid 1.3.5
================================================================================

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

* :oe:func:`OESystem::OEGetCenterAndExtents` fixed to work on a
  :ref:`OESkewGrid <OESystem_OESkewGrid>` when it is regular grid, i.e. has no
  orientation.

* :oe:meth:`OESystem::OEErrorHandler::SetOutputStream` performance
  significantly improved to avoid quadratic behavior in certain
  circumstances.

* :oe:meth:`OESystem::OEWriteGrid` fixed to actually gzip the output if
  the file name ends in ``.gz``. Before it would just write the file
  in the specified format, but never gzip it. 


OESystem 1.7.5
================================================================================

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

* :oe:const:`OESystem::OEErrorLevel::Default` has been changed from
  :oe:const:`OESystem::OEErrorLevel::Verbose` to
  :oe:const:`OESystem::OEErrorLevel::Info`. This allows
  ``OEThrow.Verbose`` to be used for printing more information to the
  terminal, but it will only appear when ``OEThrow.SetLevel`` is
  called with the :oe:const:`OESystem::OEErrorLevel::Verbose` level. In
  the past, the :oe:const:`OESystem::OEErrorLevel::Verbose` level was
  essentially ignored since it was nearly the same as
  :oe:const:`OESystem::OEErrorLevel::Info`.

* :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class added to interpolate
  colors between specified ranges. :ref:`OEColorStop <OESystem_OEColorStop>`
  class added to initialize :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
  objects.

* ``OESystem::OEBkgrdGrey`` added as a new color for
  using a light grey background of an image. 

* :oe:func:`OESystem::OECopyBaseData` convenience function added for
  copying :ref:`generic data<chapter_genericdata>`.

* :oe:func:`OESystem::OEGetTag` heavily optimized for multi-threaded
  use. 

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

.. oe:language:: python

   * Fixed memory leak in *OEArray* (OEFloatArray, OEDoubleArray,
     OEIntArray, etc) constructor when used on a Python sequence. 

   * Fixed memory leak in :ref:`OEInterface <OESystem_OEInterface>` constructor.

* :oe:meth:`OESystem::OEBitVector::SetData` crash fixed where it would
  try to copy more bytes than the actual size of the given data.

* :oe:func:`OESystem::OEStringToNumber` function now allows for
  new-line characters, ``\n``, to appear after the digits in the
  string. 

* :ref:`OEBase <OESystem_OEBase>` :ref:`generic data<chapter_genericdata>`
  can now handle an empty ``std::vector`` through OEB reading and
  writing.

* :oe:func:`OESystem::OEStringTokenize` now has an additional
  parameter, *concat_delim*, that specifies whether consecutive
  delimiters should be treated as a single delimiter. This is useful
  for parsing CSV files with empty fields. However, the default
  behavior is to behave as before, treating consecutive delimiters as
  a single delimiter.

* :oe:meth:`OESystem::OEGridBase::GetXIdx`,
  :oe:meth:`OESystem::OEGridBase::GetYIdx`,
  :oe:meth:`OESystem::OEGridBase::GetZIdx` fixed so that the dimensions
  are guaranteed to always be within the dimensions of the grid. These
  methods would sometimes return indices that were outside the range
  of the dimensions of the grid due to floating point rounding errors.

* ``unsigned`` can now be used as the ``!TYPE`` in interface files for
  unsigned int parameters. 

* :oe:func:`OESystem::OELinearInterpolate` performance has been
  significantly improved. 

OEPlatform  1.7.5
================================================================================

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

* ``OEEOF`` is now defined by the ``OEPlatform`` headers and is the
  value returned by ``oestream`` methods to indicate that the end of
  the file has been reached. 

* :oe:meth:`OEPlatform::oeostream::operator\<<` can not properly write a
  ``size_t`` on 64-bit Windows. 


