Initializing help system before first use

Optimizer.Objects

 
Classes
  Class Description
Public class AbstractExpression Default implementation of expressions.
Public class BinaryExpression A binary operation in a non-linear formula.
Public class ConstantExpression A constant value.
Public class ConstraintDefinitionC Base class for all constraints. This is a mostly opaque class that usually is short-lived and only saves as data container during the creation of constraints. One thing that is common to all constraints in Xpress is that they have a name. This property is accesible from the GetName() and SetName() functions in this class.
Public class Expression Base class for all expressions. Expressions are the building blocks for all constraints represented by Inequality and also for indicator constraints. Expressions are created by combining variables and constant using operators and functions. The operators available for combining constants, variables and expressions are plus, minus, mul (multiply) and div (divide) and are defined as member functions of the Expression Class (or its subclasses). To add two variables x and y one would do ce. x.Plus(y). To create the expression 2x + 3y one could write x.Mul(2).Plus(y.Mul(3)). All operators are overloaded, so that you could also write 2*x+3*y. The functions that can be used to combine expressions can be found in the Utils class. Examples are sum, sin, etc. Expressions are unmodifiable and are represented as expression trees. This means that all operators are implemented to take only constant time to produce the result. An exception to the above are linear and quadratic Expressions (class LinExpression and QuadExpression). Linear and quadratic expressions are very common to math programming and thus they can be built in even more efficient ways: The LinExpression and QuadExpression are the only mutable expressions. They can be modified using the AddTerm() family of functions. When creating a linear expression like 2x+3y+4z then it is more efficient to do this as LinExpression.Create().AddTerm(x,2).AddTerm(y,3).AddTerm(z,4) than to create the expression using operators plus and mul. For short expressions the performance difference will not be measurable but for longer expressions it will start to matter. Since operators copy their argument expressions by reference, care must be taken when applying operators to LinExpression or QuadExpression: when changing an instance of LinExpression or QuadExpression, this will implicitly change any other expression that references this expression through operators or functions.
Public class FormulaExpression Base class for expressions that implement non-linear formulas.
Public class GeneralConstraint General constraint. General constraints are unmodifiable.
Public class GeneralConstraintDefinition Definition of a general constraint. Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.AddConstraint() or XpressProblem.AddConstraints(). Users should usually not have to deal with this class explicitly.
Public class IIS An irreducible infeasible subsystem.
Public class IISConstraint An infeasible constraint in an IIS.
Public class IISVariable Description of an infeasble variable in an IIS.
Public class IndicatorDescription An indicator constraint. Note that an indicator constraint does not have a direct representation in Xpress. Instead an indicator constraint comprises of 1. a row/inequality, 2. an indicator variable, 3. a flag that says whether the constraint is active when the variable is 1 or 0. The last two pieces of information are stored and modified along with a row. Consequently, submitting an instance of this class to AddConstraint() will - assume that the indicator variable already exists, - create a new row, - set flag and variable on that row according to the information stored in this instance. The name property of this constraint applies to the row that is associated with this Constraint (and that will be created when this instance is submitted to AddConstraints()). Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.AddConstraint(). Users should usually not have to deal with this class explicitly.
Public class IndicatorObjects Data describing an indicator constraint. This is mainly used for querying indicator constraints.
Public class Inequality A reference to an equation, inequality, or ranged row.
Public class InequalityDefinition Class representing a <=, >=, ==, or ranged constraint. Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.AddConstraint() or XpressProblem.AddConstraint(). Users should usually not have to deal with this class explicitly.
Public class InternalFunctionExpression A call to an internal function a non-linear formula.
Public class InternalUtils Utilities for modeling.
Public class LinCoef A linear coefficient. A linear coefficient is a variable/value pair that gives the factor for a variable in a linear expression.
Public class LinearView A read-only view on a linear expression.
Public class LinExpression A linear expression that represents its data by a collection of terms. This is an abstract base class that is implement by different subclasses which use different data types to actually store the various terms in the expression.
Public class LinQuadUtils (Internal) utilities for building linear and quadratic expressions.
Public class LinTerm A linear term.
Public class LinTermList A linear expression that is represented as a list of terms. Instances of this class represent a linear expression as a list of terms. This is the most efficient way to represent a list. By default, the implementation assumes that there are no two terms in the list that refer to the same variable. If there are you must either explicitly call [!:.Compress()] or set the autoCompress property to true.
Public class LinTermMap A linear expression. This class implements a linear expression as a map from variables to values.
Public class NotInProblemException Exception is raised in case a deleted variable, row, etc is accessed or such an object is queried from a problem to which it does not belong.
Public class PWL A piecewise linear constraint.
Public class PWLDefinition A piecewise linear function constraint. An instance of this class requires variable resultant to be the value of the piecewise linear function defined by xval and yval evaluated for variable input. Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.AddConstraint() or XpressProblem.AddPWL(). Users should usually not have to deal with this class explicitly.
Public class PWLExpression A class that represents a piecewise linear function.
Public class QPair Pair of variables in a quadratic expression. Instances of this class are used to represent pairs of variables in quadratic expressions. Variables in this instance are always ordered according to a canonical ordering, so (v1,v2) and (v2,v1) will map to the same representation. Instances can represent linear terms as well. In that case var2 is invalid and [!:.IsLinear()] returns true. Instances can also represent constant terms. In that case var1 and var2 are both invalid and [!:.IsConstant()] returns true.
Public class QuadCoef A quadratic coefficient. A quadratic coefficient is a (variable,variable)/value pair that gives the factor for a pair of variables in a quadratic expression.
Public class QuadExpression A quadratic expression that represents its data by a collection of terms. This is an abstract base class that is implement by different subclasses which use different data types to actually store the various terms in the expression.
Public class QuadTerm A quadratic term.
Public class QuadTermList A quadratic expression that is represented as a list of terms. Instances of this class represent a quadratic expression as a list of terms. This is the most efficient way to represent a list. By default, the implementation assumes that there are no two terms in the list that refer to the same pair of variables. If there are you must either explicitly call [!:.Compress()] or set the autoCompress property to true.
Public class QuadTermMap A quadratic expression. This class implements a quadratic expression as a map from variables to values.
Public class QuadView A read-only view on a quadratic expression.
Public class SOS A special ordered set constraint.
Public class SOSDefinition A special ordered set constraint. Instances of this class describe a constraint that has not yet been added but can be added using XpressProblem.AddConstraint() or XpressProblem.AddConstraints(). Users should usually not have to deal with this class explicitly.
Public class SumExpression Temporary class that is used to efficiently represent sums of expressions. You should never have to instantiate this class explicitly. Note that the array passed to the constructor is only copied by reference! So make sure this is not something that will change afterwards. This is also one of the reasons this class has "package" protection and is not visible to the user.
Public class Token A token in a non-linear formula. All constructors of this class are private. Use the various static factory functions to get new instances. This avoids creating multiple instances that refer to the same Token (like for example the EOF token.
Public class UnaryExpression A unary operation in a non-linear formula.
Public class UserFunctionExpression A class that represents a call to a user function in a non-linear expression.
Public class Utils Utilities for modeling.
Public class Variable A reference to a variable.
Public class XpressProblem Optimizer interface that allows modeling by objects.
Public class XpressProblemBranchObject 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).
Public class XpressProblemCallbackAPI API for adding and removing callbacks to this problem.
Interfaces
  Interface Description
Public interface IIndex Base class for objects that represent an indexed item in an XpressProblem.
Public interface IPostfixExtractor Helper class to extract formulas into a postfix representation.
Delegates
  Delegate Description
Public delegate XpressProblemCallbackAPIAfterObjectiveCallback afterobjective callback
Public delegate XpressProblemCallbackAPIBarIterationCallback bariteration callback
Public delegate XpressProblemCallbackAPIBarlogCallback barlog callback
Public delegate XpressProblemCallbackAPIBeforeObjectiveCallback beforeobjective callback
Public delegate XpressProblemCallbackAPIBeforeSolveCallback beforesolve callback
Public delegate XpressProblemCallbackAPIChangeBranchObjectCallback chgbranchobject callback
Public delegate XpressProblemCallbackAPICheckTimeCallback checktime callback
Public delegate XpressProblemCallbackAPIComputeRestartCallback computerestart callback
Public delegate XpressProblemCallbackAPICutlogCallback cutlog callback
Public delegate XpressProblemCallbackAPICutRoundCallback cutround callback
Public delegate XpressProblemCallbackAPIGapNotifyCallback gapnotify callback
Public delegate XpressProblemCallbackAPIInfnodeCallback infnode callback
Public delegate XpressProblemCallbackAPIIntsolCallback intsol callback
Public delegate XpressProblemCallbackAPILplogCallback lplog callback
Public delegate XpressProblemCallbackAPIMessageCallback message callback
Public delegate XpressProblemCallbackAPIMiplogCallback miplog callback
Public delegate XpressProblemCallbackAPIMipThreadCallback mipthread callback
Public delegate XpressProblemCallbackAPIMipThreadDestroyCallback destroymt callback
Public delegate XpressProblemCallbackAPIMsJobEndCallback msjobend callback
Public delegate XpressProblemCallbackAPIMsJobStartCallback msjobstart callback
Public delegate XpressProblemCallbackAPIMsWinnerCallback mswinner callback
Public delegate XpressProblemCallbackAPINewnodeCallback newnode callback
Public delegate XpressProblemCallbackAPINlpCoefEvalErrorCallback nlpcoefevalerror callback
Public delegate XpressProblemCallbackAPINodecutoffCallback nodecutoff callback
Public delegate XpressProblemCallbackAPINodeLPSolvedCallback nodelpsolved callback
Public delegate XpressProblemCallbackAPIOptnodeCallback optnode callback
Public delegate XpressProblemCallbackAPIPreIntsolCallback preintsol callback
Public delegate XpressProblemCallbackAPIPrenodeCallback prenode callback
Public delegate XpressProblemCallbackAPIPresolveCallback presolve callback
Public delegate XpressProblemCallbackAPISlpCascadeEndCallback slpcascadeend callback
Public delegate XpressProblemCallbackAPISlpCascadeStartCallback slpcascadestart callback
Public delegate XpressProblemCallbackAPISlpCascadeVarCallback slpcascadevar callback
Public delegate XpressProblemCallbackAPISlpCascadeVarFailCallback slpcascadevarfail callback
Public delegate XpressProblemCallbackAPISlpConstructCallback slpconstruct callback
Public delegate XpressProblemCallbackAPISlpDrColCallback slpdrcol callback
Public delegate XpressProblemCallbackAPISlpIntSolCallback slpintsol callback
Public delegate XpressProblemCallbackAPISlpIterEndCallback slpiterend callback
Public delegate XpressProblemCallbackAPISlpIterStartCallback slpiterstart callback
Public delegate XpressProblemCallbackAPISlpIterVarCallback slpitervar callback
Public delegate XpressProblemCallbackAPISlpPreUpdateLinearizationCallback slppreupdatelinearization callback
Public delegate XpressProblemCallbackAPIStrongBranchSolveCallback strongbranchsolve callback
Public delegate XpressProblemCallbackAPIUserSolNotifyCallback usersolnotify callback
Enumerations
  Enumeration Description
Public enumeration BinaryExpressionOperator Enumeration for binary expression operators.
Public enumeration ExpressionRTTI Runtime type information for expressions.
Public enumeration IISIsolation Isolation status of a constraint or variable.
Public enumeration IISVariableInfeasibleDomain Domain properties that can be infeasible in an IIS.
Public enumeration InternalFunctionExpressionFunctionType Enumeration for internal functions.
Public enumeration UnaryExpressionOperator Enumeration for unary expression operators.
Covered Topics
Parent Topic Reference

© 2001-2025 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.