Initializing help system before first use

XPRBctr Class

Methods for initialisation and handling of XPRB constraint objects.
Inheritance Hierarchy
SystemObject
   BCLXPRBctr

Namespace:   BCL
Assembly:  xprbdn (in xprbdn.dll) Version: 4.8.14.0
Syntax
C#
VB
Copy 
public class XPRBctr

The XPRBctr type exposes the following members.

Constructors
  Name Description
Public method XPRBctr Obsolete.
Initializes a new instance of the XPRBctr class
Public method XPRBctr(IntPtr) Obsolete.
Initializes a new instance of the XPRBctr class
Public method XPRBctr(XPRBprob)
Initializes a new instance of the XPRBctr class
Public method XPRBctr(IntPtr, XPRBprob)
Initializes a new instance of the XPRBctr class
Public method XPRBctr(IntPtr, XPRBrelation) Obsolete.
Initializes a new instance of the XPRBctr class
Public method XPRBctr(IntPtr, XPRBrelation, XPRBprob)
Initializes a new instance of the XPRBctr class
Top
Properties
  Name Description
Public property size
The number of (non-zero) linear and quadratic terms in the constraint.
Top
Methods
  Name Description
Public methodCode example add
This adds an XPRBexpr expression to the constraint.
Public method addTerm(Double)
Public method addTerm(XPRBvar)
Public method addTerm(Double, XPRBvar)
Public methodCode example addTerm(XPRBvar, Double)
This adds a term to the XPRBctr constraint. The term can be constructed from an XPRBvar object, a double or a combination of the two.
Public method addTerm(XPRBvar, XPRBvar, Double)
Public methodCode example assign
Sets the constraint from a list of terms in an XPRBrelation.
Public methodCode example delTerm
This deletes a term in the XPRBctr constraint relating to a specific XPRBvar variable.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodCode example getAct
Retrieves the activity value.
Public methodCode example getCoefficient(XPRBvar)
Get the coefficient of a linear constraint term.
Public methodCode example getCoefficient(XPRBvar, XPRBvar)
Get the coefficient of a quadratic constraint term. This method returns the coefficient of a given pair of variables in the constraint or 0 if the term does not occur.
Public methodCode example getCRef
Return the constraint reference pointer.
Public methodCode example getctrRef
Return the constraint reference pointer.
Public methodCode example getDual
Retrieves the dual value.
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method getIndicator
Get the indicator type of a constraint.
Public method getIndVar
Get the indicator variable of a constraint.
Public methodCode example getName
Returns the constraint name.
Public method getQTerms
Public methodCode example getRange
Retrieves the constraint range.
Public methodCode example getRangeL
Retrieves the lower constraint range.
Public methodCode example getRangeU
Retrieves the upper constraint range.
Public methodCode example getRHS
Retrieves the right hand side value of a constraint.
Public methodCode example getRNG
Compute (if required) ranges and return a row range.
Public methodCode example getRowNum
Retrieves the row index for a constraint.
Public methodCode example getSlack
Retrieves the slack value.
Public method getTerms
Public methodCode example getType
Retrieves the constraint type.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method isDelayed
Determines whether the constraint is a delayed constraint.
Public methodCode example isIncludeVars
Test the type of a constraint. This method indicates whether this constraint is an 'include vars' constraint or an ordinary constraint.
Public method isIndicator
This tests whether the constraint is an indicator constraint or an ordinary constraint.
Public methodCode example isModCut
Gets the model cut status of a constraint.
Public methodCode example isValid
Checks whether the constraint object is valid.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode example print
Print out the constraint.
Public methodCode example reset
Reset the constraint object.
Public method setDelayed
Sets a constraint as a delayed constraint.
Public methodCode example setIncludeVars
Set the contstraint type. This method changes the type of a previously defined constraint from ordinary constraint to 'include vars' and vice versa. 'include vars' constraints are non-binding (type N) constraints used only to force loading of their variables into the optimizer. Constraint properties 'model cut', 'delayed constraint', 'indicator constraint' and 'include vars' are mutually exclusive. When changing one of this types to another you must first reset the corresponding type to 0.
Public method setIndicator(Int32)
Set the indicator constraint type.
Public method setIndicator(Int32, XPRBvar)
Set the indicator constraint type.
Public method setIndicator(XPRBvar, Int32)
Set the indicator constraint type.
Public methodCode example setModCut
Sets the model cut status of a constraint.
Public methodCode example setRange
Sets the constraint range.
Public method setTerm(Double)
Public method setTerm(XPRBvar)
Public method setTerm(Double, XPRBvar)
Public methodCode example setTerm(XPRBvar, Double)
This sets a term in the XPRBctr constraint. The term can be constructed from an XPRBvar object, a double or a combination of the two.
Public methodCode example setType
Sets the constraint type.
Public method ToString (Overrides ObjectToString.)
Top
Operators
  Name Description
Public operatorStatic memberCode example Addition(XPRBctr, XPRBexpr)
Add an XPRBexpr to a constraint.
Public operatorStatic memberCode example Addition(XPRBctr, XPRBterm)
Add an XPRBterm to a constraint.
Public operatorStatic memberCode example Addition(XPRBctr, XPRBvar)
Add an XPRBvar to a constraint.
Public operatorStatic memberCode example Addition(XPRBctr, Double)
Add a double to a constraint.
Public operatorStatic memberCode example Subtraction(XPRBctr, XPRBexpr)
Subtract an XPRBexpr from a constraint.
Public operatorStatic memberCode example Subtraction(XPRBctr, XPRBterm)
Subtract an XPRBterm from a constraint.
Public operatorStatic memberCode example Subtraction(XPRBctr, XPRBvar)
Subtract an XPRBvar from a constraint.
Public operatorStatic memberCode example Subtraction(XPRBctr, Double)
Subtract a double from a constraint.
Top
Remarks
All terms in a constraint must belong to the same problem as the constraint itself.
See Also

Reference

BCL Namespace
Covered Topics
Parent Topic BCL