Dwave-ocean-sdk

Bug Fixes

- Add the ability to set offsets on `ObjectiveView` and `ConstraintView`. This was previously removed in dimod 0.12.0. See [1287](https://github.com/dwavesystems/dimod/issues/1287)

<!-- -->

- Add `ObjectiveView.add_linear_from()` and `ConstraintView.add_linear_from()` methods. These were previously removed in dimod 0.12.0.

<!-- -->

- Add `ObjectiveView.add_variable()` and `ConstraintView.add_variable()` methods. These were previously removed in dimod 0.12.0.

Prelude

The entire C++ library has been rewritten for performance and consistency.

New Features

- New `dimod::abc::QuadraticModelBase` abstract base class.

<!-- -->

- Better performance for linear models.

<!-- -->

- Add `dimod.cyqmbase.cyQMBase_template` Cython class to serve as an abstract base class for Cython quadratic models.

<!-- -->

- Break `dimod/libcpp.pxd` into a full Cython subpackage to mirror the structure under `dimod/include/`. This allows for better organization, and less need to recompile all Cython files when changing parts of the C++ library. Packages that depend on dimod are still encouraged to use the `from dimod.libcpp cimport ...` syntax.

<!-- -->

- Build wheels for Python 3.11.

- Add C++ `dimod::ConstrainedQuadraticModel` class.

<!-- -->

- Add C++ `ConstrainedQuadraticModel.add_constraint()` overload that allows a user to move a binary quadratic model or quadratic model as a constraint.

<!-- -->

- Add C++ `ConstrainedQuadraticModel.constraint_weak_ptr()` method.

<!-- -->

- Make `BinaryQuadraticModel.vartype` callable. This allows for more uniform syntax between binary quadratic models, quadratic models and constrained quadratic models.

<!-- -->

- Replace current `ConstrainedQuadraticModel` implementation with one implemented in Cython.

<!-- -->

- Add `ConstrainedQuadraticModel.clear()` method.

Bug Fixes

- Fix a performance regression introduced in 0.10.0 when loading linear binary quadratic models from files.

<!-- -->

- Fix the handling of self-loops in `dimod::Expression::add_quadratic()` and similar methods.

<!-- -->

- Fix C++ `ConstrainedQuadraticModel.remove_variable()` method. Previously it would segmentation fault.

Upgrade Notes

- Rewrite `dimod::QuadraticModelBase` and move it to `dimod::abc::QuadraticModelBase` in `abc.h`.

<!-- -->

- Move `dimod::Vartype`, `dimod::vartype_info`, and `` dimod::vartype_limits` to ``vartypes.h\`\`.

<!-- -->

- Remove the `dimod::Neighborhood` class.

<!-- -->

- Remove `iterators.h`.

<!-- -->

- Move `dimod::BinaryQuadraticModel` to `binary_quadratic_model.h`.

<!-- -->

- Remove `dimod.binary.cybqm.cyBQMBase` class.

<!-- -->

- Remove `dimod.quadratic.cyqm.cyQMBase` class.

<!-- -->

- Build `manylinux2014` wheels. Previously we built `manylinux2010`.

<!-- -->

- Build `arm64` and `x86_64` wheels for macos. Previously we built `x86_64` and `universal2`.

Deprecation Notes

- Deprecate the `cascade` keyword argument in `ConstrainedQuadraticModel.fix_variable()`.

<!-- -->

- Deprecate the `cascade` keyword argument in `ConstrainedQuadraticModel.fix_variables()`.

New Features

- Add `Variables._remove()` method.

<!-- -->

- Added `weight` and <span class="title-ref">penalty</span> parameters on `ConstrainedQuadraticModel.add_constraint` methods to encoded weighted constraints.

<!-- -->

- Add constrained quadratic model serialization version 1.3 to support soft constraints.

New Features

- Add `Variables._remove()` method.

<!-- -->

- Added `weight` and <span class="title-ref">penalty</span> parameters on `ConstrainedQuadraticModel.add_constraint` methods to encoded weighted constraints.

<!-- -->

- Add constrained quadratic model serialization version 1.3 to support soft constraints.

New Features

- Add `ConstrainedQuadraticModel.__str__()` method. See [1188](https://github.com/dwavesystems/dimod/issues/1188).

- Speed up the construction of <span class="title-ref">Variables</span> objects from a <span class="title-ref">range</span> or another <span class="title-ref">Variables</span>.

- Add optional keyword argument `labels_type` to the `as_samples()` function.

- Speed up `BinaryQuadraticModel.energies()` and `QuadraticModel.energies()` in cases where the model has a small subset of the variables in the samples.

- Speed up `SampleSet.from_samples_cqm()` in cases where there are constraints with a small number of variables relative to the objective.

- Add `ConstrainedQuadraticModel.is_linear()` method.

- Add `ConstrainedQuadraticModel.spin_to_binary()` method.

- Add `Variables._clear()` method for use by classes that have `Variables` as an attribute.

- Add C++ `dimod::QuadraticModel::clear()` method.

- Add C++ `dimod::BinaryQuadraticModel::clear()` method.

- Add `QuadraticModel.clear()` method.

- Add `BinaryQuadraticModel.clear()` method.

- Add typing support for the `dimod.variables.Variables` class. See [1221](https://github.com/dwavesystems/dimod/issues/1221).

Bug Fixes

- Fix `as_samples()` when given a `SampleSet` and using the `labels_type` keyword argument. Previously it would raise a `TypeError`. This fix allows constructions like `bqm.energies(sampleset)` to function correctly.

- Refactor `dimod.typing.SamplesLike` and `dimod.typing.SampleLike`. `SampleLike` now correctly includes constructions like `([0, 1], 'ab')`.

- Make `Vartype.INTEGER` and `Vartype.REAL` pickleable. This fixes the pickling of many downstream objects like `QuadraticModel` and `SampleSet`.

New Features

- Add `revoke_token` method to `dwave.cloud.auth.flow.AuthFlow` to enable revocation of OAuth 2.0 refresh/access tokens. See [\600](https://github.com/dwavesystems/dwave-cloud-client/issues/600).

- Add `dwave auth revoke` CLI command to enable revocation of OAuth 2.0 refresh/access tokens from command line. See [\600](https://github.com/dwavesystems/dwave-cloud-client/issues/600).

Bug Fixes

- Preemptively set upper bounds on dependencies to prevent future breaks on older installed versions in the wild. Also, correct lower bounds for requests and urllib3. See [\612](https://github.com/dwavesystems/dwave-cloud-client/pull/612).