Cyipopt

~~~~~~~~~~~~~~~~~~~~~~~~~

~~~~~~~~~~~~~~~~~~~~

Fixed
+++++

- Addressed regression in return value of ``intermediate_cb``. 250

~~~~~~~~~~~~~~~~~~~~

Added
+++++

- Support for building with Cython 3. 227, 240
- Exposed the ``eps`` kwarg in the SciPy interface. 228
- Added the examples to the source tarball. 242
- Documentation improvements on specifics of Jacobian and Hessian inputs. 247
- Support for Python 3.12.

Fixed
+++++

- Ensure ``tol`` is always a float in the SciPy interface. 236
- ``print_level`` allows integers other than 0 or 1. 244

~~~~~~~~~~~~~~~~~~~~

Added
+++++

- Added a ``pyproject.toml`` file with build dependencies. 162
- Added support for sparse Jacobians in the SciPy interface. 170
- Added ``get_current_iterate`` and ``get_current_violations`` methods to
Problem class. 182
- Added installation instructions for Ubuntu 22.04 LTS apt dependencies.
- Added a script to build manylinux wheels. 189
- Improved documentation of ``minimize_ipopt()``. 194
- Added support for all SciPy ``minimize()`` methods. 200
- Added support for SciPy style bounds in ``minimize_ipopt()`` and added input
validation. 207
- Added new ``CyIpoptEvaluationError`` and included it in relevance callbacks.
215
- Added dimension checks for Jacobian and Hessian attributes/methods. 216

Fixed
+++++

- Fixed import of ``MemoizeJac`` from scipy.optimize. 183
- ``args`` and ``kwargs`` can be passed to all functions used in
``minimize_ipopt()``. 197
- Fixed late binding bug in ``minimize_ipopt()`` when defining constraint
Jacobians. 208
- Pinned build dependency Cython to < 3. 212 214 223
- Fixed installation on Windows for official Ipopt binaries adjacent to
``setup.py``. 220

Changed
+++++++

- Changed the license to Eclipse Public 2.0. 185
- Updated all dependency pins to match those in Ubuntu 22.04 LTS. 223

GitHub holds releases, too
--------------------------

More information can be found on GitHub in the `releases section
<https://github.com/mechmotum/cyipopt/releases>`_.

About this Changelog
--------------------

All notable changes to this project will be documented in this file. The format
is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Dates should be (year-month-day) to conform with [ISO
8601](https://www.iso.org/iso-8601-date-and-time-format.html).

Formatting a New Version
------------------------

Include sections:

- Added - for new features.
- Changed - for changes in existing functionality.
- Deprecated - for soon-to-be removed features.
- Removed - for now removed features.
- Fixed - for any bug fixes.
- Security - in case of vulnerabilities.

Version History
---------------

~~~~~~~~~~~~~~~~~~~~

Added
+++++

- Added instructions for using the HSL binaries with the Conda Forge binaries.
- Support for Python 3.10 and 3.11.

Fixed
+++++

- Improved the type information in the JAX example.
- SciPy MemoizeJac deprecation warning handled.
- Handled KeyErrors upon unknown IPOPT return statuses.
- Removed unnecessary shebangs.
- Improved the Github Actions CI.

Removed
+++++++

- Dropped support for Python 3.6.