ilog.cplex
Class IloCplex.Quality

java.lang.Object
  extended byilog.cplex.IloCplex.Quality
Enclosing class:
IloCplex

public static class IloCplex.Quality
extends java.lang.Object

Objects of this class contain information computed to measure the quality of a solution.

The possible quality measures are declared in IloCplex.QualityType. A quality object is returned by the method IloCplex.getQuality. The returned quality object contains its type and the numeric value of the requested quality measure. For many quality measures, the value is attained at a specific constraint or variable. In such cases, the relevant constraint or variable is contained in the quality object as well, unless the constraint has been implicitly created as a result of automatic linearization. Methods are provided to query all information stored in a quality object.

See Also:
IloCplex.QualityType, IloCplex.getQuality(ilog.cplex.IloCplex.QualityType)

Constructor Summary
IloCplex.Quality()
           
 
Method Summary
 IloConstraint getConstraint()
          Returns the constraint for which the quality measure is attained, if any.
 IloNumVar getNumVar()
          Returns the variable at which the quality measure is attained, if any.
 IloCplex.QualityType getQualityType()
          Returns the IloCplex.QualityType of the invoking quality measure.
 double getValue()
          Returns the numeric value of the invoking quality measure.
 java.lang.String toString()
          Returns a string with the numeric value of the invoking quality measure.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IloCplex.Quality

public IloCplex.Quality()
Method Detail

getValue

public double getValue()
Returns the numeric value of the invoking quality measure.

Returns:
The numeric value of the invoking quality measure.

getNumVar

public IloNumVar getNumVar()
Returns the variable at which the quality measure is attained, if any. Otherwise, null is returned.

Returns:
The variable at which the quality measure is attained.

getConstraint

public IloConstraint getConstraint()
Returns the constraint for which the quality measure is attained, if any. Otherwise, null is returned.

Returns:
The constraint for which the quality measure is attained.

toString

public java.lang.String toString()
Returns a string with the numeric value of the invoking quality measure.

Returns:
A string with the numeric value of the invoking quality measure.

getQualityType

public IloCplex.QualityType getQualityType()
Returns the IloCplex.QualityType of the invoking quality measure.

Returns:
The IloCplex.QualityType of the invoking quality measure.