Changelog
=========

v0.12.0 (Nov. 21, 2023)
----------------------

* Support Python 3.12.
* Add :attr:`~amplify.client.ToshibaSQBM2Client.solver` attribute to :class:`~amplify.client.ToshibaSQBM2Client`.
* Support Red Hat Enterprise Linux 8 and 9 and their compatible distributions.
* Support D-Wave Advantage_system6.3.
* [Removed] Drop support for CentOS 7
* [Removed] Drop support for Python 3.7 due to EOL.

v0.11.2 (Apr. 6, 2023)
----------------------

* Support Amplify QAOA v0.4.
* Change the default value of :attr:`~amplify.client.FujitsuDA4SolverClient.set_penalty_binary_polynomial` and :attr:`~amplify.client.FujitsuDA4SolverClient.set_inequalities` of Fujitsu DA4 clients to True.
* Improve compatibility with DA3/DA4 one/two-way one-hot groups.
* Support D-Wave Advantage_system6.2 (v0.11.2).
* [Removed] Drop support for CentOS 8 due to EOL.
* [Removed] Drop support for Ubuntu 18.04 due to EOL.

v0.10.4 (Dec. 21, 2022)
-----------------------

* Support Python 3.11.
* Support `FujitsuDA4Solver <https://portal.aispf.global.fujitsu.com/apidoc/da/jp/api-ref/da-qubo-v4-ja.html>`_ on :class:`~amplify.client.FujitsuDA4SolverClient`. See example [:ref:`ref <client-fujitsu-da4>`].
* Support Toshiba SQBM+ v2 on :class:`~amplify.client.ToshibaSQBM2Client`. See example [:ref:`ref <client-toshiba-sqbm2>`].
* Support NEC Vector Annealing on :class:`~amplify.client.NECClient`. See example [:ref:`ref <client-nec>`]  (v0.10.4).

v0.9.1 (Oct. 4, 2022)
----------------------

* Enable to select relaxation method for construction of inequality constraints [:ref:`ref <constraint-inequality-relaxation>`].
* Input/output of quadratic models with LP file format and QPLIB file format [:ref:`ref <io-with-lp-format>`].
* Support `Amplify Annealing Engine <https://amplify.fixstars.com/engine#annealingengineis>`_ version 0.7 on :class:`~amplify.client.FixstarsClient` [:doc:`amplify-ae/changelog`].

v0.8.1 (June 13, 2022)
----------------------

* Add QAOA Solver clients with `IBM Quantum <https://quantum-computing.ibm.com/>`_ and `Qulacs <https://github.com/qulacs/qulacs>`_ [:ref:`ref <client-qiskit>`].
* Support D-Wave Advantage_system6.1.
* Support D-Wave Advantage2_prototype1.1 (v0.8.1).
* Enable to get the runtime or API version string from :attr:`~amplify.client.FixstarsClient.version` property of each client class.
* [Removed] Drop support for Python 3.6 due to EOL.
* [Removed] Drop support for Ubuntu 16.04 due to EOL.

v0.7.0 (Apr. 27, 2022)
----------------------

* Improve performance.
* Support Python 3.10.
* Support `Amplify Annealing Engine <https://amplify.fixstars.com/engine#annealingengineis>`_ version 0.6 on :class:`~amplify.client.FixstarsClient` [:doc:`amplify-ae/changelog`].
* Support `ABS QUBO Solver <https://qubo.cs.hiroshima-u.ac.jp/home>`_ on :class:`~amplify.client.ABSClient` [:ref:`ref <client-ntt-hiroshima>`] (experimental).
* Support `Gurobi Optimizer <https://www.gurobi.com/products/gurobi-optimizer>`_ on :class:`~amplify.client.GurobiClient` [:ref:`ref <client-gurobi>`].
* Enable to select integer encoding method for construction of inequality constraints [:ref:`ref <constraint-inequality-encinteger>`].
* Enable to change correspondence of variables for :meth:`~amplify.BinaryPoly.to_Binary` and :meth:`~amplify.BinaryPoly.to_Ising` methods [:ref:`ref <to-binary>`].
* Add :func:`~amplify.BinaryPoly.degree` function and related [:ref:`ref <poly-degree>`].
* Add :attr:`~amplify.Solver.execution_time` property to :class:`~amplify.Solver` [:ref:`ref <get_execution_time>`].
* Add options to client classes to save request/response data to a specified file.
* [Deprecated] :attr:`~amplify.client.FixstarsClientResult.annealing_time_ms` is deprecated.
* [Removed] Remove ``LogicPoly`` class and related functions. Logic operations are ported to :class:`~amplify.BinaryPoly` [:ref:`ref <polynomial-logic_operations>`].

v0.6.6 (Aug. 19, 2021)
----------------------

* Improve stability
* Add :doc:`array` class for effective and fast polynomial formulations.
* Add :func:`~amplify.constraint.one_hot` function as an alias of `equal to 1` constraint [:ref:`ref <constraint-tsp_formulation>`].
* Enable to select quadratization method for construction of :class:`~amplify.BinaryQuadraticModel` [:ref:`ref <model-reduction>`].
* Support `FujitsuDA3Solver <https://portal.aispf.global.fujitsu.com/apidoc/da/jp/api-ref/da-qubo-v3-ja.html>`_ on :class:`~amplify.client.FujitsuDA3SolverClient`. See example [:ref:`ref <client-fujitsu-da3>`].
* Support Apple M1.
* Support D-Wave specifications after September 2021 (v0.6.3).
* Support D-Wave Advantage_system4.1 (v0.6.5).

v0.5.13 (May 14, 2021)
----------------------

* Support `Amplify Annealing Engine <https://amplify.fixstars.com/engine#annealingengineis>`_ version 0.5 on :class:`~amplify.client.FixstarsClient` [:doc:`amplify-ae/changelog`].
* Add parameter of customized constraint satisfaction condition to :func:`~amplify.constraint.penalty` function [:ref:`ref <constraints-advanced>`].
* Add :attr:`~amplify.BinaryConstraint.label` property to :class:`~amplify.BinaryConstraint` (and related objects) [:ref:`ref <constraints-label>`].
* D-Wave SAPI client (:class:`~amplify.client.DWaveClient`) is deprecated. Use D-Wave Sampler client (:class:`~amplify.client.ocean.DWaveSamplerClient`) instead.

v0.4.1 (Jan. 29, 2021)
----------------------

* No license file required anymore
* Set default url parameter of Fixstars client
* Add :attr:`~amplify.client.FixstarsClient.proxy` property to `Fixstars <client-fixstars>`_, `Fujitsu <client-fujitsu>`_, `Hitachi <client-hitachi>`_ and `Toshiba <client-toshiba>`_ clients.
* Add :func:`~amplify.constraint.greater_equal` function to create `greater than or equal to` constraint [:ref:`ref <constraint-inequality>`].
* Add :func:`~amplify.constraint.clamp` function to create `clamping a value between a pair of boundary values` constraint [:ref:`ref <constraint-inequality>`].
* Accept :class:`~amplify.BinaryConstraint` (and related objects) as arguments of :func:`~amplify.Solver.solve`.
* Remove deprecated properties from timing information of D-Wave QPU

v0.3.4 (Dec. 20, 2020)
----------------------

* Improve performance of Polynomial construction.
* Support `D-Wave Advantage 1.1 quantum system <https://www.dwavesys.com/press-releases/d-wave-announces-general-availability-first-quantum-computer-built-business>`_ on :class:`~amplify.ocean.DWaveSamplerClient`. See example [:ref:`ref <client-dwave_sampler>`].
* Support `Simulated Bifurcation Machine <https://www.toshiba-sol.co.jp/pro/sbm/index_j.htm>`_ version 1.4 on :class:`~amplify.client.ToshibaClient`.
* Add :attr:`~amplify.client.SolverSolution.is_feasible` attribute to :class:`~amplify.client.SolverSolution`, which represents whether the solution is feasible or not.
* Add :func:`~amplify.BinaryQuadraticModel.check_constraints` method to check if the constraints of the QuadraticModel are satisfied with the given solution [:ref:`ref <model-check_constraints>`].
* Add :attr:`~amplify.Solver.filter_solution` property to :class:`~amplify.Solver` class. Set `True` to get only feasible solutions [:ref:`ref <solver-filter_solution>`]. Defaults to `True`.
* Add :attr:`~amplify.Solver.deduplicate` property to :class:`~amplify.Solver` class. Set `True` to deduplicate among the identical solutions [:ref:`ref <solver-deduplicate>`]. Defaults to `True`.
* Add :attr:`~amplify.Solver.sort_solution` property to :class:`~amplify.Solver` class. Set True to sort solutions by their energy values [:ref:`ref <solver-sort_solution>`].
* Add iterator methods for ``ClientResult``, :class:`~amplify.client.LogicalResult` and :class:`~amplify.client.SolverResult`
* Support Python 3.9.

v0.2.2 (Sep. 11, 2020)
----------------------

* Improve performance.
* Add :class:`~amplify.client.HitachiClient` for `Hitachi CMOS annealing machine type 4 <https://annealing-cloud.com/ja/web-api/reference/v2.html>`_.
* Add :func:`~amplify.constraint.less_equal` function to create `less than or equal to` constraint [:ref:`ref <constraint-inequality>`].
* Add conversions between Matrix class and numpy array [:ref:`ref <matrix-numpy>`].
* Add ``constant()`` method to get the constant term of Polynomial [:ref:`ref <poly-constant>`].
* Add ``asdict()`` method to convert the polynomial to Python dictionary [:ref:`ref <poly-asdict>`].
* Add compressed data transfer options in parameters for Amplify Annealing Engine client. Defaults to `True`.

v0.1.7 (July 7, 2020)
---------------------

* Initial release 🎋