AffineRescaledParameterOptimization Class Reference

#include <ImFusion/Base/ParameterOptimization.h>

Decorator that subtracts shift, then multiplies by scale to every value before it is passed to the optimizer. More...

Inheritance diagram for AffineRescaledParameterOptimization:

Detailed Description

Decorator that subtracts shift, then multiplies by scale to every value before it is passed to the optimizer.

Useful for adapting the step-size to the different parameters over which optimization occurs.

Public Member Functions
	AffineRescaledParameterOptimization (const ParameterWrapperBase &arg, double shift, double scale)
	AffineRescaledParameterOptimization (const AffineRescaledParameterOptimization &other)
int	dim () const override
	The number of (scalar) parameters wrapped by this object.
void	deserialize (const double *x) override
	Update the stored references from a double representation.
void	serialize (double *x) const override
	Updates a double representation from the stored references.
std::string	name (int i) const override
	Name of the ith parameter, used for display purposes.
std::unique_ptr< ParameterWrapperBase >	clone () const override
	Clone function.

Member Function Documentation

dim()

int dim ( ) const

inlineoverridevirtual

The number of (scalar) parameters wrapped by this object.

Implements ParameterWrapperBase.

deserialize()

void deserialize ( const double * v )

overridevirtual

Update the stored references from a double representation.

Implements ParameterWrapperBase.

serialize()

void serialize ( double * v ) const

overridevirtual

Updates a double representation from the stored references.

Implements ParameterWrapperBase.

name()

std::string name ( int i ) const

inlineoverridevirtual

Name of the ith parameter, used for display purposes.

Implements ParameterWrapperBase.

clone()

std::unique_ptr< ParameterWrapperBase > clone ( ) const

inlineoverridevirtual

Clone function.

Implements ParameterWrapperBase.

---

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

• ImFusion/Base/ParameterOptimization.h