Population::ScalingOperations::GaScaleFactorParams Class Reference

This class should be used (directly or by inheritance) by scaling operations which use user defined factor of scaling. More...

#include <source/ScalingOperations.h>

Inherits Population::GaScalingParams.

List of all members.

Public Member Functions
	GaScaleFactorParams (float factor)
	This constructor initializes parameters with user defined scale factor.
	GaScaleFactorParams ()
	This constructor initializes parameters with default values. Default scaling factor is 1.
virtual GaParameters *GACALL	Clone () const
	More details are given in specification of GaParameters::Clone method.
float GACALL	GetFactor () const
	This method is not thread-safe.
void GACALL	SetFactor (float factor)
	SetFactor method sets scaling factor.
Private Attributes
float	_factor
	Scaling factor.

---

Detailed Description

This class should be used (directly or by inheritance) by scaling operations which use user defined factor of scaling.

This class has no built-in synchronizator, so LOCK_OBJECT and LOCK_THIS_OBJECT macros cannot be used with instances of this class. No public or private methods are thread-safe.

---

Constructor & Destructor Documentation

Population::ScalingOperations::GaScaleFactorParams::GaScaleFactorParams

(

float

factor

)

[inline]

This constructor initializes parameters with user defined scale factor.

Parameters:

factor

scaling factor.

Population::ScalingOperations::GaScaleFactorParams::GaScaleFactorParams

(

)

[inline]

This constructor initializes parameters with default values. Default scaling factor is 1.

---

Member Function Documentation

virtual GaParameters* GACALL Population::ScalingOperations::GaScaleFactorParams::Clone

(

)

const [inline, virtual]

More details are given in specification of GaParameters::Clone method.

This method is not thread-safe.

Implements Common::GaParameters.

float GACALL Population::ScalingOperations::GaScaleFactorParams::GetFactor

(

)

const [inline]

This method is not thread-safe.

Returns:

Method returns scaling factor.

void GACALL Population::ScalingOperations::GaScaleFactorParams::SetFactor

(

float

factor

)

[inline]

SetFactor method sets scaling factor.

This method is not thread-safe.

Parameters:

factor

scaling factor.

---

Member Data Documentation

float Population::ScalingOperations::GaScaleFactorParams::_factor [private]

Scaling factor.

---

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

• source/ScalingOperations.h