Class ConstraintPenaltyCalculator.ConstraintEvaluation

java.lang.Object

neqsim.process.util.optimizer.ConstraintPenaltyCalculator.ConstraintEvaluation

All Implemented Interfaces:

Serializable

Enclosing class:

ConstraintPenaltyCalculator

public static final class ConstraintPenaltyCalculator.ConstraintEvaluation
extends Object
implements Serializable

Snapshot of a single constraint evaluation.

Version:

1.0

Author:

NeqSim Development Team

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description
private final double	margin
private final String	name
private final double	penalty
private final boolean	satisfied
private static final long	serialVersionUID
private final ConstraintSeverityLevel	severity

Constructor Summary

Constructors

Constructor	Description
ConstraintEvaluation(String name, ConstraintSeverityLevel severity, double margin, boolean satisfied, double penalty, String description)	Constructs a constraint evaluation snapshot.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description.
double	getMargin()	Gets the constraint margin.
String	getName()	Gets the constraint name.
double	getPenalty()	Gets the penalty value.
ConstraintSeverityLevel	getSeverity()	Gets the severity level.
boolean	isSatisfied()	Checks if the constraint is satisfied.
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

private final String name

severity

private final ConstraintSeverityLevel severity

margin

private final double margin

satisfied

private final boolean satisfied

penalty

private final double penalty

description

private final String description

Constructor Details

ConstraintEvaluation

public ConstraintEvaluation(String name,
 ConstraintSeverityLevel severity,
 double margin,
 boolean satisfied,
 double penalty,
 String description)

Constructs a constraint evaluation snapshot.

Parameters:

name - constraint name

severity - severity level

margin - constraint margin

satisfied - whether the constraint is satisfied

penalty - computed penalty

description - constraint description

Method Details

getName

public String getName()

Gets the constraint name.

Returns:

name

getSeverity

public ConstraintSeverityLevel getSeverity()

Gets the severity level.

Returns:

severity

getMargin

public double getMargin()

Gets the constraint margin.

Returns:

margin (positive = satisfied)

isSatisfied

public boolean isSatisfied()

Checks if the constraint is satisfied.

Returns:

true if satisfied

getPenalty

public double getPenalty()

Gets the penalty value.

Returns:

penalty (0 if satisfied)

getDescription

public String getDescription()

Gets the description.

Returns:

description

toString

public String toString()

Overrides:

toString in class Object