LinTerm
- java.lang.Object
-  
  - com.dashoptimization.objects.Expression
-  
    - com.dashoptimization.objects.AbstractExpression
-  
      - com.dashoptimization.objects.LinTerm
 
 
 
-  
   
 public final class LinTerm extends AbstractExpression A linear term.- Since:
- 43.00
 
-  
    
   -  
         Method SummaryModifier and Type Method Description LinTermdiv(double arg)Create a new expression that represents the quotient ofthisandarg.LinTermdiv(ConstantExpression arg)Expressiondiv(Expression arg)Create a new expression that represents the quotient ofthisandarg.doubleevaluate(double[] solution)Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).voidextract(double factor, PostfixExtractor extractor)Extract this expression into postfix notation.booleanextract(double factor, XPRSprob.RowCreator creator)Extract this expression into a row.doublegetCoefficient()VariablegetVariable()static LinTermlTerm(Variable variable)Convenience function to create a single linear term.static LinTermlTerm(Variable variable, double coefficient)Convenience function to create a single linear term.LinTermmul(double arg)Create a new expression that represents the product ofthisandarg.LinTermmul(ConstantExpression arg)Expressionmul(Expression arg)Create a new expression that represents the product ofthisandarg.QuadTermmul(LinTerm arg)QuadTermmul(Variable arg)QuadTermsquare()Multiply this term by itself.java.lang.StringtoString()static java.lang.StringtoString(Variable v, double coef)Convert a linear term to a string.LinTermuminus()Create a new expression that represents the unary minus of this one.-  
           Methods inherited from class com.dashoptimization.objects.AbstractExpressioneq, eq, geq, geq, in, leq, leq
 -  
           Methods inherited from class com.dashoptimization.objects.Expressionminus, minus, plus, plus
 
-  
           
 
-  
         
-  
    
   -  
         Constructor Detail-  LinTermpublic LinTerm(Variable variable, double coefficient) Create a new term.- Parameters:
- 
          variable- objects.Variable in the term.
- 
          coefficient- Coefficient forvariable.
- Since:
- 43.00
 
 
-  
 -  
         Method Detail-  getVariablepublic Variable getVariable() 
 -  getCoefficientpublic double getCoefficient() 
 -  extractpublic boolean extract(double factor, XPRSprob.RowCreator creator)Extract this expression into a row. This is for internal use only, you should never have to call this function explicitly.- Specified by:
- 
          extractin classExpression
- Parameters:
- 
          factor- Factor by which to multiply the expression during extraction.
- 
          creator- The creator to which this expression should be extracted.
- Returns:
- 
          trueif the low-level representation does requires normalization (sorting, removal of dups, ...). In some special cases we know that this is not required and can returnfalseto save the overhead.
- Since:
- 43.00
 
 -  extractpublic void extract(double factor, PostfixExtractor extractor)Extract this expression into postfix notation.- Specified by:
- 
          extractin classExpression
- Parameters:
- 
          factor- Factor by which to multiply the expression during extraction.
- 
          extractor- The extractor to which the expression is extract.
- Since:
- 43.00
 
 -  evaluatepublic double evaluate(double[] solution) Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).- Specified by:
- 
          evaluatein classExpression
- Parameters:
- 
          solution- Solution values for which the expression is evaluated.
- Since:
- 43.00
 
 -  lTermpublic static LinTerm lTerm(Variable variable, double coefficient) Convenience function to create a single linear term.- Parameters:
- 
          variable- objects.Variable for term.
- 
          coefficient- Coefficient for term.
- Returns:
- The newly created term.
- Since:
- 43.00
 
 -  lTermpublic static LinTerm lTerm(Variable variable) Convenience function to create a single linear term. Creates the term1 * variable.- Parameters:
- 
          variable- objects.Variable for term.
- Returns:
- The newly created term.
- Since:
- 43.00
 
 -  squarepublic QuadTerm square() Multiply this term by itself.- Returns:
- The product of this term with itself.
- Since:
- 43.00
 
 -  toStringpublic java.lang.String toString() Used in these examples: - GlobalRHSParametrics
- IISExample
- Knapsack
- Trimloss
 - Overrides:
- 
          toStringin classjava.lang.Object
- Since:
- 43.00
 
 -  toStringpublic static java.lang.String toString(Variable v, double coef) Convert a linear term to a string. Note that while theLinTermclass does not allowXpressProblem.NULL_VARIABLEas variable, this function allows this variable to indicate constantterms.Used in these examples: - GlobalRHSParametrics
- IISExample
- Knapsack
- Trimloss
 - Parameters:
- 
          v- Variable in linear term.
- 
          coef- Coeffcient in linear term.
- Returns:
- 
          String representation of 
          coef*v.
- Since:
- 43.00
 
 -  uminuspublic LinTerm uminus() Create a new expression that represents the unary minus of this one.- Overrides:
- 
          uminusin classExpression
- Returns:
- 
          Expression representing 
          -this.
- Since:
- 43.00
 
 -  mulpublic Expression mul(Expression arg) Create a new expression that represents the product ofthisandarg.- Overrides:
- 
          mulin classExpression
- Parameters:
- 
          arg- Factor.
- Returns:
- 
          Product of 
          thisandarg.
- Since:
- 43.00
 
 -  mulpublic LinTerm mul(ConstantExpression arg) - Since:
- 43.00
 
 -  mulpublic LinTerm mul(double arg) Create a new expression that represents the product ofthisandarg.- Overrides:
- 
          mulin classExpression
- Parameters:
- 
          arg- Factor.
- Returns:
- 
          Product of 
          thisandarg.
- Since:
- 43.00
 
 -  divpublic Expression div(Expression arg) Create a new expression that represents the quotient ofthisandarg.- Overrides:
- 
          divin classExpression
- Parameters:
- 
          arg- Divisor.
- Returns:
- 
          Quotient of 
          thisandarg.
- Since:
- 43.00
 
 -  divpublic LinTerm div(ConstantExpression arg) - Since:
- 43.00
 
 -  divpublic LinTerm div(double arg) Create a new expression that represents the quotient ofthisandarg.- Overrides:
- 
          divin classExpression
- Parameters:
- 
          arg- Divisor.
- Returns:
- 
          Quotient of 
          thisandarg.
- 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.
 
