Returns the left depth of the current node in the search tree.

Namespace: ILOG.CPLEX
Assembly: ILOG.CPLEX (in ILOG.CPLEX.dll) Version: 22.1.1.0

Syntax

C#
public int GetLeftDepth()
Visual Basic
Public Function GetLeftDepth As Integer

Return Value

The left depth of the current node.

Remarks

The root node is depth 0 (zero); the left depth of other nodes is the number of times that the first goal in a call to Cplex.Or has been taken when branching down from the root to the current node.

When Cplex.Or is called with more than two arguments, this call is translated into a sequence of or goals with two children each. For example, Cplex.Or(goal1, goal2, goal3); is internally translated into Cplex.Or(goal1, Cplex.Or(goal2, goal3)); to form a binary tree. This transformation is accounted for when defining the left depth of a node.

This method can be called only from the methods init and check.

See Also