Package org.moeaframework.core.constraint

Class Between

java.lang.Object

org.moeaframework.core.constraint.AbstractConstraint

org.moeaframework.core.constraint.BoundedConstraint

org.moeaframework.core.constraint.Between

All Implemented Interfaces:

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

public class Between
extends BoundedConstraint

The between constraint, or <lower> <= <value> <= <upper>.

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.BoundedConstraint

epsilon, lower, upper

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

name, value

Constructor Summary

Constructors

Constructor	Description
Between(double lower, double upper)	Constructs a new between constraint.
Between(double lower, double upper, double epsilon)	Constructs a new between constraint.
Between(String name, double lower, double upper)	Constructs a new between constraint.
Between(String name, double lower, double upper, double epsilon)	Constructs a new between constraint.
Between(Between copy)	Constructs a copy of a between constraint.

Method Summary

Modifier and Type	Method	Description
Between	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 Between	values(double lower, double upper)	Constructs a new between constraint.
static Between	values(double lower, double upper, double epsilon)	Constructs a new between constraint.
static Between	values(String name, double lower, double upper)	Constructs a new between constraint.
static Between	values(String name, double lower, double upper, double epsilon)	Constructs a new between constraint.

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

equals, getDefinition, getEpsilon, getLower, getUpper, 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

Between

public Between(double lower,
 double upper)

Constructs a new between constraint.

Parameters:

lower - the lower threshold

upper - the upper threshold

Between

public Between(double lower,
 double upper,
 double epsilon)

Constructs a new between constraint.

Parameters:

lower - the lower threshold

upper - the upper threshold

epsilon - the epsilon value

Between

public Between(String name,
 double lower,
 double upper)

Constructs a new between constraint.

Parameters:

name - the name

lower - the lower threshold

upper - the upper threshold

Between

public Between(String name,
 double lower,
 double upper,
 double epsilon)

Constructs a new between constraint.

Parameters:

name - the name

lower - the lower threshold

upper - the upper threshold

epsilon - the epsilon value

Between

public Between(Between copy)

Constructs a copy of a between 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 Between 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

values

public static Between values(double lower,
 double upper)

Constructs a new between constraint.

Parameters:

lower - the lower threshold

upper - the upper threshold

Returns:

the constraint

values

public static Between values(double lower,
 double upper,
 double epsilon)

Constructs a new between constraint.

Parameters:

lower - the lower threshold

upper - the upper threshold

epsilon - the epsilon value

Returns:

the constraint

values

public static Between values(String name,
 double lower,
 double upper)

Constructs a new between constraint.

Parameters:

name - the name

lower - the lower threshold

upper - the upper threshold

Returns:

the constraint

values

public static Between values(String name,
 double lower,
 double upper,
 double epsilon)

Constructs a new between constraint.

Parameters:

name - the name

lower - the lower threshold

upper - the upper threshold

epsilon - the epsilon value

Returns:

the constraint