Trait opencv::core::prelude::DownhillSolver

pub trait DownhillSolver: DownhillSolverConst + MinProblemSolver {
    fn as_raw_mut_DownhillSolver(&mut self) -> *mut c_void;

    fn set_init_step(&mut self, step: &dyn ToInputArray) -> Result<()> { ... }
}

Required methods

fn as_raw_mut_DownhillSolver(&mut self) -> *mut c_void

Provided methods

fn set_init_step(&mut self, step: &dyn ToInputArray) -> Result<()>

Sets the initial step that will be used in downhill simplex algorithm.

Step, together with initial point (given in DownhillSolver::minimize) are two n-dimensional vectors that are used to determine the shape of initial simplex. Roughly said, initial point determines the position of a simplex (it will become simplex’s centroid), while step determines the spread (size in each dimension) of a simplex. To be more precise, if are the initial step and initial point respectively, the vertices of a simplex will be: and for where denotes projections of the initial step of n-th coordinate (the result of projection is treated to be vector given by , where form canonical basis)

Parameters

• step: Initial step that will be used in algorithm. Roughly said, it determines the spread (size in each dimension) of an initial simplex.

Implementations

impl dyn DownhillSolver + '_

pub fn create(
    f: &Ptr<dyn MinProblemSolver_Function>,
    init_step: &dyn ToInputArray,
    termcrit: TermCriteria
) -> Result<Ptr<dyn DownhillSolver>>

This function returns the reference to the ready-to-use DownhillSolver object.

All the parameters are optional, so this procedure can be called even without parameters at all. In this case, the default values will be used. As default value for terminal criteria are the only sensible ones, MinProblemSolver::setFunction() and DownhillSolver::setInitStep() should be called upon the obtained object, if the respective parameters were not given to create(). Otherwise, the two ways (give parameters to createDownhillSolver() or miss them out and call the MinProblemSolver::setFunction() and DownhillSolver::setInitStep()) are absolutely equivalent (and will drop the same errors in the same way, should invalid input be detected).

Parameters

• f: Pointer to the function that will be minimized, similarly to the one you submit via MinProblemSolver::setFunction.
• initStep: Initial step, that will be used to construct the initial simplex, similarly to the one you submit via MinProblemSolver::setInitStep.
• termcrit: Terminal criteria to the algorithm, similarly to the one you submit via MinProblemSolver::setTermCriteria.

C++ default parameters

• f: PtrMinProblemSolver::Function()
• init_step: Mat_(1,1,0.0)
• termcrit: TermCriteria(TermCriteria::MAX_ITER+TermCriteria::EPS,5000,0.000001)

Implementors

impl DownhillSolver for PtrOfDownhillSolver