MathUtils::Sphere Class Reference

Sphere function functor (for testing optimization). f(x) = sum(x[i]^2) for all i. Global minimum at origin with f = 0. More...

#include <MathUtils_FunctorVector.hxx>

Public Member Functions
bool	Value (const math_Vector &theX, double &theY) const
	Evaluates the sphere function.
bool	Gradient (const math_Vector &theX, math_Vector &theG) const
	Evaluates the gradient of the sphere function.
bool	Values (const math_Vector &theX, double &theY, math_Vector &theG) const
	Evaluates both value and gradient.

Detailed Description

Sphere function functor (for testing optimization). f(x) = sum(x[i]^2) for all i. Global minimum at origin with f = 0.

Usage:

Sphere aSphere;
math_Vector aStart(1, 3);
aStart.Init(1.0);  // Start at (1, 1, 1)
auto aResult = MathOpt::Powell(aSphere, aStart);
// Should converge to (0, 0, 0)

Member Function Documentation

Gradient()

bool MathUtils::Sphere::Gradient ( const math_Vector & theX, math_Vector & theG ) const

inline

Evaluates the gradient of the sphere function.

Parameters

[in]	theX	input vector
[out]	theG	gradient vector

Returns

true (always succeeds)

Value()

bool MathUtils::Sphere::Value ( const math_Vector & theX, double & theY ) const

inline

Evaluates the sphere function.

Parameters

[in]	theX	input vector
[out]	theY	function value

Returns

true (always succeeds)

Values()

bool MathUtils::Sphere::Values ( const math_Vector & theX, double & theY, math_Vector & theG ) const

inline

Evaluates both value and gradient.

Parameters

[in]	theX	input vector
[out]	theY	function value
[out]	theG	gradient vector

Returns

true (always succeeds)

---

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

• MathUtils_FunctorVector.hxx