Trait metaheuristics_nature::utility::Algorithm[−][src]

pub trait Algorithm<F: ObjFunc> {
    fn generation(&mut self, ctx: &mut Context<F>);

    fn init(&mut self, ctx: &mut Context<F>) { ... }
}
Expand description

The methods of the meta-heuristic algorithms.

  1. Implement Setting trait then indicate to a “method” type.
  2. Implement Algorithm trait on the “method” type.

Usually, the “method” type that implements this trait will not leak from the API. All most common dataset is store in the Context type. So the “method” type is used to store the additional data if any.

use metaheuristics_nature::utility::prelude::*;

/// A setting with additional fields.
#[derive(Default)]
pub struct MySetting1 {
    my_option: u32,
}

/// The implementation of the structure with fields.
impl Setting for MySetting1 {
    type Algorithm = Method;

    fn algorithm(self) -> Self::Algorithm {
        Method
    }
}

/// Tuple-like setting.
#[derive(Default)]
pub struct MySetting2;

/// The implementation of a tuple-like structure.
impl Setting for MySetting2 {
    type Algorithm = Method;

    fn algorithm(self) -> Self::Algorithm {
        Method
    }
}

pub struct Method;

impl<F: ObjFunc> Algorithm<F> for Method {
    fn generation(&mut self, ctx: &mut Context<F>) {
        unimplemented!()
    }
}

Your algorithm will be implemented by the Solver type automatically. All you have to do is implement the “initialization” method and “generation” method, which are corresponded to the Algorithm::init and Algorithm::generation respectively.

Required methods

Processing implementation of each generation.

Provided methods

Initialization implementation.

The information of the Context can be obtained or modified at this phase preliminarily.

The default behavior is do nothing.

Implementors