IndicatorDescription
- java.lang.Object
-
- com.dashoptimization.objects.ConstraintDefinition<Inequality>
-
- com.dashoptimization.objects.IndicatorDescription
-
public final class IndicatorDescription extends ConstraintDefinition<Inequality>
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 toaddConstraint()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. Thenameproperty of this constraint applies to the row that is associated with this constraint (and that will be created when this instance is submitted toaddConstraints()). Instances of this class describe a constraint that has not yet been added but can be added usingXpressProblem.addConstraint(). Users should usually not have to deal with this class explicitly.- Since:
- 43.00
-
-
Constructor Summary
Constructor Description IndicatorDescription(Variable indicatorVariable, boolean indicatorValue, Inequality.Definition implied)Create a new indicator constraint description.
-
Method Summary
Modifier and Type Method Description java.lang.StringgetName()Get the name of this constraint.IndicatorDescriptionsetName(java.lang.String newName)Set the name of the constraint.-
Methods inherited from class com.dashoptimization.objects.ConstraintDefinition
create, setConstraintName
-
-
-
-
Constructor Detail
-
IndicatorDescription
public IndicatorDescription(Variable indicatorVariable, boolean indicatorValue, Inequality.Definition implied)
Create a new indicator constraint description.- Parameters:
-
indicatorVariable- The variable that controls the indicator constraint. -
indicatorValue- Indicated whether theimpliedconstraint becomes active ifindicatorVariableis non-zero (indicatorValueistrue) or ifindicatorVariableis zero (indicatorValueisfalse). -
implied- The inequality that becomes active depending onindicatorValueand the value ofindicatorVariable. - Since:
- 43.00
-
-
Method Detail
-
getName
public java.lang.String getName()
Get the name of this constraint.- Overrides:
-
getNamein classConstraintDefinition<Inequality> - Returns:
- The name of this constraint.
- Since:
- 43.00
-
setName
public IndicatorDescription setName(java.lang.String newName)
Set the name of the constraint. This is the same asConstraintDefinition.setConstraintName(String)but with a different return type.- Parameters:
-
newName- New name. - Returns:
- Always returns this instance.
- Since:
- 43.00
-
-
© 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.