Enum annealing::NeighbourMethod

source · [−]

pub enum NeighbourMethod<F, R, const N: usize> where
    F: Float,
    StandardNormal: Distribution<F>,
    R: Rng,  {
    Normal {
        sd: F,
    },
    Custom {
        f: fn(p: &Point<F, N>, bounds: &Bounds<F, N>, rng: &mut R) -> Point<F, N>,
    },
}

Expand description

Method of getting a random neighbour

Variants

`Normal`

Fields

sd: F

Standard deviation

Get a neighbour in the vicinity of the current point by sampling a random normal distribution with the mean in that point and with the provided standard deviation

`Custom`

Fields

f: fn(p: &Point<F, N>, bounds: &Bounds<F, N>, rng: &mut R) -> Point<F, N>

Custom function

Custom: choose your own!

Implementations

source

impl<F, R, const N: usize> Method<F, R, N> where
 F: Float + Debug,
 StandardNormal: Distribution<F>,
 R: Rng,

source

pub fn neighbour(
 &self,
 p: &Point<F, N>,
 bounds: &Bounds<F, N>,
 rng: &mut R
) -> Point<F, N>

Get a neighbour of the current point

Arguments:

p — Current point;
bounds — Bounds of the parameter space;
distribution — Distribution to sample from;
rng — Random number generator.

Auto Trait Implementations

impl<F, R, const N: usize> RefUnwindSafe for Method<F, R, N> where
F: RefUnwindSafe,

impl<F, R, const N: usize> Send for Method<F, R, N> where
F: Send,

impl<F, R, const N: usize> Sync for Method<F, R, N> where
F: Sync,

impl<F, R, const N: usize> Unpin for Method<F, R, N> where
F: Unpin,

impl<F, R, const N: usize> UnwindSafe for Method<F, R, N> where
F: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Enum annealing::NeighbourMethod

Variants

`Normal`

Fields

`Custom`

Fields

Implementations

impl<F, R, const N: usize> Method<F, R, N> where
    F: Float + Debug,
    StandardNormal: Distribution<F>,
    R: Rng,

pub fn neighbour(
    &self,
    p: &Point<F, N>,
    bounds: &Bounds<F, N>,
    rng: &mut R
) -> Point<F, N>

Auto Trait Implementations

impl<F, R, const N: usize> RefUnwindSafe for Method<F, R, N> where
F: RefUnwindSafe,

impl<F, R, const N: usize> Send for Method<F, R, N> where
F: Send,

impl<F, R, const N: usize> Sync for Method<F, R, N> where
F: Sync,

impl<F, R, const N: usize> Unpin for Method<F, R, N> where
F: Unpin,

impl<F, R, const N: usize> UnwindSafe for Method<F, R, N> where
F: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

Enum annealing::NeighbourMethod

Variants

Normal

Fields

Custom

Fields

Implementations

impl<F, R, const N: usize> Method<F, R, N> where F: Float + Debug, StandardNormal: Distribution<F>, R: Rng,

pub fn neighbour( &self, p: &Point<F, N>, bounds: &Bounds<F, N>, rng: &mut R) -> Point<F, N>

Auto Trait Implementations

impl<F, R, const N: usize> RefUnwindSafe for Method<F, R, N> where F: RefUnwindSafe,

impl<F, R, const N: usize> Send for Method<F, R, N> where F: Send,

impl<F, R, const N: usize> Sync for Method<F, R, N> where F: Sync,

impl<F, R, const N: usize> Unpin for Method<F, R, N> where F: Unpin,

impl<F, R, const N: usize> UnwindSafe for Method<F, R, N> where F: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

`Normal`

`Custom`

impl<F, R, const N: usize> Method<F, R, N> where
F: Float + Debug,
StandardNormal: Distribution<F>,
R: Rng,

pub fn neighbour(
&self,
p: &Point<F, N>,
bounds: &Bounds<F, N>,
rng: &mut R
) -> Point<F, N>

impl<F, R, const N: usize> RefUnwindSafe for Method<F, R, N> where
F: RefUnwindSafe,

impl<F, R, const N: usize> Send for Method<F, R, N> where
F: Send,

impl<F, R, const N: usize> Sync for Method<F, R, N> where
F: Sync,

impl<F, R, const N: usize> Unpin for Method<F, R, N> where
F: Unpin,

impl<F, R, const N: usize> UnwindSafe for Method<F, R, N> where
F: UnwindSafe,

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,