Initializing help system before first use

Variable

  • All Implemented Interfaces:
    Index, java.lang.Comparable<Variable> 
    public final class Variable
extends Expression
implements Index, java.lang.Comparable<Variable>
    A reference to a variable.
    Since:
    43.00

    • Method Summary

      Modifier and Type Method Description
      GeneralConstraint.Definition absOf​(Variable x)
      Create a constraint that requires this variable to be the absolute value of x.
      GeneralConstraint.Definition andOf​(Variable... variables)
      Create a constraint that requires this variable to be the and of the specified other variables.
      GeneralConstraint.Definition andOf​(Variable[] variables, java.lang.String name)
      Create a constraint that requires this variable to be the and of the specified arguments.
      GeneralConstraint.Definition andOf​(java.lang.Iterable<Variable> variables)
      Create a constraint that requires this variable to be the and of the specified arguments.
      GeneralConstraint.Definition andOf​(java.lang.Iterable<Variable> variables, java.lang.String name)
      Create a constraint that requires this variable to be the and of the specified arguments.
      GeneralConstraint.Definition andOf​(java.util.stream.Stream<Variable> variables)
      Create a constraint that requires this variable to be the and of the specified arguments.
      GeneralConstraint.Definition andOf​(java.util.stream.Stream<Variable> variables, java.lang.String name)
      Create a constraint that requires this variable to be the and of the specified arguments.
      void chgCoef​(Inequality r, double newCoef)
      Change the coefficient for this variable in a row.
      void chgCoefs​(Inequality[] r, double[] newCoef)
      Change the coefficients for this variable in multiple rows.
      Variable chgObj​(double newCoef)
      Change objective coefficient for this variable.
      Variable chgObjN​(int objidx, double newCoef)
      Change objective coefficient for this variable.
      int compareTo​(Variable other)
      LinTerm div​(double arg)
      Create a new expression that represents the quotient of this and arg.
      LinTerm div​(ConstantExpression arg)
      Create a new expression that represents the quotient of this and arg.
      Expression div​(Expression arg)
      Create a new expression that represents the quotient of this and arg.
      Inequality.Definition eq​(double rhs)
      Create an "equals" constraint with this expression as left-hand side.
      Inequality.Definition eq​(Expression rhs)
      Create an "equals" constraint with this expression as left-hand side.
      boolean equals​(java.lang.Object other)
      double evaluate​(double[] solution)
      Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).
      Variable fix​(double value)
      Fix this variable to a value.
      Inequality.Definition geq​(double rhs)
      Create a "greater than or equal" constraint with this expression as left-hand side.
      Inequality.Definition geq​(Expression rhs)
      Create a "greater than or equal" constraint with this expression as left-hand side.
      double getCallbackRedCost()
      Get reduced cost value for this variable from the solution associated with the current callback.
      double getCallbackSolution()
      Get value for this variable from the solution associated with the current callback.
      int getIndex()
      Get the index that this object has in the underlying model.
      int getIndexForProb​(XpressProblem xprob)
      Get the index stored in this object but raise an exception if the problem that created this object is not prob.
      double getLB()
      Get the lower bound for this variable.
      java.lang.String getName()
      Get the name of this object.
      double getObj()
      Get objective coefficient for this variable.
      double getObjN​(int objIdx)
      Get objective coefficient for this variable.
      XpressProblem getProblem()
      Get the problem to which this element belongs.
      double getRedCost()
      Get the current reduced cost value for this variable.
      double getSolution()
      Get the current solution value for this variable.
      ColumnType getType()
      Get the type for this variable.
      double getUB()
      Get the upper bound for this variable.
      double getValue​(double[] data)
      Get the value of this variable from an array.
      int hashCode()  
      IndicatorDescription ifNotThen​(Inequality.Definition implied)
      Create an indicator constraint with this variable as indicator variable.
      IndicatorDescription ifThen​(Inequality.Definition implied)
      Create an indicator constraint with this variable as indicator variable.
      Inequality.Definition in​(double lb, double ub)
      Create a range constraint that bounds this expression from below and above.
      Inequality.Definition leq​(double rhs)
      Create a "less than or equal" constraint with this expression as left-hand side.
      Inequality.Definition leq​(Expression rhs)
      Create a "less than or equal" constraint with this expression as left-hand side.
      GeneralConstraint.Definition maxOf​(Variable... variables)
      Create a constraint that requires this variable to be the maximum of the specified other variables.
      GeneralConstraint.Definition maxOf​(Variable[] variables, double... values)
      Create a constraint that requires this variable to be the maximum of the specified other variables and values.
      GeneralConstraint.Definition maxOf​(Variable[] variables, double[] values, java.lang.String name)
      Create a constraint that requires this variable to be the maximum of the specified arguments.
      GeneralConstraint.Definition maxOf​(java.lang.Iterable<Variable> variables, java.lang.Iterable<java.lang.Double> values)
      Create a constraint that requires this variable to be the maximum of the specified arguments.
      GeneralConstraint.Definition maxOf​(java.lang.Iterable<Variable> variables, java.lang.Iterable<java.lang.Double> values, java.lang.String name)
      Create a constraint that requires this variable to be the maximum of the specified arguments.
      GeneralConstraint.Definition maxOf​(java.util.stream.Stream<Variable> variables, java.util.stream.Stream<java.lang.Double> values)
      Create a constraint that requires this variable to be the maximum of the specified arguments.
      GeneralConstraint.Definition maxOf​(java.util.stream.Stream<Variable> variables, java.util.stream.Stream<java.lang.Double> values, java.lang.String name)
      Create a constraint that requires this variable to be the maximum of the specified arguments.
      GeneralConstraint.Definition minOf​(Variable... variables)
      Create a constraint that requires this variable to be the minimum of the specified other variables.
      GeneralConstraint.Definition minOf​(Variable[] variables, double... values)
      Create a constraint that requires this variable to be the minimum of the specified other variables and values.
      GeneralConstraint.Definition minOf​(Variable[] variables, double[] values, java.lang.String name)
      Create a constraint that requires this variable to be the minimum of the specified arguments.
      GeneralConstraint.Definition minOf​(java.lang.Iterable<Variable> variables, java.lang.Iterable<java.lang.Double> values)
      Create a constraint that requires this variable to be the minimum of the specified arguments.
      GeneralConstraint.Definition minOf​(java.lang.Iterable<Variable> variables, java.lang.Iterable<java.lang.Double> values, java.lang.String name)
      Create a constraint that requires this variable to be the minimum of the specified arguments.
      GeneralConstraint.Definition minOf​(java.util.stream.Stream<Variable> variables, java.util.stream.Stream<java.lang.Double> values)
      Create a constraint that requires this variable to be the minimum of the specified arguments.
      GeneralConstraint.Definition minOf​(java.util.stream.Stream<Variable> variables, java.util.stream.Stream<java.lang.Double> values, java.lang.String name)
      Create a constraint that requires this variable to be the minimum of the specified arguments.
      LinTerm mul​(double arg)
      Create a new expression that represents the product of this and arg.
      LinTerm mul​(ConstantExpression arg)
      Create a new expression that represents the product of this and arg.
      Expression mul​(Expression arg)
      Create a new expression that represents the product of this and arg.
      QuadTerm mul​(LinTerm arg)
      Create a new expression that represents the product of this and arg.
      QuadTerm mul​(Variable arg)
      Create a new expression that represents the product of this and arg.
      GeneralConstraint.Definition orOf​(Variable... variables)
      Create a constraint that requires this variable to be the or of the specified other variables.
      GeneralConstraint.Definition orOf​(Variable[] variables, java.lang.String name)
      Create a constraint that requires this variable to be the or of the specified arguments.
      GeneralConstraint.Definition orOf​(java.lang.Iterable<Variable> variables)
      Create a constraint that requires this variable to be the or of the specified arguments.
      GeneralConstraint.Definition orOf​(java.lang.Iterable<Variable> variables, java.lang.String name)
      Create a constraint that requires this variable to be the or of the specified arguments.
      GeneralConstraint.Definition orOf​(java.util.stream.Stream<Variable> variables)
      Create a constraint that requires this variable to be the or of the specified arguments.
      GeneralConstraint.Definition orOf​(java.util.stream.Stream<Variable> variables, java.lang.String name)
      Create a constraint that requires this variable to be the or of the specified arguments.
      PWL.Definition pwlOf​(Variable input, double[] xval, double[] yval)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by xval/ yval evaluated for input.
      PWL.Definition pwlOf​(Variable input, double[] xval, double[] yval, java.lang.String name)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by xval/ yval evaluated for input.
      PWL.Definition pwlOf​(Variable input, PwlBreakpoint... breakpoints)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      PWL.Definition pwlOf​(Variable input, PwlBreakpoint[] breakpoints, java.lang.String name)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      PWL.Definition pwlOf​(Variable input, java.lang.Iterable<PwlBreakpoint> breakpoints)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      PWL.Definition pwlOf​(Variable input, java.lang.Iterable<PwlBreakpoint> breakpoints, java.lang.String name)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      PWL.Definition pwlOf​(Variable input, java.util.stream.Stream<PwlBreakpoint> breakpoints)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      PWL.Definition pwlOf​(Variable input, java.util.stream.Stream<PwlBreakpoint> breakpoints, java.lang.String name)
      Create a new piecewise linear constraint that requires this variable to be the value of the piecewise linear function specified by breakpoints evaluated for input.
      Variable setLB​(double newLB)
      Set the lower bound for this variable.
      Variable setLimit​(double newLimit)
      Set the limit for this variable.
      Variable setName​(java.lang.String newName)
      Set the name of this variable.
      Variable setType​(ColumnType newType)
      Set the type for this variable.
      Variable setUB​(double newUB)
      Set the upper bound for this variable.
      QuadTerm square()
      Create a quadratic term by multiplying this variable with itself.
      java.lang.String toString()
      Returns the name from getName().
      LinTerm uminus()
      Create a new expression that represents the unary minus of this one.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
Parent Topic Class Summary

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