dimod.decorators.bqm_index_labelled_input¶
-
bqm_index_labelled_input
(var_labels_arg_name, samples_arg_names)[source]¶ Returns a decorator that ensures BQM variable labeling and specified sample_like inputs are index labeled and consistent.
- Parameters
var_labels_arg_name (str) – Expected name of the argument used to pass in an index labeling for the binary quadratic model (BQM).
samples_arg_names (list[str]) – Expected names of sample_like inputs that should be indexed by the labels passed to the var_labels_arg_name argument. ‘samples_like’ is an extension of NumPy’s array_like. See
as_samples()
.
- Returns
Function decorator.