Struct Factor 

pub struct Factor { /* private fields */ }

A term contributing -weight * prod(s_v for v in vars) to the energy.

Implementations

impl Factor

pub fn new(vars: &[usize], weight: f64, n: usize) -> Result<Factor, FactorError>

Build a factor, rejecting everything that would make it silently not what was written.

pub fn vars(&self) -> impl Iterator<Item = usize> + '_

pub fn arity(&self) -> usize

pub fn weight(&self) -> f64

pub fn energy(&self, s: &[i8]) -> f64

This factor’s contribution to the energy: -w * prod(s_v).

The sign is the same convention as the rest of the crate: energy is -sum_ij J_ij s_i s_j - sum_i h_i s_i, so a positive weight prefers the product to be +1.

Trait Implementations

impl Clone for Factor

fn clone(&self) -> Factor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Factor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Factor

fn eq(&self, other: &Factor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Factor