Initializing help system before first use

XpressProblem.BranchObject Class

Subclass of XPRSbranchobject that allows using Variable instances to specify bounds and constraints. Instances of this class always expects bounds and expressions to be specified in terms of the original Space (not presolved space).
Inheritance Hierarchy
System.Object
   Optimizer.XPRSobject
     Optimizer.XPRSbranchobject
       Optimizer.Objects.XpressProblem.BranchObject

Namespace:   Optimizer.Objects
Assembly:  xprsdn (in xprsdn.dll) Version: 44.01.01
Syntax
C# 
public class BranchObject : XPRSbranchobject

The XpressProblem.BranchObject type exposes the following members.

Properties
  Name Description
Public property ObjectPointer
Returns the C language 'pointer' to the native object that this managed class is wrapping. For internal FICO use only.
(Inherited from XPRSobject.)
Top
Methods
  Name Description
Public method AddBound
Add a single bound to this branch object.
Public method AddBounds(Int32, Int32, Char, Int32, Double)
Adds new bounds to a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method AddBounds(Int32, Int32, Char, Variable, Double)
Add bounds to this branching object. The function takes three parallel Arrays ( bndtype, variables, bndval) that specify the bounds to be added. Each of these arrays must be of length at least nbounds and for each i in [0,nbounds[ the bound variable[i] bndtype[i] bndval[i] is added.
Public method AddBranches
Adds new, empty branches to a user defined branching object.
(Inherited from XPRSbranchobject.)
Public method AddConstraint
Add a row/cut to this branch object.
Public method AddCuts
Adds stored user cuts as new constraints to a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method AddMsgHandlerCallback(TextWriter) (Inherited from XPRSobject.)
Public method AddMsgHandlerCallback(MsgHandlerCallback)
Add MsgHandler callback.
(Inherited from XPRSbranchobject.)
Public method AddMsgHandlerCallback(MsgHandlerCallback, Int32)
Add MsgHandler callback with the specified priority.
(Inherited from XPRSbranchobject.)
Public method AddMsgHandlerCallback(MsgHandlerCallback, Object)
Add MsgHandler callback with a user object that is passed to the callback on invocation.
(Inherited from XPRSbranchobject.)
Public method AddMsgHandlerCallback(MsgHandlerCallback, Object, Int32)
Add MsgHandler callback with specified priority and a user object that is passed to the callback on invocation.
(Inherited from XPRSbranchobject.)
Public method AddRows
Adds new constraints to a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method CopyCallbacks
Copy callbacks to this XPRSbranchobject from another
(Inherited from XPRSbranchobject.)
Public method Destroy
Frees all memory for a user branching object, when the object was not stored with the Optimizer.
(Inherited from XPRSbranchobject.)
Public method Dispose (Inherited from XPRSobject.)
Public method Equals (Inherited from XPRSobject.)
Protected method Finalize (Inherited from XPRSobject.)
Public method GetBounds(Int32)
Returns the bounds for a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method GetBounds(Int32, Int32, Char, Int32, Double)
Returns the bounds for a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method GetBranches
Returns the number of branches of a branching object.
(Inherited from XPRSbranchobject.)
Public method GetHashCode (Inherited from XPRSobject.)
Public method GetID
Returns the unique identifier assigned to a branching object.
(Inherited from XPRSbranchobject.)
Public method GetLastError()
Returns the last error encountered during a call to the given branch object.
(Inherited from XPRSbranchobject.)
Public method GetLastError(Int32)
Returns the last error encountered during a call to the given branch object.
(Inherited from XPRSbranchobject.)
Public method GetObjectTypeName
Function to access the type name of an object referenced using the generic Optimizer object pointer XPRSobject.
(Inherited from XPRSobject.)
Public method GetRows
Returns the constraints for a branch of a user branching object.
(Inherited from XPRSbranchobject.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method RemoveMsgHandlerCallback
Remove MsgHandler callback.
(Inherited from XPRSbranchobject.)
Public method RemoveMsgHandlerCallbacks
Remove all MsgHandler callbacks.
(Inherited from XPRSbranchobject.)
Public method SetPreferredBranch
Specifies which of the child nodes corresponding to the branches of the object should be explored first.
(Inherited from XPRSbranchobject.)
Public method SetPriority
Sets the priority value of a user branching object.
(Inherited from XPRSbranchobject.)
Public method Store (Inherited from XPRSbranchobject.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public method Validate
Verifies that a given branching object is valid for branching on the current branch-and-bound node of a MIP solve. The function will check that all branches are non-empty, and if required, verify that the branching object can be presolved.
(Inherited from XPRSbranchobject.)
Top
See Also
Covered Topics
Parent Topic Optimizer.Objects

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.