pub struct SpinGlass<G, W> { /* private fields */ }Expand description
The Spin Glass (Ising model) problem.
Given n spin variables s_i in {-1, +1}, interaction coefficients J_ij, and on-site fields h_i, minimize the Hamiltonian:
H(s) = sum_{i<j} J_ij * s_i * s_j + sum_i h_i * s_i
§Representation
Variables are binary (0 or 1), mapped to spins via: s = 2*x - 1
- x = 0 -> s = -1
- x = 1 -> s = +1
§Type Parameters
G- The graph type (e.g.,SimpleGraph,KingsSubgraph,UnitDiskGraph)W- The weight type for couplings (e.g.,i32,f64)
§Example
use problemreductions::models::graph::SpinGlass;
use problemreductions::topology::SimpleGraph;
use problemreductions::{Problem, Solver, BruteForce};
// Two spins with antiferromagnetic coupling J_01 = 1
let problem = SpinGlass::<SimpleGraph, f64>::new(2, vec![((0, 1), 1.0)], vec![0.0, 0.0]);
let solver = BruteForce::new();
let solutions = solver.find_all_best(&problem);
// Ground state has opposite spins
for sol in &solutions {
assert!(sol[0] != sol[1]); // Antiferromagnetic: opposite spins
}Implementations§
Source§impl<W: Clone + Default> SpinGlass<SimpleGraph, W>
impl<W: Clone + Default> SpinGlass<SimpleGraph, W>
Source§impl<G: Graph, W: Clone + Default> SpinGlass<G, W>
impl<G: Graph, W: Clone + Default> SpinGlass<G, W>
Sourcepub fn from_graph(graph: G, couplings: Vec<W>, fields: Vec<W>) -> Self
pub fn from_graph(graph: G, couplings: Vec<W>, fields: Vec<W>) -> Self
Create a SpinGlass problem from a graph with specified couplings.
§Arguments
graph- The underlying graphcouplings- Coupling terms (must match graph.num_edges())fields- On-site fields h_i
Sourcepub fn from_graph_without_fields(graph: G, couplings: Vec<W>) -> Selfwhere
W: Zero,
pub fn from_graph_without_fields(graph: G, couplings: Vec<W>) -> Selfwhere
W: Zero,
Create a SpinGlass problem from a graph with no on-site fields.
Sourcepub fn num_interactions(&self) -> usize
pub fn num_interactions(&self) -> usize
Get the number of interactions (edges in the interaction graph).
Sourcepub fn interactions(&self) -> Vec<((usize, usize), W)>
pub fn interactions(&self) -> Vec<((usize, usize), W)>
Get the interactions as ((i, j), weight) pairs.
Reconstructs from graph.edges() and couplings.
Sourcepub fn config_to_spins(config: &[usize]) -> Vec<i32>
pub fn config_to_spins(config: &[usize]) -> Vec<i32>
Convert binary config (0,1) to spin config (-1,+1).
Trait Implementations§
Source§impl<'de, G, W> Deserialize<'de> for SpinGlass<G, W>where
G: Deserialize<'de>,
W: Deserialize<'de>,
impl<'de, G, W> Deserialize<'de> for SpinGlass<G, W>where
G: Deserialize<'de>,
W: Deserialize<'de>,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl<G, W> OptimizationProblem for SpinGlass<G, W>where
G: Graph + VariantParam,
W: WeightElement + VariantParam + PartialOrd + Num + Zero + Bounded + AddAssign + Mul<Output = W> + From<i32>,
impl<G, W> OptimizationProblem for SpinGlass<G, W>where
G: Graph + VariantParam,
W: WeightElement + VariantParam + PartialOrd + Num + Zero + Bounded + AddAssign + Mul<Output = W> + From<i32>,
Source§impl<G, W> Problem for SpinGlass<G, W>where
G: Graph + VariantParam,
W: WeightElement + VariantParam + PartialOrd + Num + Zero + Bounded + AddAssign + Mul<Output = W> + From<i32>,
impl<G, W> Problem for SpinGlass<G, W>where
G: Graph + VariantParam,
W: WeightElement + VariantParam + PartialOrd + Num + Zero + Bounded + AddAssign + Mul<Output = W> + From<i32>,
Source§const NAME: &'static str = "SpinGlass"
const NAME: &'static str = "SpinGlass"
Base name of this problem type (e.g., “MaximumIndependentSet”).
Source§type Metric = SolutionSize<<W as WeightElement>::Sum>
type Metric = SolutionSize<<W as WeightElement>::Sum>
The evaluation metric type.
Source§fn dims(&self) -> Vec<usize>
fn dims(&self) -> Vec<usize>
Configuration space dimensions. Each entry is the cardinality of that variable.
Source§fn evaluate(&self, config: &[usize]) -> SolutionSize<W::Sum>
fn evaluate(&self, config: &[usize]) -> SolutionSize<W::Sum>
Evaluate the problem on a configuration.
Source§fn variant() -> Vec<(&'static str, &'static str)>
fn variant() -> Vec<(&'static str, &'static str)>
Returns variant attributes derived from type parameters. Read more
Source§fn num_variables(&self) -> usize
fn num_variables(&self) -> usize
Number of variables (derived from dims).
Source§impl ReduceTo<MaxCut<SimpleGraph, i32>> for SpinGlass<SimpleGraph, i32>
impl ReduceTo<MaxCut<SimpleGraph, i32>> for SpinGlass<SimpleGraph, i32>
Source§impl ReduceTo<SpinGlass<SimpleGraph, f64>> for SpinGlass<SimpleGraph, i32>
impl ReduceTo<SpinGlass<SimpleGraph, f64>> for SpinGlass<SimpleGraph, i32>
Source§type Result = ReductionAutoCast<SpinGlass<SimpleGraph, i32>, SpinGlass<SimpleGraph, f64>>
type Result = ReductionAutoCast<SpinGlass<SimpleGraph, i32>, SpinGlass<SimpleGraph, f64>>
The reduction result type.
Source§impl ReduceTo<SpinGlass<SimpleGraph, i32>> for CircuitSAT
impl ReduceTo<SpinGlass<SimpleGraph, i32>> for CircuitSAT
Source§impl ReduceTo<SpinGlass<SimpleGraph, i32>> for MaxCut<SimpleGraph, i32>
impl ReduceTo<SpinGlass<SimpleGraph, i32>> for MaxCut<SimpleGraph, i32>
impl DeclaredVariant for SpinGlass<SimpleGraph, f64>
impl DeclaredVariant for SpinGlass<SimpleGraph, i32>
Auto Trait Implementations§
impl<G, W> Freeze for SpinGlass<G, W>where
G: Freeze,
impl<G, W> RefUnwindSafe for SpinGlass<G, W>where
G: RefUnwindSafe,
W: RefUnwindSafe,
impl<G, W> Send for SpinGlass<G, W>
impl<G, W> Sync for SpinGlass<G, W>
impl<G, W> Unpin for SpinGlass<G, W>
impl<G, W> UnwindSafe for SpinGlass<G, W>where
G: UnwindSafe,
W: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.