Changeset 276


Ignore:
Timestamp:
Mar 16, 2006 1:50:23 PM (14 years ago)
Author:
lou
Message:

Documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/CbcBranchActual.hpp

    r231 r276  
    192192  virtual double infeasibility(int & preferredWay) const;
    193193
    194   /** Set bounds to contain the current solution.
    195 
    196     More precisely, for the variable associated with this object, take the
    197     value given in the current solution, force it within the current bounds
    198     if required, then set the bounds to fix the variable at the integer
    199     nearest the solution value.
     194  /** Set bounds to fix the variable at the current (integer) value.
     195
     196    Given an integer value, set the lower and upper bounds to fix the
     197    variable. The algorithm takes a bit of care in order to compensate for
     198    minor numerical inaccuracy.
    200199  */
    201200  virtual void feasibleRegion();
    202201
    203   /// Creates a branching object
     202  /** Creates a branching object
     203
     204    The preferred direction is set by \p way, -1 for down, +1 for up.
     205  */
    204206  virtual CbcBranchingObject * createBranch(int way) ;
    205207
     
    214216      point in the good direction.
    215217
    216     The preferred branching object will force the variable to be +/-1 from
    217     its current value, depending on the reduced cost and objective sense.  If
    218     movement in the direction which improves the objective is impossible due
    219     to bounds on the variable, the branching object will move in the other
    220     direction.  If no movement is possible, the method returns NULL.
     218    The preferred branching object will force the variable to be either the
     219    floor or ceiling of its current value, depending on the reduced cost and
     220    objective sense. If movement in the direction which improves the
     221    objective is impossible due to bounds on the variable, the branching
     222    object will move in the other direction.  If no movement is possible, the
     223    method returns NULL.
    221224
    222225    Only the bounds on this variable are considered when determining if the new
     
    369372
    370373    Specifies a simple two-way branch. Let \p value = x*. One arm of the
    371     branch will be is lb <= x <= floor(x*), the other ceil(x*) <= x <= ub.
     374    branch will be lb <= x <= floor(x*), the other ceil(x*) <= x <= ub.
    372375    Specify way = -1 to set the object state to perform the down arm first,
    373376    way = 1 for the up arm.
Note: See TracChangeset for help on using the changeset viewer.