QuadTerm

java.lang.Object
- com.dashoptimization.objects.Expression
- - com.dashoptimization.objects.AbstractExpression
  - - com.dashoptimization.objects.QuadTerm

public final class QuadTerm
extends AbstractExpression

A quadratic term.

Since:: 43.00

Constructor Summary

Constructor	Description
`QuadTerm(Variable variable1, Variable variable2, double coefficient)`	Create a new term.

Method Summary

Modifier and Type	Method	Description
`QuadTerm`	`div(double arg)`	Create a new expression that represents the quotient of `this` and `arg`.
`QuadTerm`	`div(ConstantExpression arg)`
`Expression`	`div(Expression arg)`	Create a new expression that represents the quotient of `this` and `arg`.
`double`	`evaluate(double[] solution)`	Compute the value of this expression with respect to the given solution vector (which is not required to be feasible).
`void`	`extract(double factor, PostfixExtractor extractor)`	Extract this expression into postfix notation.
`boolean`	`extract(double factor, XPRSprob.RowCreator creator)`	Extract this expression into a row.
`double`	`getCoefficient()`
`Variable`	`getVariable1()`
`Variable`	`getVariable2()`
`QuadTerm`	`mul(double arg)`	Create a new expression that represents the product of `this` and `arg`.
`QuadTerm`	`mul(ConstantExpression arg)`
`Expression`	`mul(Expression arg)`	Create a new expression that represents the product of `this` and `arg`.
`static QuadTerm`	`qTerm(Variable variable1, Variable variable2)`	Convenience function to create a single quadratic term.
`static QuadTerm`	`qTerm(Variable variable1, Variable variable2, double coefficient)`	Convenience function to create a single quadratic term.
`java.lang.String`	`toString()`
`static java.lang.String`	`toString(Variable v1, Variable v2, double coef)`	Convert a quadratic term to a string.
`QuadTerm`	`uminus()`	Create a new expression that represents the unary minus of this one.

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

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

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

- Constructor Detail
  - QuadTerm
```
public QuadTerm(Variable variable1,
                Variable variable2,
                double coefficient)
```
    Create a new term.
    
    Parameters:
    
    variable1 - First variable in the term.
    
    variable2 - Second variable in the term.
    
    coefficient - Coefficient for variable1 * variable2.
    
    Since:
    
    43.00
- Method Detail
  - getVariable1
```
public Variable getVariable1()
```
  - getVariable2
```
public Variable getVariable2()
```
  - getCoefficient
```
public double getCoefficient()
```
  - extract
```
public 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:
    
    extract in class Expression
    
    Parameters:
    
    factor - Factor by which to multiply the expression during extraction.
    
    creator - The creator to which this expression should be extracted.
    
    Returns:
    
    true if the low-level representation does requires normalization (sorting, removal of dups, ...). In some special cases we know that this is not required and can return false to save the overhead.
    
    Since:
    
    43.00
  - extract
```
public void extract(double factor,
                    PostfixExtractor extractor)
```
    Extract this expression into postfix notation.
    
    Specified by:
    
    extract in class Expression
    
    Parameters:
    
    factor - Factor by which to multiply the expression during extraction.
    
    extractor - The extractor to which the expression is extract.
    
    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).
    
    Specified by:
    
    evaluate in class Expression
    
    Parameters:
    
    solution - Solution values for which the expression is evaluated.
    
    Since:
    
    43.00
  - qTerm
```
public static QuadTerm qTerm(Variable variable1,
                             Variable variable2,
                             double coefficient)
```
    Convenience function to create a single quadratic term.
    
    Parameters:
    
    variable1 - First variable for term.
    
    variable2 - Second variable for term.
    
    coefficient - Coefficient for term.
    
    Returns:
    
    The newly created term.
    
    Since:
    
    43.00
  - qTerm
```
public static QuadTerm qTerm(Variable variable1,
                             Variable variable2)
```
    Convenience function to create a single quadratic term. Creates the term 1 * variable1 * variable2.
    
    Parameters:
    
    variable1 - First variable for term.
    
    variable2 - Second variable for term.
    
    Returns:
    
    The newly created term.
    
    Since:
    
    43.00
  - toString
```
public java.lang.String toString()
```
    Used in these examples:
    
    GlobalRHSParametrics
    
    IISExample
    
    Knapsack
    
    Trimloss
    Overrides:
    
    toString in class java.lang.Object
    
    Since:
    
    43.00
  - toString
```
public static java.lang.String toString(Variable v1,
                                        Variable v2,
                                        double coef)
```
    Convert a quadratic term to a string. Note that while the QuadTerm class does not allow XpressProblem.NULL_VARIABLE as either of the variables, this function allows those variables to indicate constant or linear terms.
    Used in these examples:
    
    GlobalRHSParametrics
    
    IISExample
    
    Knapsack
    
    Trimloss
    Parameters:
    
    v1 - First variable in quadratic term.
    
    v2 - Second variable in quadratic term.
    
    coef - Coeffcient for quadratic term.
    
    Returns:
    
    String representation of coef*v1*v2.
    
    Since:
    
    43.00
  - uminus
```
public QuadTerm uminus()
```
    Create a new expression that represents the unary minus of this one.
    
    Overrides:
    
    uminus in class Expression
    
    Returns:
    
    Expression representing -this.
    
    Since:
    
    43.00
  - mul
```
public Expression mul(Expression arg)
```
    Create a new expression that represents the product of this and arg.
    
    Overrides:
    
    mul in class Expression
    
    Parameters:
    
    arg - Factor.
    
    Returns:
    
    Product of this and arg.
    
    Since:
    
    43.00
  - mul
```
public QuadTerm mul(ConstantExpression arg)
```
    Since:
    
    43.00
  - mul
```
public QuadTerm mul(double arg)
```
    Description copied from class: Expression
    
    Create a new expression that represents the product of this and arg.
    
    Overrides:
    
    mul in class Expression
    
    Parameters:
    
    arg - Factor.
    
    Returns:
    
    Product of this and arg.
    
    Since:
    
    43.00
  - div
```
public Expression div(Expression arg)
```
    Create a new expression that represents the quotient of this and arg.
    
    Overrides:
    
    div in class Expression
    
    Parameters:
    
    arg - Divisor.
    
    Returns:
    
    Quotient of this and arg.
    
    Since:
    
    43.00
  - div
```
public QuadTerm div(ConstantExpression arg)
```
    Since:
    
    43.00
  - div
```
public QuadTerm div(double arg)
```
    Create a new expression that represents the quotient of this and arg.
    
    Overrides:
    
    div in class Expression
    
    Parameters:
    
    arg - Divisor.
    
    Returns:
    
    Quotient of this and arg.
    
    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.

Contents

Index

Glossary

Search Results

QuadTerm

Constructor Summary

Method Summary

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

QuadTerm

Method Detail

getVariable1

getVariable2

getCoefficient

extract

extract

evaluate

qTerm

qTerm

toString

toString

uminus

mul

mul

mul

div

div

div