Class cv::MinProblemSolver#

Basic interface for all solvers.

#include <opencv2/core/optim.hpp>

Collaboration diagram for cv::MinProblemSolver:

Public Member Functions#

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

Detailed Description#

Basic interface for all solvers.

Member Function Documentation#

getFunction()#

Ptr< Function > cv::MinProblemSolver::getFunction()

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.

getTermCriteria()#

TermCriteria cv::MinProblemSolver::getTermCriteria()

Getter for the previously set terminal criteria for this algorithm.

Returns

Deep copy of the terminal criteria used at the moment.

minimize()#

double cv::MinProblemSolver::minimize(InputOutputArray x)

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.

setFunction()#

void cv::MinProblemSolver::setFunction(const Ptr< Function > & f)

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.

setTermCriteria()#

void cv::MinProblemSolver::setTermCriteria(const TermCriteria & termcrit)

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.

Source file#

The documentation for this class was generated from the following file:

opencv2/core/optim.hpp