: Class IloCplex.BranchType

Overview

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ilog.cplex
Class IloCplex.BranchType

java.lang.Object
  |
  +--ilog.cplex.IloCplex.BranchType

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

This class identifies the branch type for BranchCallback. The class BranchType is limited in scope to the class BranchCallback. It is used by the method getBranchType to tell what kind of branch IloCplex is about to do:

BranchOnVariable indicates branching on a single variable.
BranchOnSOS1 indicates branching on an SOS of type 1.
BranchOnSOS2 indicates branching on an SOS of type 2.

See Also:: IloCplex.BranchCallback

Field Summary
`static IloCplex.BranchType`	`BranchOnSOS1` Indicates `IloCplex` `SOS1` branch intention.
`static IloCplex.BranchType`	`BranchOnSOS2` Indicates `IloCplex` `SOS2` branch intention.
`static IloCplex.BranchType`	`BranchOnVariable` Indicates `IloCplex` single variable branch intention.

Method Summary
`boolean`	`equals(java.lang.Object obj)` Identifies whether `obj` represents the same `BranchType` as the invoking object.
`java.lang.String`	`toString()` Returns readable string for possible cases of `SOS` types.

Methods inherited from class java.lang.Object

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

Field Detail

BranchOnVariable

public static final IloCplex.BranchType BranchOnVariable

Indicates IloCplex single variable branch intention. This branch type indicates that IloCplex intends to branch on a single variable.

BranchOnSOS1

public static final IloCplex.BranchType BranchOnSOS1

Indicates IloCplex SOS1 branch intention. This branch type indicates that IloCplex intends to branch on an SOS1.

BranchOnSOS2

public static final IloCplex.BranchType BranchOnSOS2

Indicates IloCplex SOS2 branch intention. This branch type indicates that IloCplex intends to branch on an SOS2.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Identifies whether obj represents the same BranchType as the invoking object.

Returns:: true if obj represents the same BranchType as the invoking object, otherwise returns false.
Overrides:: equals in class java.lang.Object

toString

public java.lang.String toString()

Returns readable string for possible cases of SOS types.

Returns:: BranchOnSOS1 for case 1
BranchOnSOS2 for case2
BranchOnVariable for the default.
Overrides:: toString in class java.lang.Object