Top Description Fields Constructors Methods
org.apache.commons.math3.optim.linear

public final Enum Relationship

extends Enum<Relationship>
Class Inheritance
Types of relationships between two cells in a Solver LinearConstraint.
Since
2.0

Field Summary

Modifier and TypeField and Description
public static final Relationship
EQ

Equality relationship.

public static final Relationship
GEQ

Greater than or equal relationship.

public static final Relationship
LEQ

Lesser than or equal relationship.

private final String
stringValue

Display string for the relationship.

Constructor Summary

AccessConstructor and Description
private
Relationship(String
Display string for the relationship.
stringValue)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public Relationship

Returns:

the opposite relationship.
oppositeRelationship()

Gets the relationship obtained when multiplying all coefficients by -1.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static Relationship
valueOf(String name)

public static Relationship[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

EQback to summary
public static final Relationship EQ

Equality relationship.

GEQback to summary
public static final Relationship GEQ

Greater than or equal relationship.

LEQback to summary
public static final Relationship LEQ

Lesser than or equal relationship.

stringValueback to summary
private final String stringValue

Display string for the relationship.

Constructor Detail

Relationshipback to summary
private Relationship(String stringValue)

Simple constructor.

Parameters
stringValue:String

Display string for the relationship.

Method Detail

oppositeRelationshipback to summary
public Relationship oppositeRelationship()

Gets the relationship obtained when multiplying all coefficients by -1.

Returns:Relationship

the opposite relationship.

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static Relationship valueOf(String name)
valuesback to summary
public static Relationship[] values()