3.4.0
tigl::CTiglPointTranslator::SegmentProjection Class Reference
+ Inheritance diagram for tigl::CTiglPointTranslator::SegmentProjection:

Public Member Functions

TIGL_EXPORT double getFunctionValue (const double *x) const override
 returns the objective function for the parameter vector x More...
 
TIGL_EXPORT void getGradient (const double *x, double *dx) const override
 returns the gradient dx for the parameter vector x More...
 
TIGL_EXPORT void getGradientHessian (const double *x, double *dx, double *H) const override
 Sometimes it is more efficient to calculate gradient and hessian at once for these cases this function is provided. In the default implementation, it calls getGradient and getHessian succesively. More...
 
TIGL_EXPORT void getHessian (const double *x, double *H) const override
 returns the hessian matrix for the parameter vector x More...
 
TIGL_EXPORT int getParameterCount () const override
 
TIGL_EXPORT bool hasAnalyticGradient () const override
 
TIGL_EXPORT bool hasAnalyticHessian () const override
 
TIGL_EXPORT SegmentProjection (const CTiglPointTranslator &t, const CTiglPoint &a, const CTiglPoint &b, const CTiglPoint &c, const CTiglPoint &d)
 
TIGL_EXPORT void setProjectionPoint (const CTiglPoint &p)
 
TIGL_EXPORT ~SegmentProjection () override
 
- Public Member Functions inherited from tigl::ITiglObjectiveFunction
virtual TIGL_EXPORT void getNumericalGradient (const double *x, double *dx) const
 provides a routine for the numerical gradient calculation More...
 
virtual TIGL_EXPORT void getNumericalHessian (const double *x, double *H) const
 provides a routine for the numerical hessian calculation More...
 
TIGL_EXPORT ITiglObjectiveFunction ()
 
TIGL_EXPORT void setNumericalStepSize (double h)
 
virtual TIGL_EXPORT ~ITiglObjectiveFunction ()
 

Private Attributes

const CTiglPoint_a
 
const CTiglPoint_b
 
const CTiglPoint_c
 
const CTiglPointTranslator_t
 
CTiglPoint _x
 

Constructor & Destructor Documentation

◆ SegmentProjection()

TIGL_EXPORT tigl::CTiglPointTranslator::SegmentProjection::SegmentProjection ( const CTiglPointTranslator t,
const CTiglPoint a,
const CTiglPoint b,
const CTiglPoint c,
const CTiglPoint d 
)
inline

◆ ~SegmentProjection()

TIGL_EXPORT tigl::CTiglPointTranslator::SegmentProjection::~SegmentProjection ( )
inlineoverride

Member Function Documentation

◆ getFunctionValue()

TIGL_EXPORT double tigl::CTiglPointTranslator::SegmentProjection::getFunctionValue ( const double *  x) const
overridevirtual

returns the objective function for the parameter vector x

Implements tigl::ITiglObjectiveFunction.

◆ getGradient()

TIGL_EXPORT void tigl::CTiglPointTranslator::SegmentProjection::getGradient ( const double *  x,
double *  dx 
) const
overridevirtual

returns the gradient dx for the parameter vector x

Reimplemented from tigl::ITiglObjectiveFunction.

◆ getGradientHessian()

TIGL_EXPORT void tigl::CTiglPointTranslator::SegmentProjection::getGradientHessian ( const double *  x,
double *  dx,
double *  H 
) const
overridevirtual

Sometimes it is more efficient to calculate gradient and hessian at once for these cases this function is provided. In the default implementation, it calls getGradient and getHessian succesively.

Reimplemented from tigl::ITiglObjectiveFunction.

◆ getHessian()

TIGL_EXPORT void tigl::CTiglPointTranslator::SegmentProjection::getHessian ( const double *  x,
double *  H 
) const
overridevirtual

returns the hessian matrix for the parameter vector x

Reimplemented from tigl::ITiglObjectiveFunction.

◆ getParameterCount()

TIGL_EXPORT int tigl::CTiglPointTranslator::SegmentProjection::getParameterCount ( ) const
inlineoverridevirtual

◆ hasAnalyticGradient()

TIGL_EXPORT bool tigl::CTiglPointTranslator::SegmentProjection::hasAnalyticGradient ( ) const
inlineoverridevirtual

◆ hasAnalyticHessian()

TIGL_EXPORT bool tigl::CTiglPointTranslator::SegmentProjection::hasAnalyticHessian ( ) const
inlineoverridevirtual

◆ setProjectionPoint()

TIGL_EXPORT void tigl::CTiglPointTranslator::SegmentProjection::setProjectionPoint ( const CTiglPoint p)

Field Documentation

◆ _a

const CTiglPoint& tigl::CTiglPointTranslator::SegmentProjection::_a
private

◆ _b

const CTiglPoint & tigl::CTiglPointTranslator::SegmentProjection::_b
private

◆ _c

const CTiglPoint & tigl::CTiglPointTranslator::SegmentProjection::_c
private

◆ _t

const CTiglPointTranslator& tigl::CTiglPointTranslator::SegmentProjection::_t
private

◆ _x

CTiglPoint tigl::CTiglPointTranslator::SegmentProjection::_x
private

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