Struct metaheuristics_nature::WithProduct

pub struct WithProduct<Y, P: ?Sized> { /* private fields */ }

A Fitness type carrying final results.

You can use Solver::as_best_xs() / Solver::as_best_fit() / Solver::get_best_eval() to access product field.

Implementations

impl<Y, P: ?Sized> WithProduct<Y, P>

pub fn new_from_arc(ys: Y, product: Arc<P>) -> Self

Create a product from an existing Arc object, where P can be unknown size.

pub fn as_result(&self) -> &P

Get the reference to the final result.

impl<Y, P> WithProduct<Y, P>

pub fn new(ys: Y, product: P) -> Self

Create a product.

pub fn ys(&self) -> Y

where Y: Clone,

Get the fitness value.

pub fn into_result(self) -> P

where P: Clone,

Consume and get the final result.

pub fn into_err_result(self) -> (Y::Eval, P)

where P: Clone, Y: Fitness,

Get the fitness value and the final result.

Trait Implementations

impl<Y: Clone, P: Clone + ?Sized> Clone for WithProduct<Y, P>

fn clone(&self) -> WithProduct<Y, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Y: Debug, P: Debug + ?Sized> Debug for WithProduct<Y, P>

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

Formats the value using the given formatter.

impl<Y: Fitness, P> Fitness for WithProduct<Y, P>

where P: MaybeParallel + Clone + 'static,

type Best<T: Fitness> = <Y as Fitness>::Best<T>

The best element container.

type Eval = <Y as Fitness>::Eval

A value to compare the final fitness value.

fn is_dominated(&self, rhs: &Self) -> bool

Check if self dominates rhs.

fn eval(&self) -> Self::Eval

Evaluate the final fitness value.