Class ProcessSimulationEvaluator.ObjectiveDefinition

java.lang.Object

neqsim.process.util.optimizer.ProcessSimulationEvaluator.ObjectiveDefinition

All Implemented Interfaces:

Serializable

Enclosing class:

ProcessSimulationEvaluator

public static class ProcessSimulationEvaluator.ObjectiveDefinition
extends Object
implements Serializable

Definition of an objective function.

Version:

1.0

Author:

NeqSim Development Team

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProcessSimulationEvaluator.ObjectiveDefinition.Direction	Optimization direction.

Field Summary

Fields

Modifier and Type	Field	Description
private ProcessSimulationEvaluator.ObjectiveDefinition.Direction	direction
private ToDoubleFunction<ProcessSystem>	evaluator
private String	name
private static final long	serialVersionUID
private String	unit
private double	weight

Constructor Summary

Constructors

Constructor	Description
ObjectiveDefinition()	Default constructor.
ObjectiveDefinition(String name, ToDoubleFunction<ProcessSystem> evaluator, ProcessSimulationEvaluator.ObjectiveDefinition.Direction direction)	Constructor with evaluator.

Method Summary

Modifier and Type	Method	Description
double	evaluate(ProcessSystem process)	Evaluates the objective for given process.
double	evaluateRaw(ProcessSystem process)	Gets the raw (non-sign-adjusted) objective value.
ProcessSimulationEvaluator.ObjectiveDefinition.Direction	getDirection()
ToDoubleFunction<ProcessSystem>	getEvaluator()
String	getName()
String	getUnit()
double	getWeight()
void	setDirection(ProcessSimulationEvaluator.ObjectiveDefinition.Direction direction)
void	setEvaluator(ToDoubleFunction<ProcessSystem> evaluator)
void	setName(String name)
void	setUnit(String unit)
void	setWeight(double weight)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

private String name

direction

private ProcessSimulationEvaluator.ObjectiveDefinition.Direction direction

unit

private String unit

weight

private double weight

evaluator

private transient ToDoubleFunction<ProcessSystem> evaluator

Constructor Details

ObjectiveDefinition

public ObjectiveDefinition()

Default constructor.

ObjectiveDefinition

public ObjectiveDefinition(String name,
 ToDoubleFunction<ProcessSystem> evaluator,
 ProcessSimulationEvaluator.ObjectiveDefinition.Direction direction)

Constructor with evaluator.

Parameters:

name - objective name

evaluator - evaluation function

direction - optimization direction

Method Details

getName

public String getName()

setName

public void setName(String name)

getDirection

public ProcessSimulationEvaluator.ObjectiveDefinition.Direction getDirection()

setDirection

public void setDirection(ProcessSimulationEvaluator.ObjectiveDefinition.Direction direction)

getUnit

public String getUnit()

setUnit

public void setUnit(String unit)

getWeight

public double getWeight()

setWeight

public void setWeight(double weight)

getEvaluator

public ToDoubleFunction<ProcessSystem> getEvaluator()

setEvaluator

public void setEvaluator(ToDoubleFunction<ProcessSystem> evaluator)

evaluate

public double evaluate(ProcessSystem process)

Evaluates the objective for given process.

Parameters:

process - the process system

Returns:

objective value (sign-adjusted for minimization)

evaluateRaw

public double evaluateRaw(ProcessSystem process)

Gets the raw (non-sign-adjusted) objective value.

Parameters:

process - the process system

Returns:

raw objective value