Variable

Create a constraint that requires this variable to be the absolute value of x.

Examples using absOf:

• GeneralConstraints.cpp

Parameters

x	Argument for the absolute value constraint.

Returns

this = abs(x).

Since

44.00

Create a constraint that requires this variable to be the and of the specified arguments.

Examples using andOf:

• BoolVars.cpp

Parameters

variables

Variables in the and constraint.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type Variable.

Returns

this = and(variables, value).

Since

44.00

Create a constraint that requires this variable to be the and of the specified arguments.

Examples using andOf:

• BoolVars.cpp

Parameters

variables	Variables in the and constraint.
name	Constraint name, can be std::nullopt to indicate the constraint has no name.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type Variable.

Returns

this = and(variables, value).

Since

44.00

Create a constraint that requires this variable to be the and of the specified other variables.

Examples using andOf:

• BoolVars.cpp

Parameters

variables

Variables in the and constraint.

Returns

this = and(variables).

Since

44.00

Change the coefficient for this variable in a row.

Examples using chgCoef:

• CuttingStock.cpp
• RecursiveFinancialPlanning.cpp

Parameters

r	Inequality for which to change the coefficient.
newCoef	New coefficient.

Since

44.00

Change the coefficients for this variable in multiple rows.

Parameters

r	Inequalities for which to change the coefficient.
newCoef	New coefficients.

Since

44.00

Change objective coefficient for this variable.

Examples using chgObj:

• CuttingStock.cpp
• tsp.cpp

Parameters

newCoef

New objective coefficient.

Returns

Always returns this instance.

Since

44.00

Change objective coefficient for this variable.

Parameters

objidx	Index of objective function to change.
newCoef	New objective coefficient.

Returns

Always returns this instance.

Since

44.00

Since

44.00

Create a expression that represents the quotient of this and arg.

Parameters

arg

Divisor.

Returns

The expression.

Since

44.00

Create a expression that represents the quotient of this and arg.

Parameters

arg

Divisor.

Returns

Quotient of this and arg.

Since

44.00

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a expression that represents the quotient of this and arg.

Parameters

arg

Divisor.

Returns

Quotient of this and arg.

Since

44.00

Since

44.00

Reimplemented from xpress::objects::Expression.

Create an "equals" constraint with this expression as left-hand side.Examples using eq:

• BoolVars.cpp

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

• BoolVars.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create an "equals" constraint with this expression as left-hand side.Examples using eq:

• BoolVars.cpp

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

• BoolVars.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).Examples using evaluate:

• CapitalBudgeting.cpp
• PolygonObjects.cpp

Parameters

solution

Solution values for which the expression is evaluated.

Returns

The value of this expression evaluated at solution.

Since

44.00

• CapitalBudgeting.cpp
• PolygonObjects.cpp

Parameters

solution

Solution values for which the expression is evaluated.

Since

44.00

Reimplemented from xpress::objects::Expression.

Fix this variable to a value.

Set the lower bound and upper bound in the XpressProblem instance to which this variable belongs.

Examples using fix:

• BoolVars.cpp
• Catenary.cpp
• FolioHeuristic.cpp
• RecursiveFinancialPlanning.cpp

Parameters

value

New lower and upper bound.

Returns

This variable

Since

44.00

Create a "greater than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a "greater than or equal" constraint with this expression as left-hand side.

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

Since

44.00

Reimplemented from xpress::objects::Expression.

Get reduced cost value for this variable from the solution associated with the current callback.

Note: This functions uses xpress::XPRSProblem#getCallbackRedCosts(bool *, Array<double> const &, int, int) const under the hood.

Note: Calling this function for multiple variables is not efficient. If you need to get values for multiple variables then consider using xpress::objects::XpressProblem#getCallbackRedCosts() const to get the values for all variables and then use getValue(SizedArray<double const> const &) const to extract the value for a particular variable.

Returns

Reduced cost for this variable.

Since

44.00

Get value for this variable from the solution associated with the current callback.

Note: This functions uses xpress::XPRSProblem#getCallbackSolution(bool *, Array<double> const &, int, int) const under the hood.

Note: Calling this function for multiple variables is not efficient. If you need to get values for multiple variables then consider using xpress::objects::XpressProblem#getCallbackSolution() const to get the values for all variables and then use getValue(SizedArray<double const> const &) const to extract the value for a particular variable.

Examples using getCallbackSolution:

• ELSCut.cpp
• ELSManagedCuts.cpp
• FolioCB.cpp

Returns

Solution value for this variable.

Since

44.00

Since

44.00

Get the index that this object has in the underlying model.Attention: this is a very advanced function. Use it only if you know exactly what you are doing.

Returns

The index of this object in the underlying model.

Since

44.00

Since

44.00

Implements xpress::objects::Index.

Get the index stored in this object but raise an exception if the problem that created this object is not prob.

Parameters

xprob

The problem for which the index is queried. If this object does not belong to prob then an execption is raised.

Returns

The low-level index for this object in prob.

Since

44.00

Since

44.00

Implements xpress::objects::Index.

Get the lower bound for this variable.

Queries the xpress::objects::XpressProblem instance to which this variable belongs and returns the lower bound obtained from that instance.

Since

44.00

Get the name of this object.Queries the problem instance that owns this object and returns the name from that instance.Examples using getName:

• BinBurglar.cpp
• BoolVars.cpp
• ContractAllocation.cpp
• CuttingStock.cpp
• FolioHeuristic.cpp
• FolioIIS.cpp
• FolioInit.cpp
• FolioMip1.cpp
• FolioMip2.cpp
• FolioMipIIS.cpp
• FolioQC.cpp
• FolioQP.cpp
• PolygonObjects.cpp
• QuadraticProgramming.cpp
• RecursiveFinancialPlanning.cpp

Returns

The name of this object.

Since

44.00

• BinBurglar.cpp
• BoolVars.cpp
• ContractAllocation.cpp
• CuttingStock.cpp
• FolioHeuristic.cpp
• FolioIIS.cpp
• FolioInit.cpp
• FolioMip1.cpp
• FolioMip2.cpp
• FolioMipIIS.cpp
• FolioQC.cpp
• FolioQP.cpp
• PolygonObjects.cpp
• QuadraticProgramming.cpp
• RecursiveFinancialPlanning.cpp

Since

44.00

Implements xpress::objects::Index.

Get objective coefficient for this variable.

Returns

Objective coefficient for this variable.

Since

44.00

Get objective coefficient for this variable.

Parameters

objIdx

Index of objective function to query.

Returns

Objective coefficient for this variable.

Since

44.00

Get the problem to which this element belongs.

Returns

The problem to which this element belongs. This will be nullptr if the element was deleted.

Since

44.00

Returns

The problem to which this element belongs. This will be nullptr if the element was deleted.

Since

44.00

Implements xpress::objects::Index.

Get the current reduced cost value for this variable.

Note: This functions uses xpress::XPRSProblem#getRedCosts(int *, Array<double> const &, int, int) const under the hood. This is only valid to call if the xpress::objects::XpressProblem instance owning this variable is currently not under optimization.

Note: Calling this function for multiple variables is not efficient. If you need to get values for multiple variables then consider using xpress::objects::XpressProblem#getRedCosts() const to get the values for all variables and then use getValue(SizedArray<double const> const &) const to extract the value for a particular variable. This strategy is also valid from callbacks.

Returns

Reduced cost for this variable.

Since

44.00

Get the current solution value for this variable.

Note: This functions uses xpress::XPRSProblem#getSolution(int *, Array<double> const &, int, int) const under the hood. This is only valid to call if the XpressProblem instance owning this variable is currently not under optimization.

Note: Calling this function for multiple variables is not efficient. If you need to get values for multiple variables then consider using xpress::objects::XpressProblem#getSolution() const to get the values for all variables and then use getValue(SizedArray<double const> const &) const to extract the value for a particular variable. This strategy is also valid from callbacks.

Examples using getSolution:

• BinBurglar.cpp
• BoolVars.cpp
• Boxes02.cpp
• Capbgt2l.cpp
• CapitalBudgeting.cpp
• Catenary.cpp
• ContractAllocation.cpp
• CuttingStock.cpp
• ELS.cpp
• ELSCut.cpp
• FacilityLocationArray.cpp
• FacilityLocationCollection.cpp
• Folio.cpp
• FolioCB.cpp
• FolioHeuristic.cpp
• FolioInit.cpp
• FolioMip1.cpp
• FolioMip2.cpp
• FolioQC.cpp
• FolioQP.cpp
• GeneralConstraints.cpp
• Glidert.cpp
• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PolygonObjects.cpp
• Pplan.cpp
• Pplan2.cpp
• ProductionPlanning_Index.cpp
• PurchasePWL.cpp
• PurchaseSOS2.cpp
• QuadraticProgramming.cpp
• RecursiveFinancialPlanning.cpp
• Sangraalind.cpp
• SpecialOrderedSets.cpp
• SpecialOrderedSetsQuadratic.cpp
• TravelingSalesPerson.cpp
• Wagon.cpp
• tsp.cpp

Returns

Solution value for this variable.

Since

44.00

Get the type for this variable.

Queries the XpressProblem instance to which this variable belongs and returns the name obtained from that instance.

Returns

Type of this variable.

Since

44.00

Get the upper bound for this variable.

Queries the XpressProblem instance to which this variable belongs and returns the upper bound obtained from that instance.

Returns

The upper bound for this variable.

Since

44.00

Get the value of this variable from an array.

The function assumes that data is an array that stores a value for each variable in the underlying problem and returns the value from this array that corresponds to this variable. data arrays can be obtained for example from prob.getSolution() or prob.getCallbackSolution().

Examples using getValue:

• BinBurglar.cpp
• BoolVars.cpp
• Boxes02.cpp
• Capbgt2l.cpp
• Catenary.cpp
• ContractAllocation.cpp
• CuttingStock.cpp
• ELS.cpp
• ELSCut.cpp
• ELSManagedCuts.cpp
• FacilityLocationArray.cpp
• FacilityLocationCollection.cpp
• Folio.cpp
• FolioCB.cpp
• FolioHeuristic.cpp
• FolioInit.cpp
• FolioMip1.cpp
• FolioMip2.cpp
• FolioQC.cpp
• FolioQP.cpp
• GeneralConstraints.cpp
• Glidert.cpp
• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PolygonObjects.cpp
• Pplan.cpp
• Pplan2.cpp
• ProductionPlanning_Index.cpp
• PurchasePWL.cpp
• PurchaseSOS2.cpp
• QuadraticProgramming.cpp
• RecursiveFinancialPlanning.cpp
• Sangraalind.cpp
• SpecialOrderedSets.cpp
• SpecialOrderedSetsQuadratic.cpp
• TravelingSalesPerson.cpp
• Wagon.cpp

Parameters

data	Data for all variables.

Returns

The value for this variable in data.

Since

44.00

Create an indicator constraint with this variable as indicator variable.

The constraint will enforce implied if this variable is set to 0.

Examples using ifNotThen:

• BinBurglar.cpp
• Capbgt2l.cpp
• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp

Parameters

implied

The constraint that should be enforced if this variable is 0.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create an indicator constraint with this variable as indicator variable.

The constraint will enforce implied if this variable is set to 1.

Examples using ifThen:

• BinBurglar.cpp
• Capbgt2l.cpp

Parameters

implied

The constraint that should be enforced if this variable is 1.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create a range constraint that bounds this expression from below and above.Examples using in:

• Folio.cpp
• FolioCB.cpp
• FolioMipIIS.cpp
• QuadraticProgramming.cpp

Parameters

lb	Lower bound for this expression.
ub	Upper bound for this expression.

Returns

The constraint.

Since

44.00

• Folio.cpp
• FolioCB.cpp
• FolioMipIIS.cpp
• QuadraticProgramming.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a "less than or equal" constraint with this expression as left-hand side.Examples using leq:

• TravelingSalesPerson.cpp

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

• TravelingSalesPerson.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a "less than or equal" constraint with this expression as left-hand side.Examples using leq:

• TravelingSalesPerson.cpp

Parameters

rhs	Right-hand side of constraint.

Returns

The constraint.

Since

44.00

• TravelingSalesPerson.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a constraint that requires this variable to be the maximum of the specified arguments.

Examples using maxOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the maximum constraint.
values	Values in the maximum constraint.

Template Parameters

Strm0	Something that supports begin() and end() and contains values of type Variable.
Strm1	Something that supports begin() and end() and contains values of type double.

Returns

this = max(variables, value).

Since

44.00

Create a constraint that requires this variable to be the maximum of the specified arguments.

Examples using maxOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the maximum constraint.
values	Values in the maximum constraint.
name	Constraint name, can be std::nullopt to indicate the constraint has no name.

Template Parameters

Strm0	Something that supports begin() and end() and contains values of type Variable.
Strm1	Something that supports begin() and end() and contains values of type double.

Returns

this = max(variables, value).

Since

44.00

Create a constraint that requires this variable to be the maximum of the specified other variables.

Examples using maxOf:

• GeneralConstraints.cpp

Parameters

variables

Variables in the maximum constraint.

Returns

this = max(variables).

Since

44.00

Create a constraint that requires this variable to be the maximum of the specified other variables and values.

Examples using maxOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the maximum constraint.
values	Values in the maximum constraint.

Returns

this = max(variables, value).

Since

44.00

Create a constraint that requires this variable to be the minimum of the specified arguments.

Examples using minOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the minimum constraint.
values	Values in the minimum constraint.

Template Parameters

Strm0	Something that supports begin() and end() and contains values of type Variable.
Strm1	Something that supports begin() and end() and contains values of type double.

Returns

this = min(variables, value).

Since

44.00

Create a constraint that requires this variable to be the minimum of the specified arguments.

Examples using minOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the minimum constraint.
values	Values in the minimum constraint.
name	Constraint name, can be std::nullopt to indicate the constraint has no name.

Template Parameters

Strm0	Something that supports begin() and end() and contains values of type Variable.
Strm1	Something that supports begin() and end() and contains values of type double.

Returns

this = min(variables, value).

Since

44.00

Create a constraint that requires this variable to be the minimum of the specified other variables.

Examples using minOf:

• GeneralConstraints.cpp

Parameters

variables

Variables in the minimum constraint.

Returns

this = min(variables).

Since

44.00

Create a constraint that requires this variable to be the minimum of the specified other variables and values.

Examples using minOf:

• GeneralConstraints.cpp

Parameters

variables	Variables in the minimum constraint.
values	Values in the minimum constraint.

Returns

this = min(variables, value).

Since

44.00

Create a expression that represents the product of this and arg.

Examples using mul:

• Capbgt2l.cpp

Parameters

arg

Factor.

Returns

The expression.

Since

44.00

Create a expression that represents the product of this and arg.Examples using mul:

• Capbgt2l.cpp

Parameters

arg

Factor.

Returns

Product of this and arg.

Since

44.00

• Capbgt2l.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a expression that represents the product of this and arg.Examples using mul:

• Capbgt2l.cpp

Parameters

arg

Factor.

Returns

Product of this and arg.

Since

44.00

• Capbgt2l.cpp

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a expression that represents the product of this and arg.

Examples using mul:

• Capbgt2l.cpp

Parameters

arg

Factor.

Returns

The expression.

Since

44.00

Create a expression that represents the product of this and arg.

Examples using mul:

• Capbgt2l.cpp

Parameters

arg

Factor.

Returns

The expression.

Since

44.00

Create a constraint that requires this variable to be the or of the specified arguments.

Examples using orOf:

• BoolVars.cpp

Parameters

variables

Variables in the or constraint.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type Variable.

Returns

this = or(variables, value).

Since

44.00

Create a constraint that requires this variable to be the or of the specified arguments.

Examples using orOf:

• BoolVars.cpp

Parameters

variables	Variables in the or constraint.
name	Constraint name, can be std::nullopt to indicate the constraint has no name.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type Variable.

Returns

this = or(variables, value).

Since

44.00

Create a constraint that requires this variable to be the or of the specified other variables.

Examples using orOf:

• BoolVars.cpp

Parameters

variables

Variables in the or constraint.

Returns

this = or(variables).

Since

44.00

Create a piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.

Examples using pwlOf:

• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PurchasePWL.cpp

Parameters

input	Input for piecewise linear constraint.
breakpoints	Breakpoints for constraint.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create a piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.

Examples using pwlOf:

• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PurchasePWL.cpp

Parameters

input	Input for piecewise linear constraint.
breakpoints	Breakpoints for constraint.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type xpress::PwlBreakpoint.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create a piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.

Examples using pwlOf:

• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PurchasePWL.cpp

Parameters

input	Input for piecewise linear constraint.
breakpoints	Breakpoints for constraint.
name	Name for constraint, can be std::nullopt.

Template Parameters

Strm0

Something that supports begin() and end() and contains values of type xpress::PwlBreakpoint.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create a piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by xval/yval evaluated for input.

Examples using pwlOf:

• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PurchasePWL.cpp

Parameters

input	Input for piecewise linear constraint.
xval	X coordinates of breakpoints.
yval	X coordinates of breakpoints.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Create a piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by xval/yval evaluated for input.

Examples using pwlOf:

• MultipleKnapsack_Arrays.cpp
• MultipleKnapsack_Collections.cpp
• PiecewiseLinear.cpp
• PurchasePWL.cpp

Parameters

input	Input for piecewise linear constraint.
xval	X coordinates of breakpoints.
yval	X coordinates of breakpoints.
name	Name of the constraint, can be std::nullopt.

Returns

Definition for the constraint described by the arguments.

Since

44.00

Set the lower bound for this variable.

Set the lower bound in the XpressProblem instance to which this variable belongs.

Examples using setLB:

• FolioHeuristic.cpp
• PiecewiseLinear.cpp
• SpecialOrderedSets.cpp
• SpecialOrderedSetsQuadratic.cpp

Parameters

newLB

New lower bound.

Returns

This variable

Since

44.00

Set the limit for this variable.

Set the limit in the XpressProblem instance to which this variable belongs. Note that limits are ignored unless the variable is semi-continuous, semi-integer, or partial integer.

Parameters

newLimit

New limit.

Returns

This variable

Since

44.00

Set the name of this variable.

Sets the name of this variable in the problem instance that owns the object.

Examples using setName:

• Catenary.cpp
• ContractAllocation.cpp
• CuttingStock.cpp
• FolioIIS.cpp
• FolioInit.cpp
• FolioMip1.cpp
• FolioMipIIS.cpp
• FolioQC.cpp
• GeneralConstraints.cpp
• ProductionPlanning_Index.cpp
• RecursiveFinancialPlanning.cpp

Parameters

newName

The name to be set.

Returns

Always returns this instance.

Since

44.00

Set the type for this variable.

Set the type in the XpressProblem instance to which this variable belongs.

Parameters

newType

New type.

Returns

This variable

Since

44.00

Set the upper bound for this variable.

Set the upper bound in the XpressProblem instance to which this variable belongs.

Examples using setUB:

• FolioHeuristic.cpp
• SpecialOrderedSets.cpp
• SpecialOrderedSetsQuadratic.cpp

Parameters

newUB

New upper bound.

Returns

This variable

Since

44.00

Create a quadratic term by multiplying this variable with itself.

Examples using square:

• PolygonObjects.cpp
• QuadraticProgramming.cpp

Returns

The term representing the product of this variable with itself.

Since

44.00

Returns the name from getName().

Examples using toString:

• Boxes02.cpp
• Capbgt2l.cpp

Returns

This variable's name.

Since

44.00

Reimplemented from xpress::objects::Expression.

Create a expression that represents the unary minus of this one.

Returns

Expression representing -this.

Since

44.00

Since

44.00

Reimplemented from xpress::objects::Expression.