Dwave-optimization

New Features

- Add C++ `LogNode` and Python `Log` symbol. `Log` propagates the
natural logarithm of its predecessor element-wise.
- Add virtual `Node::deterministic_state()` C++ method. This method
allows nodes to communicate whether or not their state is uniquely
derived from its predecessors.
- Add support for serialization format version 1.0. This format is
more efficient for storing the states of fixed-size array symbols.
It also supports saving the states of nondeterministic intermediate
array symbols.
- Add `substitute` keyword argument to `Model.from_file()`.
- Add `atleast_1d()`, `atleast_2d()`, `hstack()`, and `vstack()`
functions. See [\240](https://github.com/dwavesystems/dwave-optimization/issues/240).
- Add `LinearProgram` (linear program) symbol and related derivative
symbols.
- Add `linprog()` function. This function accepts array symbols
representing a linear program and returns array symbols giving the
result.

Upgrade Notes

- Change `stack()` and `concatenate()` functions handling of single
array inputs. They are no longer passed through; the functions now
raise an error instead.

Bug Fixes

- Correctly update the state of the mask when reverting a `PutNode`.

New Features

- Add `LinearProgram` (linear program) symbol and related derivative
symbols.
- Add `linprog()` function. This function accepts array symbols
representing a linear program and returns array symbols giving the
result.

New Features

- Add C++ `LogNode` and Python `Log` symbol. `Log` propagates the
natural logarithm of its predecessor element-wise.
- Add virtual `Node::deterministic_state()` C++ method. This method
allows nodes to communicate whether or not their state is uniquely
derived from its predecessors.
- Add support for serialization format version 1.0. This format is
more efficient for storing the states of fixed-size array symbols.
It also supports saving the states of nondeterministic intermediate
array symbols. The default serialzation format is not yet changed.
- Add `substitute` keyword argument to `Model.from_file()`.
- Add `atleast_1d()`, `atleast_2d()`, `hstack()`, and `vstack()`
functions. See [\240](https://github.com/dwavesystems/dwave-optimization/issues/240).

Upgrade Notes

- Change `stack()` and `concatenate()` functions handling of single
array inputs. They are no longer passed through; the functions now
raise an error instead.

Bug Fixes

- Correctly update the state of the mask when reverting a `PutNode`.

New Features

- Add C++ `Array::minmax()` method that accepts a `cache` argument.
This method can avoid a potentially expensive depth first search
through the node graph. See
[\182](https://github.com/dwavesystems/dwave-optimization/issues/182).
- Add C++ `ExpitNode` and Python `Expit` symbol. `Expit` propagates
the logistic sigmoid values of its predecessor element-wise.
- Add C++ `ARangeNode` and Python `ARange` symbol and
`arange()` function.

Upgrade Notes

- The C++ `Array::min()` and `Array::max()` methods are no longer
`virtual`, but instead call the more general `Array::minmax()`
method. Subclasses of `Array` should `override` the
`Array::minmax()` method instead.

Bug Fixes

- Fix `ConcatenateNode` propagation. Previously in some cases it would
record the wrong update index.
- Fix bug in basic indexing propagation that may have caused some
updates from the predecessor array to not get propagated when the
start of the indexing operation was offset from the start of the
predecessor array. This would happen only when the predecessor array
is statically sized or the start and stop of the domain are both
positive.
- Fix the C++ `ConcatenateNode::minmax()` method. Previously it would
not pass the `cache` argument to its predecessors.

New Features

- Add C++ `PartialProdNode`.
- Add `PartialProd` symbol.
- Add `axis` keyword argument to `ArraySymbol.prod()` method.
- Add integral, max and min to `ConcatenateNode`. See [\192](https://github.com/dwavesystems/dwave-optimization/issues/192).
- Support both lvalue and rvalue ranges in the constructor of the C++
`ArrayOutputMixin` class.
- Rework C++ `ReshapeNode` constructors to be more general.
- Support inferring the shape of one axis when reshaping array symbols
by providing `-1` for the dimension\'s shape.
- Support reshaping non-contiguous array symbols.
- Add C++ `CopyNode`. See [\16](https://github.com/dwavesystems/dwave-optimization/issues/16).
- Add `Copy` symbol. See [\16](https://github.com/dwavesystems/dwave-optimization/issues/16).

Bug Fixes {Release Notes_0.5.0-6_Bug Fixes}

- Previously, ``Constant`` symbols could be created from
data that contained NaNs or infinite float values. Since these
values, especially NaN, can cause issues during propagation when not
expected, they could cause the model to exhibit incorrect behavior.
As such, providing these values to initialize a ``Constant`` symbol is now disallowed.
- Add missing C++ `ReshapeNode::max()`, `::min()`, and `::integral()`
methods. Thereby allowing reshaped arrays to be used as indices.

New Features

- Move C++ `Graph` constructor and assignment operator definitions
into the `dwave-optimization/graph.hpp`.
- Explicitly disallow copy construction and copy assignment for C++
`Graph`.
- Add some convenience methods to C++ `Array::View` class.
Specifically, implement `Array::View::at()`, `Array::View::back()`,
and `Array::View::empty()`. Also make `Array::View` semi-regular.
- Add C++ `RintNode` and Python `Rint` symbol. `Rint` propagates the
values of its predecessor rounded to the nearst integer
element-wise.
- Add Python `stack` symbol. See
[\191](https://github.com/dwavesystems/dwave-optimization/issues/191).
- Add C++ `PutNode`.
- Generalize C++ `ConstantNode` range constructors to work with all
ranges rather than just with vectors.
- Add `Put` symbol and `put()` function. See
[\202](https://github.com/dwavesystems/dwave-optimization/issues/202).
- Add random overloads for C++ `DynamicArrayTestingNode::grow()` and
`DynamicArrayTestingNode::set()`.

Deprecation Notes

- Remove `::default_move()` method from the C++ `Decision` class and
all subclasses.
- Remove C++ `DynamicArrayTestingNode::random_moves()` method.
- Rework C++ `NumberNode::initialize_state()` overloads for better
consistency.
- Remove `RngAdaptor` class.

Bug Fixes

- Fix `from dwave.optimization.symbols import *`.
- Fix typo in error message. See
[\193](https://github.com/dwavesystems/dwave-optimization/issues/193).