org.moeaframework.core.variable
Class RealVariable

java.lang.Object
  org.moeaframework.core.variable.RealVariable

All Implemented Interfaces:

Serializable, Variable

public class RealVariable
extends Object
implements Variable

Decision variable for real values.

See Also:

Serialized Form

Constructor Summary

RealVariable(double lowerBound, double upperBound)
Constructs a real variable in the range lowerBound <= x <= upperBound with an uninitialized value.

RealVariable(double value, double lowerBound, double upperBound)
Constructs a real variable in the range lowerBound <= x <= upperBound with the specified initial value.

Method Summary

RealVariable	copy() Returns an independent copy of this decision variable.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
double	getLowerBound() Returns the lower bound of this decision variable.
double	getUpperBound() Returns the upper bound of this decision variable.
double	getValue() Returns the current value of this decision variable.
int	hashCode() Returns a hash code value for the object.
void	setValue(double value) Sets the value of this decision variable.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealVariable

public RealVariable(double lowerBound,
                    double upperBound)

Constructs a real variable in the range lowerBound <= x <= upperBound with an uninitialized value.

Parameters:

lowerBound - the lower bound of this decision variable, inclusive

upperBound - the upper bound of this decision variable, inclusive

RealVariable

public RealVariable(double value,
                    double lowerBound,
                    double upperBound)

Constructs a real variable in the range lowerBound <= x <= upperBound with the specified initial value.

Parameters:

value - the initial value of this decision variable

lowerBound - the lower bound of this decision variable, inclusive

upperBound - the upper bound of this decision variable, inclusive

Throws:

IllegalArgumentException - if the value is out of bounds (value < lowerBound) || (value > upperBound)

Method Detail

getValue

public double getValue()

Returns the current value of this decision variable.

Returns:

the current value of this decision variable

setValue

public void setValue(double value)

Sets the value of this decision variable.

Parameters:

value - the new value for this decision variable

Throws:

IllegalArgumentException - if the value is out of bounds (value < getLowerBound()) || (value > getUpperBound())

getLowerBound

public double getLowerBound()

Returns the lower bound of this decision variable.

Returns:

the lower bound of this decision variable, inclusive

getUpperBound

public double getUpperBound()

Returns the upper bound of this decision variable.

Returns:

the upper bound of this decision variable, inclusive

copy

public RealVariable copy()

Description copied from interface: Variable

Returns an independent copy of this decision variable. 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).

Specified by:

copy in interface Variable

Returns:

an independent copy of this decision variable

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), Hashtable