anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction Class Reference

Represents objective function being optimized, implemented as a MATLAB file. More...

Inheritance diagram for anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction:

Public Member Functions
	MatlabFunction (int num_dims, const string &func, const string &grad_func="", double h=1e-3)
	Constructor. More...
double	calc (const double *x) const
	Evaluates MATLAB objective function. More...
void	getGradient (const double *x, double *grad)
	Evaluates MATLAB gradient function. More...
double	getGradientEps () const
	Gradient epsilon. More...
int	getDims () const
	Return number of dimensions. More...
MxArray	toStruct () const
	Convert object to MxArray. More...
Public Member Functions inherited from cv::MinProblemSolver::Function
virtual	~Function ()

Static Public Member Functions
static Ptr< MatlabFunction >	create (const MxArray &s)
	Factory function. More...

Detailed Description

Represents objective function being optimized, implemented as a MATLAB file.

Definition at line 20 of file ConjGradSolver_.cpp.

Constructor & Destructor Documentation

MatlabFunction()

anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::MatlabFunction ( int  num_dims, const string &  func, const string &  grad_func = "", double  h = 1e-3  )

inline

Constructor.

Parameters

num_dims	number of variables of the objective function
func	name of an M-file that computes the objective function
grad_func	name of an M-file that computes the gradient of the objective function. Can be empty.
h	gradient epsilon

Definition at line 30 of file ConjGradSolver_.cpp.

Member Function Documentation

calc()

double anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::calc ( const double *  x ) const

inlinevirtual

Evaluates MATLAB objective function.

Parameters

[in]

x

input array of length dims

Returns

objective function evaluated at x (scalar value)

Calculates y = F(x), for the scalar-valued multivariate objective function evaluated at the dims -dimensional point x

Example:

% the following MATLAB function implements the Rosenbrock function.
function f = rosenbrock(x)
    dims = numel(x);  % dims == 2
    f = (x(1) - 1)^2 + 100*(x(2) - x(1)^2)^2;
end

Implements cv::MinProblemSolver::Function.

Definition at line 50 of file ConjGradSolver_.cpp.

create()

static Ptr<MatlabFunction> anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::create ( const MxArray &  s )

inlinestatic

Factory function.

Parameters

s	input MxArray structure with the following fields: dims fun gradfun (optional, default '') gradeps (optional, default 1e-3)

Returns

smart pointer to newly created instance

Definition at line 166 of file ConjGradSolver_.cpp.

getDims()

int anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::getDims ( ) const

inlinevirtual

Return number of dimensions.

Returns

dimensionality of the objective function domain

Implements cv::MinProblemSolver::Function.

Definition at line 140 of file ConjGradSolver_.cpp.

getGradient()

void anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::getGradient ( const double *  x, double *  grad  )

inlinevirtual

Evaluates MATLAB gradient function.

Parameters

[in]	x	input array of length dims
[out]	grad	output array of length dims

Evaluates gradient of multivariate function at the specified point, by computing grad = del F(x), where grad_i = dF/dx_i for i=1:dims (partial derivatives w.r.t each dimension).

Example:

function df = rosenbrockGrad(x)
    dims = numel(x);  % dims == 2
    df = [2*(x(1)-1) - 400*x(1)*(x(2)-x(1)^2), 200*(x(2)-x(1)^2)];
end

Reimplemented from cv::MinProblemSolver::Function.

Definition at line 95 of file ConjGradSolver_.cpp.

getGradientEps()

double anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::getGradientEps ( ) const

inlinevirtual

Gradient epsilon.

Returns

gradient eps

Reimplemented from cv::MinProblemSolver::Function.

Definition at line 132 of file ConjGradSolver_.cpp.

toStruct()

MxArray anonymous_namespace{ConjGradSolver_.cpp}::MatlabFunction::toStruct ( ) const

inline

Convert object to MxArray.

Returns

output MxArray structure

Definition at line 148 of file ConjGradSolver_.cpp.

---

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

• src/+cv/private/ConjGradSolver_.cpp