Package org.moeaframework.core.constraint

Class LessThan

java.lang.Object

org.moeaframework.core.constraint.AbstractConstraint

org.moeaframework.core.constraint.ThresholdConstraint

org.moeaframework.core.constraint.LessThan

All Implemented Interfaces:

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

public class LessThan
extends ThresholdConstraint

The less than 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
LessThan(double threshold)	Constructs a new less than constraint.
LessThan(double threshold, double epsilon)	Constructs a new less than constraint.
LessThan(String name, double threshold)	Constructs a new less than constraint.
LessThan(String name, double threshold, double epsilon)	Constructs a new less than constraint.
LessThan(LessThan copy)	Constructs a copy of a less than constraint.

Method Summary

Modifier and Type	Method	Description
LessThan	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 LessThan	value(double threshold)	Constructs a new less than constraint.
static LessThan	value(double threshold, double epsilon)	Constructs a new less than constraint.
static LessThan	value(String name, double threshold)	Constructs a new less than constraint.
static LessThan	value(String name, double threshold, double epsilon)	Constructs a new less than 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

LessThan

public LessThan(double threshold)

Constructs a new less than constraint.

Parameters:

threshold - the threshold value

LessThan

public LessThan(double threshold,
 double epsilon)

Constructs a new less than constraint.

Parameters:

threshold - the threshold value

epsilon - the epsilon value

LessThan

public LessThan(String name,
 double threshold)

Constructs a new less than constraint.

Parameters:

name - the name

threshold - the threshold value

LessThan

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

Constructs a new less than constraint.

Parameters:

name - the name

threshold - the threshold value

epsilon - the epsilon value

LessThan

public LessThan(LessThan copy)

Constructs a copy of a less than 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 LessThan 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

value

public static LessThan value(double threshold)

Constructs a new less than constraint.

Parameters:

threshold - the threshold value

Returns:

the constraint

value

public static LessThan value(double threshold,
 double epsilon)

Constructs a new less than constraint.

Parameters:

threshold - the threshold value

epsilon - the epsilon value

Returns:

the constraint

value

public static LessThan value(String name,
 double threshold)

Constructs a new less than constraint.

Parameters:

name - the name

threshold - the threshold value

Returns:

the constraint

value

public static LessThan value(String name,
 double threshold,
 double epsilon)

Constructs a new less than constraint.

Parameters:

name - the name

threshold - the threshold value

epsilon - the epsilon value

Returns:

the constraint