Struct optimization_engine::core::fbs::FBSEngine

pub struct FBSEngine<'a, GradientType, ConstraintType, CostType> where
    GradientType: Fn(&[f64], &mut [f64]) -> i32,
    CostType: Fn(&[f64], &mut f64) -> i32,
    ConstraintType: Constraint,  { /* fields omitted */ }

The FBE Engine defines the steps of the FBE algorithm and the termination criterion

Methods

impl<'a, GradientType, ConstraintType, CostType> FBSEngine<'a, GradientType, ConstraintType, CostType> where
    GradientType: Fn(&[f64], &mut [f64]) -> i32,
    CostType: Fn(&[f64], &mut f64) -> i32,
    ConstraintType: Constraint, 

pub fn new(
    problem: Problem<GradientType, ConstraintType, CostType>,
    cache: &'a mut FBSCache
) -> FBSEngine<'a, GradientType, ConstraintType, CostType>

Constructor for instances of FBSEngine

Arguments

• problem problem definition (cost function, gradient of the cost, constraints)
• mutable reference to a cache a cache (which is created once); the cache is reuseable

Returns

An new instance of FBSEngine

Trait Implementations

impl<'a, GradientType, ConstraintType, CostType> AlgorithmEngine for FBSEngine<'a, GradientType, ConstraintType, CostType> where
    GradientType: Fn(&[f64], &mut [f64]) -> i32 + 'a,
    CostType: Fn(&[f64], &mut f64) -> i32 + 'a,
    ConstraintType: Constraint + 'a, 

fn step(&mut self, u_current: &mut [f64]) -> bool

Take a forward-backward step and check whether the algorithm should terminate

Arguments

• u_current the current mutable

Returns

• A boolean flag which istrue if and only if the algorith should not terminate

Panics

The method may panick if the computation of the gradient of the cost function or the cost function panics.

fn init(&mut self, _u_current: &mut [f64])