Package org.moeaframework.core.constraint

Class Equal

java.lang.Object

org.moeaframework.core.constraint.AbstractConstraint

org.moeaframework.core.constraint.ThresholdConstraint

org.moeaframework.core.constraint.Equal

All Implemented Interfaces:

Serializable, Comparable<Constraint>, Constraint, Copyable<Constraint>, Defined, Named

public class Equal
extends ThresholdConstraint

The equality constraint, or <value> == <threshold>.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.moeaframework.core.Defined

Defined.ConstructorComparator

Field Summary

Fields inherited from class org.moeaframework.core.constraint.ThresholdConstraint

epsilon, threshold

Fields inherited from class org.moeaframework.core.constraint.AbstractConstraint

name, value

Constructor Summary

Constructors

Constructor	Description
Equal(double threshold)	Constructs a new equality constraint.
Equal(double threshold, double epsilon)	Constructs a new equality constraint.
Equal(String name, double threshold)	Constructs a new equality constraint.
Equal(String name, double threshold, double epsilon)	Constructs a new equality constraint.
Equal(Equal copy)	Constructs a copy of an equal constraint.

Method Summary

Modifier and Type	Method	Description
Equal	copy()	Creates and returns a copy of this object.
double	getMagnitudeOfViolation()	Returns the magnitude of constraint violation as a non-negative number, with 0.0 representing satisfied or feasible constraints.
static Equal	to(double threshold)	Constructs a new equality constraint.
static Equal	to(double threshold, double epsilon)	Constructs a new equality constraint.
static Equal	to(String name, double threshold)	Constructs a new equality constraint.
static Equal	to(String name, double threshold, double epsilon)	Constructs a new equality constraint.

Methods inherited from class org.moeaframework.core.constraint.ThresholdConstraint

equals, getDefinition, getEpsilon, getThreshold, hashCode, toString

Methods inherited from class org.moeaframework.core.constraint.AbstractConstraint

getName, getValue, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.moeaframework.core.constraint.Constraint

compareTo, isViolation, withValue

Constructor Details

Equal

public Equal(double threshold)

Constructs a new equality constraint.

Parameters:

threshold - the threshold value

Equal

public Equal(double threshold,
 double epsilon)

Constructs a new equality constraint.

Parameters:

threshold - the threshold value

epsilon - the epsilon value

Equal

public Equal(String name,
 double threshold)

Constructs a new equality constraint.

Parameters:

name - the name

threshold - the threshold value

Equal

public Equal(String name,
 double threshold,
 double epsilon)

Constructs a new equality constraint.

Parameters:

name - the name

threshold - the threshold value

epsilon - the epsilon value

Equal

public Equal(Equal copy)

Constructs a copy of an equal constraint.

Parameters:

copy - the constraint to copy

Method Details

getMagnitudeOfViolation

public double getMagnitudeOfViolation()

Description copied from interface: Constraint

Returns the magnitude of constraint violation as a non-negative number, with 0.0 representing satisfied or feasible constraints. When comparing two constraints, smaller magnitudes are considered better.

Returns:

the magnitude of constraint violation

copy

public Equal copy()

Description copied from interface: Copyable

Creates and returns a copy of this object. It is required that x.copy() is completely independent from x. This means any method invoked on x.copy() in no way alters the state of x and vice versa. It is typically the case that x.copy().getClass() == x.getClass() and x.copy().equals(x).

Returns:

the copy

to

public static Equal to(double threshold)

Constructs a new equality constraint.

Parameters:

threshold - the threshold value

Returns:

the constraint

to

public static Equal to(double threshold,
 double epsilon)

Constructs a new equality constraint.

Parameters:

threshold - the threshold value

epsilon - the epsilon value

Returns:

the constraint

to

public static Equal to(String name,
 double threshold)

Constructs a new equality constraint.

Parameters:

name - the name

threshold - the threshold value

Returns:

the constraint

to

public static Equal to(String name,
 double threshold,
 double epsilon)

Constructs a new equality constraint.

Parameters:

name - the name

threshold - the threshold value

epsilon - the epsilon value

Returns:

the constraint