[−][src]Trait opencv::core::MinProblemSolver

pub trait MinProblemSolver: AlgorithmTrait {
    fn as_raw_MinProblemSolver(&self) -> *mut c_void;

    fn get_function(&self) -> Result<PtrOfFunction> { ... }

    fn set_function(&mut self, f: &PtrOfFunction) -> Result<()> { ... }

    fn get_term_criteria(&self) -> Result<TermCriteria> { ... }

    fn set_term_criteria(&mut self, termcrit: &TermCriteria) -> Result<()> { ... }

    fn minimize(&mut self, x: &mut dyn ToInputOutputArray) -> Result<f64> { ... }
}

Basic interface for all solvers

Required methods

fn as_raw_MinProblemSolver(&self) -> *mut c_void

Loading content...

Provided methods

fn get_function(&self) -> Result<PtrOfFunction>

Getter for the optimized function.

The optimized function is represented by Function interface, which requires derivatives to implement the calc(double*) and getDim() methods to evaluate the function.

Returns

Smart-pointer to an object that implements Function interface - it represents the function that is being optimized. It can be empty, if no function was given so far.

fn set_function(&mut self, f: &PtrOfFunction) -> Result<()>

Setter for the optimized function.

It should be called at least once before the call to minimize(), as default value is not usable.

Parameters

  • f: The new function to optimize.

fn get_term_criteria(&self) -> Result<TermCriteria>

Getter for the previously set terminal criteria for this algorithm.

Returns

Deep copy of the terminal criteria used at the moment.

fn set_term_criteria(&mut self, termcrit: &TermCriteria) -> Result<()>

Set terminal criteria for solver.

This method is not necessary to be called before the first call to minimize(), as the default value is sensible.

Algorithm stops when the number of function evaluations done exceeds termcrit.maxCount, when the function values at the vertices of simplex are within termcrit.epsilon range or simplex becomes so small that it can enclosed in a box with termcrit.epsilon sides, whatever comes first.

Parameters

  • termcrit: Terminal criteria to be used, represented as cv::TermCriteria structure.

fn minimize(&mut self, x: &mut dyn ToInputOutputArray) -> Result<f64>

actually runs the algorithm and performs the minimization.

The sole input parameter determines the centroid of the starting simplex (roughly, it tells where to start), all the others (terminal criteria, initial step, function to be minimized) are supposed to be set via the setters before the call to this method or the default values (not always sensible) will be used.

Parameters

  • x: The initial point, that will become a centroid of an initial simplex. After the algorithm will terminate, it will be set to the point where the algorithm stops, the point of possible minimum.

Returns

The value of a function at the point found.

Loading content...

Implementors

Loading content...