dimod.QuadraticModel.energies

QuadraticModel.energies(samples_like, dtype: Union[numpy.dtype, None, type, numpy.typing._dtype_like._SupportsDType[numpy.dtype], str, Tuple[Any, int], Tuple[Any, Union[typing_extensions.SupportsIndex, Sequence[typing_extensions.SupportsIndex]]], List[Any], numpy.typing._dtype_like._DTypeDict, Tuple[Any, Any]] = None) numpy.ndarray[source]

Determine the energies of the given samples-like.

Parameters
  • samples_like (samples_like) – Raw samples. samples_like is an extension of NumPy’s array_like structure. See as_samples().

  • dtype – Desired NumPy data type for the energy. Matches dtype by default.

Returns

Energies for the samples.

Examples

>>> from dimod import QuadraticModel, Binary
>>> qm = QuadraticModel()
>>> qm.add_variables_from('BINARY', ['x', 'y'])
>>> qm.add_quadratic('x', 'y', -2)
>>> qm.energies([{'x': 1, 'y': 0}, {'x': 0, 'y': 0}, {'x': 1, 'y': 1}])
array([ 0.,  0., -2.])