Struct Scale 

pub struct Scale<F> { /* private fields */ }

A type that wraps any ObjectiveFunction and scales the input vectors before passing them to the wrapped function.

Can be used to restrict or widen the the search space in one or more dimensions in case it is known that the solution likely lies within a narrower or wider range in them.

Examples

use cmaes::objective_function::Scale;

let mut function = |x: &DVector<f64>| x.magnitude();
let scale = Scale::new(function, vec![0.2, 0.2, 1.0]);

let mut state = CMAESOptions::new(vec![0.0; 2], 1.0).build(scale).unwrap();

Implementations

impl<F> Scale<F>

pub fn new<S: Into<DVector<f64>>>(function: F, scales: S) -> Self

Returns a new Scale, wrapping function and multiplying each dimension of its inputs by the respective element of scales.

pub fn scale(&self, vector: &DVector<f64>) -> DVector<f64>

Applies the Scale to a vector and returns it.

pub fn scales(&self) -> &DVector<f64>

Returns the scales.

pub fn into_wrapped_function(self) -> F

Consumes self and returns the wrapped function.

Trait Implementations

impl<F: Clone> Clone for Scale<F>

fn clone(&self) -> Scale<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, F: ObjectiveFunction> ObjectiveFunction for &'a mut Scale<F>

fn evaluate(&mut self, x: &DVector<f64>) -> f64

impl<F: ObjectiveFunction> ObjectiveFunction for Scale<F>

fn evaluate(&mut self, x: &DVector<f64>) -> f64

impl<'a, F: ParallelObjectiveFunction> ParallelObjectiveFunction for &'a Scale<F>

fn evaluate_parallel(&self, x: &DVector<f64>) -> f64

impl<F: ParallelObjectiveFunction> ParallelObjectiveFunction for Scale<F>

fn evaluate_parallel(&self, x: &DVector<f64>) -> f64