LinTermMap

java.lang.Object
- com.dashoptimization.objects.Expression
- - com.dashoptimization.objects.AbstractExpression
  - - com.dashoptimization.objects.LinExpression
    - - com.dashoptimization.objects.LinTermMap

```
public final class LinTermMap
extends LinExpression
```
A linear expression. This class implements a linear expression as a map from variables to values.

Since:

43.00

Constructor Summary

Constructor	Description
`LinTermMap()`	Create a new empty expression.
`LinTermMap(double constant)`	Create an expression with a constant term.

Method Summary

Modifier and Type	Method	Description
`LinTermMap`	`addConstant(double c)`	Add a value to the constant term of this expression.
`LinTermMap`	`addTerm(double coefficient, Variable variable)`	Add a term to this expression.
`LinTermMap`	`addTerm(Variable x)`	Add term `1*x` to this expression.
`LinTermMap`	`addTerm(Variable variable, double coefficient)`	Add a term to this expression.
`LinTermMap`	`addTerms(LinExpression expr)`	Add another linear expression to this expression.
`LinTermMap`	`addTerms(LinExpression expr, double factor)`	Add another linear expression to this expression.
`LinTermMap`	`addTerms(Variable[] variables, double[] coefficients)`	Add multiple terms to this expression.
`LinTermMap`	`addTerms(java.lang.Iterable<Variable> variables, java.lang.Iterable<java.lang.Double> coefficients)`	Add multiple terms to this expression.
`LinTermMap`	`addTerms(java.util.stream.Stream<Variable> variables, java.util.stream.Stream<java.lang.Double> coefficients)`	Add multiple terms to this expression.
`LinExpression`	`deepCopy()`	Get a deep copy of this expression.
`LinExpression`	`deepCopy(double factor)`	Get a deep copy of this expression multiplied by a constant
`double`	`evaluate(double[] solution)`	Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).
`double`	`getCoefficient(Variable variable)`	Get the coefficient for a variable.
`double`	`getConstant()`	Get the constant value in this expression.
`LinTermMap`	`reset()`	Clear this expression.
`LinTermMap`	`setCoefficient(Variable variable, double coefficient)`	Set the coefficient for a variable in this expression.
`LinTermMap`	`setConstant(double c)`	Set the constant term in this expression.
`java.lang.String`	`toString()`

Methods inherited from class com.dashoptimization.objects.LinExpression
addTerm, create, create, create, setCreateLists, square

Methods inherited from class com.dashoptimization.objects.AbstractExpression
eq, eq, geq, geq, in, leq, leq

Methods inherited from class com.dashoptimization.objects.Expression
div, div, minus, minus, mul, mul, plus, plus, uminus

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LinTermMap
```
public LinTermMap()
```
    Create a new empty expression.
    Examples using LinTermMap:
    
    CuttingStock.java
    
    ELS.java
    
    ELSCut.java
    
    ELSManagedCuts.java
    
    RecursiveFinancialPlanning.java
    Since:
    
    43.00
  - LinTermMap
```
public LinTermMap(double constant)
```
    Create an expression with a constant term.
    Examples using LinTermMap:
    
    CuttingStock.java
    
    ELS.java
    
    ELSCut.java
    
    ELSManagedCuts.java
    
    RecursiveFinancialPlanning.java
    Parameters:
    
    constant - Constant term in new expression.
    
    Since:
    
    43.00
- Method Detail
  - deepCopy
```
public LinExpression deepCopy()
```
    Get a deep copy of this expression.
    
    Specified by:
    
    deepCopy in class LinExpression
    
    Returns:
    
    A deep copy of this expression.
    
    Since:
    
    43.00
  - deepCopy
```
public LinExpression deepCopy(double factor)
```
    Get a deep copy of this expression multiplied by a constant
    
    Specified by:
    
    deepCopy in class LinExpression
    
    Parameters:
    
    factor - Factor to scale this with.
    
    Returns:
    
    A deep copy of this expression multiplied by factor.
    
    Since:
    
    43.00
  - reset
```
public LinTermMap reset()
```
    Clear this expression. Removes all terms and sets the constant to 0.
    
    Specified by:
    
    reset in class LinExpression
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerms
```
public LinTermMap addTerms(java.util.stream.Stream<Variable> variables,
                           java.util.stream.Stream<java.lang.Double> coefficients)
```
    Add multiple terms to this expression. Adds the scalar product defined by the element-wise multiplication of variables and coefficients.
    
    Overrides:
    
    addTerms in class LinExpression
    
    Parameters:
    
    variables - Variables.
    
    coefficients - Coefficients.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerms
```
public LinTermMap addTerms(java.lang.Iterable<Variable> variables,
                           java.lang.Iterable<java.lang.Double> coefficients)
```
    Add multiple terms to this expression. Adds the scalar product defined by the element-wise multiplication of variables and coefficients.
    
    Overrides:
    
    addTerms in class LinExpression
    
    Parameters:
    
    variables - Variables.
    
    coefficients - Coefficients.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerms
```
public LinTermMap addTerms(Variable[] variables,
                           double[] coefficients)
```
    Add multiple terms to this expression. Adds the scalar product defined by the element-wise multiplication of variables and coefficients.
    
    Overrides:
    
    addTerms in class LinExpression
    
    Parameters:
    
    variables - Variables
    
    coefficients - Coefficients
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerm
```
public LinTermMap addTerm(Variable variable,
                          double coefficient)
```
    Add a term to this expression. If the expression already has a coefficient for variable then the old and the new coefficients will be added.
    Examples using addTerm:
    
    Catenary.java
    
    CuttingStock.java
    
    ELS.java
    
    ELSCut.java
    
    ELSManagedCuts.java
    
    FolioIIS.java
    
    FolioQC.java
    
    FolioQP.java
    
    Pplan.java
    
    Pplan2.java
    
    ProductionPlanning_Index.java
    
    QuadraticProgramming.java
    
    RecursiveFinancialPlanning.java
    
    Sangraalind.java
    
    TravelingSalesPerson.java
    Specified by:
    
    addTerm in class LinExpression
    
    Parameters:
    
    variable - Variable.
    
    coefficient - Coefficient to add for variable.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerm
```
public LinTermMap addTerm(double coefficient,
                          Variable variable)
```
    Add a term to this expression. If the expression already has a coefficient for variable then the old and the new coefficients will be added.
    Examples using addTerm:
    
    Catenary.java
    
    CuttingStock.java
    
    ELS.java
    
    ELSCut.java
    
    ELSManagedCuts.java
    
    FolioIIS.java
    
    FolioQC.java
    
    FolioQP.java
    
    Pplan.java
    
    Pplan2.java
    
    ProductionPlanning_Index.java
    
    QuadraticProgramming.java
    
    RecursiveFinancialPlanning.java
    
    Sangraalind.java
    
    TravelingSalesPerson.java
    Specified by:
    
    addTerm in class LinExpression
    
    Parameters:
    
    coefficient - Coefficient to add for variable.
    
    variable - Variable.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerm
```
public LinTermMap addTerm(Variable x)
```
    Add term 1*x to this expression. If the expression already has a coefficient for x then the old and the new coefficients will be added.
    Examples using addTerm:
    
    Catenary.java
    
    CuttingStock.java
    
    ELS.java
    
    ELSCut.java
    
    ELSManagedCuts.java
    
    FolioIIS.java
    
    FolioQC.java
    
    FolioQP.java
    
    Pplan.java
    
    Pplan2.java
    
    ProductionPlanning_Index.java
    
    QuadraticProgramming.java
    
    RecursiveFinancialPlanning.java
    
    Sangraalind.java
    
    TravelingSalesPerson.java
    Specified by:
    
    addTerm in class LinExpression
    
    Parameters:
    
    x - Variable.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerms
```
public LinTermMap addTerms(LinExpression expr)
```
    Add another linear expression to this expression.
    
    Specified by:
    
    addTerms in class LinExpression
    
    Parameters:
    
    expr - The expression to add
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - addTerms
```
public LinTermMap addTerms(LinExpression expr,
                           double factor)
```
    Add another linear expression to this expression.
    
    Specified by:
    
    addTerms in class LinExpression
    
    Parameters:
    
    expr - The expression to add.
    
    factor - Factor by which to multiply elements in expr before adding.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - setCoefficient
```
public LinTermMap setCoefficient(Variable variable,
                                 double coefficient)
```
    Set the coefficient for a variable in this expression. Any existing coefficient will be overwritten.
    
    Parameters:
    
    variable - Variable index.
    
    coefficient - New coefficient for variable.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - getCoefficient
```
public double getCoefficient(Variable variable)
```
    Get the coefficient for a variable.
    
    Parameters:
    
    variable - Variable to query.
    
    Returns:
    
    The coefficient for variable in this expression.
    
    Since:
    
    43.00
  - addConstant
```
public LinTermMap addConstant(double c)
```
    Add a value to the constant term of this expression.
    
    Specified by:
    
    addConstant in class LinExpression
    
    Parameters:
    
    c - The constant to add.
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - setConstant
```
public LinTermMap setConstant(double c)
```
    Set the constant term in this expression. Any existing constant term will be overwritten.
    
    Specified by:
    
    setConstant in class LinExpression
    
    Parameters:
    
    c - New constant term for this expression
    
    Returns:
    
    Always returns this.
    
    Since:
    
    43.00
  - getConstant
```
public double getConstant()
```
    Get the constant value in this expression.
    
    Specified by:
    
    getConstant in class LinExpression
    
    Returns:
    
    The constant value in this expression.
    
    Since:
    
    43.00
  - evaluate
```
public double evaluate(double[] solution)
```
    Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).
    Examples using evaluate:
    
    CapitalBudgeting.java
    
    PolygonObjects.java
    Specified by:
    
    evaluate in class Expression
    
    Parameters:
    
    solution - Solution values for which the expression is evaluated.
    
    Returns:
    
    The value of this expression evaluated at solution.
    
    Since:
    
    43.00
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Since:
    
    43.00

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

Contents

Index

Glossary

Search Results

LinTermMap

Constructor Summary

Method Summary

Methods inherited from class com.dashoptimization.objects.LinExpression

Methods inherited from class com.dashoptimization.objects.AbstractExpression

Methods inherited from class com.dashoptimization.objects.Expression

Methods inherited from class java.lang.Object

Constructor Detail

LinTermMap

LinTermMap

Method Detail

deepCopy

deepCopy

reset

addTerms

addTerms

addTerms

addTerm

addTerm

addTerm

addTerms

addTerms

setCoefficient

getCoefficient

addConstant

setConstant

getConstant

evaluate

toString