standardized_objective.StandardizedObjective Class Reference

Standardized objective response function. More...

Inheritance diagram for standardized_objective.StandardizedObjective:

Collaboration diagram for standardized_objective.StandardizedObjective:

Public Member Functions
def	__init__ (self, Kratos.Parameters parameters, MasterControl master_control, OptimizationProblem optimization_problem, int required_buffer_size=2)
float	GetInitialValue (self)
float	CalculateStandardizedValue (self, KratosOA.CollectiveExpression control_field, bool save_value=True)
float	GetValue (self, int step_index=0)
float	GetStandardizedValue (self, int step_index=0)
KratosOA.CollectiveExpression	CalculateStandardizedGradient (self, bool save_field=True)
float	GetRelativeChange (self)
float	GetAbsoluteChange (self)
dict	GetInfo (self)

Detailed Description

Standardized objective response function.

This class transformed a user-given optimization problem into the standard format.
Supported objective types:
    "minimization",
    "maximization"

Constructor & Destructor Documentation

__init__()

def standardized_objective.StandardizedObjective.__init__	(		self,
		Kratos.Parameters	parameters,
		MasterControl	master_control,
		OptimizationProblem	optimization_problem,
		int	required_buffer_size = 2
	)

Member Function Documentation

CalculateStandardizedGradient()

KratosOA.CollectiveExpression standardized_objective.StandardizedObjective.CalculateStandardizedGradient	(		self,
		bool	save_field = True
	)

CalculateStandardizedValue()

float standardized_objective.StandardizedObjective.CalculateStandardizedValue	(		self,
		KratosOA.CollectiveExpression	control_field,
		bool	save_value = True
	)

GetAbsoluteChange()

float standardized_objective.StandardizedObjective.GetAbsoluteChange

(

self

)

GetInfo()

dict standardized_objective.StandardizedObjective.GetInfo

(

self

)

GetInitialValue()

float standardized_objective.StandardizedObjective.GetInitialValue

(

self

)

GetRelativeChange()

float standardized_objective.StandardizedObjective.GetRelativeChange

(

self

)

GetStandardizedValue()

float standardized_objective.StandardizedObjective.GetStandardizedValue	(		self,
		int	step_index = 0
	)

GetValue()

float standardized_objective.StandardizedObjective.GetValue	(		self,
		int	step_index = 0
	)

---

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

• /home/runner/work/Documentation/Documentation/master/applications/OptimizationApplication/python_scripts/algorithms/standardized_objective.py