Skip to main content

SpinglassOptions

Struct SpinglassOptions 

Source
pub struct SpinglassOptions {
    pub spins: usize,
    pub parallel_update: bool,
    pub start_temperature: f64,
    pub stop_temperature: f64,
    pub cooling_factor: f64,
    pub update_rule: SpincommUpdate,
    pub gamma: f64,
    pub implementation: SpinglassImplementation,
    pub gamma_minus: f64,
}
Expand description

Options of Graph::community_spinglass and Graph::community_spinglass_single, with the defaults suggested by igraph.

Fields§

§spins: usize

Number of spins, i.e. the maximum number of communities (default 25).

§parallel_update: bool

Update all spins in parallel (default false); not supported by SpinglassImplementation::Neg.

§start_temperature: f64

Starting temperature (default 1.0).

§stop_temperature: f64

Stopping temperature (default 0.01).

§cooling_factor: f64

Cooling factor of the simulated annealing (default 0.99).

§update_rule: SpincommUpdate

Null model: SpincommUpdate::Config (configuration model, default) or SpincommUpdate::Simple (Erdős–Rényi).

§gamma: f64

Resolution parameter γ (default 1.0, must be in [0, 1e150]).

§implementation: SpinglassImplementation

Implementation: SpinglassImplementation::Orig (default, faster) or SpinglassImplementation::Neg (allows negative weights).

§gamma_minus: f64

Resolution for the negative part of the network, Neg only (default 1.0, magnitude at most 1e150).

Trait Implementations§

Source§

impl Clone for SpinglassOptions

Source§

fn clone(&self) -> SpinglassOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpinglassOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SpinglassOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SpinglassOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SpinglassOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.