Variable (ojAlgo 47.2.0 API)

java.lang.Object
- org.ojalgo.optimisation.Variable

All Implemented Interfaces:

Comparable<Variable>, Optimisation, Optimisation.Constraint, Optimisation.Objective
```
public final class Variable
extends Object
```
Variable

Author:

apete

Nested Class Summary
- Nested classes/interfaces inherited from interface org.ojalgo.optimisation.Optimisation
  Optimisation.Constraint, Optimisation.Integration<M extends Optimisation.Model,S extends Optimisation.Solver>, Optimisation.Model, Optimisation.Objective, Optimisation.Options, Optimisation.Result, Optimisation.Solver, Optimisation.State

Constructor Summary

Constructors
Modifier Constructor and Description

Variable(String name)

protected Variable(Variable variableToCopy)

Constructors
Modifier	Constructor and Description
	`Variable(String name)`
`protected`	`Variable(Variable variableToCopy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendLeftPart(StringBuilder builder)`
`protected void`	`appendMiddlePart(StringBuilder aStringBuilder)`
`protected void`	`appendRightPart(StringBuilder builder)`
`Variable`	`binary()`
`int`	`compareTo(Variable obj)`
`Variable`	`copy()`
`protected void`	`destroy()`
`protected void`	`doIntegerRounding()`
`boolean`	`equals(Object obj)`
`double`	`getAdjustedLowerLimit()`
`double`	`getAdjustedUpperLimit()`
`protected int`	`getAdjustmentExponent()`
`double`	`getAdjustmentFactor()`
`BigDecimal`	`getContributionWeight()` The weight/factor by which this model entity's value contributes to the objective function - may return null.
`BigDecimal`	`getLowerLimit()` The lower limit/bound - may return null.
`BigDecimal`	`getLowerSlack()`
`String`	`getName()`
`double`	`getUnadjustedLowerLimit()`
`double`	`getUnadjustedUpperLimit()`
`BigDecimal`	`getUpperLimit()` The upper limit/bound - may return null.
`BigDecimal`	`getUpperSlack()`
`BigDecimal`	`getValue()`
`int`	`hashCode()`
`Variable`	`integer(boolean integer)`
`boolean`	`isBinary()` Variable can only be 0 or 1.
`boolean`	`isConstraint()` The Constraint has a lower or an upper limit actually set (possibly both) - it actually is constained.
`boolean`	`isContributionWeightSet()`
`boolean`	`isEqualityConstraint()` The Constraint has both a lower limit and an upper limit, and they are equal.
`boolean`	`isInteger()`
`boolean`	`isLowerConstraint()` The Constraint has a lower limit, and the upper limit (if it exists) is different.
`boolean`	`isLowerLimitSet()`
`boolean`	`isNegative()`
`boolean`	`isObjective()`
`boolean`	`isPositive()`
`boolean`	`isUpperConstraint()` The Constraint has an upper limit, and the lower limit (if it exists) is different.
`boolean`	`isUpperLimitSet()`
`boolean`	`isValueSet()`
`ME`	`level(Number level)`
`Variable`	`lower(Number lower)` Extremely large (absolute value) values are treated as "no limit" (null) and extremely small values are treated as exactly 0.0, unless the input number type is `BigDecimal`.
`static Variable`	`make(String name)`
`static Variable`	`makeBinary(String name)`
`BigDecimal`	`quantifyContribution()`
`Variable`	`relax()`
`void`	`setInteger(boolean integer)`
`void`	`setValue(Number value)`
`String`	`toString()`
`Variable`	`upper(Number upper)` Extremely large (absolute value) values are treated as "no limit" (null) and extremely small values are treated as exactly 0.0, unless the input number type is `BigDecimal`.
`protected boolean`	`validate(BasicLogger.Printer appender)` Validate model parameters, like lower and upper limits.
`protected boolean`	`validate(BigDecimal value, NumberContext context, BasicLogger.Printer appender)`
`ME`	`weight(Number weight)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Variable
```
public Variable(String name)
```
  - Variable
```
protected Variable(Variable variableToCopy)
```
- Method Detail
  - make
```
public static Variable make(String name)
```
  - makeBinary
```
public static Variable makeBinary(String name)
```
  - binary
```
public Variable binary()
```
    See Also:
    
    getLowerLimit(), getUpperLimit(), isInteger(), isBinary()
  - compareTo
```
public int compareTo(Variable obj)
```
  - copy
```
public Variable copy()
```
  - getLowerSlack
```
public BigDecimal getLowerSlack()
```
  - getUpperSlack
```
public BigDecimal getUpperSlack()
```
  - getValue
```
public BigDecimal getValue()
```
  - integer
```
public Variable integer(boolean integer)
```
    See Also:
    
    isInteger()
  - isBinary
```
public boolean isBinary()
```
    Variable can only be 0 or 1.
  - isInteger
```
public boolean isInteger()
```
    Returns:
    
    true if this is an integer variable, otherwise false
  - isNegative
```
public boolean isNegative()
```
  - isPositive
```
public boolean isPositive()
```
  - isValueSet
```
public boolean isValueSet()
```
  - lower
```
public Variable lower(Number lower)
```
    Extremely large (absolute value) values are treated as "no limit" (null) and extremely small values are treated as exactly 0.0, unless the input number type is BigDecimal. BigDecimal values are always used as they are.
  - quantifyContribution
```
public BigDecimal quantifyContribution()
```
  - relax
```
public Variable relax()
```
  - setInteger
```
public void setInteger(boolean integer)
```
  - setValue
```
public void setValue(Number value)
```
  - upper
```
public Variable upper(Number upper)
```
    Extremely large (absolute value) values are treated as "no limit" (null) and extremely small values are treated as exactly 0.0, unless the input number type is BigDecimal. BigDecimal values are always used as they are.
  - appendMiddlePart
```
protected void appendMiddlePart(StringBuilder aStringBuilder)
```
  - destroy
```
protected void destroy()
```
  - doIntegerRounding
```
protected void doIntegerRounding()
```
  - validate
```
protected boolean validate(BigDecimal value,
                           NumberContext context,
                           BasicLogger.Printer appender)
```
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getAdjustedLowerLimit
```
public final double getAdjustedLowerLimit()
```
  - getAdjustedUpperLimit
```
public final double getAdjustedUpperLimit()
```
  - getAdjustmentFactor
```
public final double getAdjustmentFactor()
```
    Returns:
    
    Adjusted "1"
  - getContributionWeight
```
public final BigDecimal getContributionWeight()
```
    Description copied from interface: Optimisation.Objective
    
    The weight/factor by which this model entity's value contributes to the objective function - may return null.
    
    Specified by:
    
    getContributionWeight in interface Optimisation.Objective
  - getLowerLimit
```
public final BigDecimal getLowerLimit()
```
    Description copied from interface: Optimisation.Constraint
    
    The lower limit/bound - may return null.
    
    Specified by:
    
    getLowerLimit in interface Optimisation.Constraint
  - getName
```
public final String getName()
```
  - getUnadjustedLowerLimit
```
public final double getUnadjustedLowerLimit()
```
  - getUnadjustedUpperLimit
```
public final double getUnadjustedUpperLimit()
```
  - getUpperLimit
```
public final BigDecimal getUpperLimit()
```
    Description copied from interface: Optimisation.Constraint
    
    The upper limit/bound - may return null.
    
    Specified by:
    
    getUpperLimit in interface Optimisation.Constraint
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isConstraint
```
public final boolean isConstraint()
```
    Description copied from interface: Optimisation.Constraint
    
    The Constraint has a lower or an upper limit actually set (possibly both) - it actually is constained.
    
    Specified by:
    
    isConstraint in interface Optimisation.Constraint
  - isContributionWeightSet
```
public final boolean isContributionWeightSet()
```
  - isEqualityConstraint
```
public final boolean isEqualityConstraint()
```
    Description copied from interface: Optimisation.Constraint
    
    The Constraint has both a lower limit and an upper limit, and they are equal.
    
    Specified by:
    
    isEqualityConstraint in interface Optimisation.Constraint
  - isLowerConstraint
```
public final boolean isLowerConstraint()
```
    Description copied from interface: Optimisation.Constraint
    
    The Constraint has a lower limit, and the upper limit (if it exists) is different.
    
    Specified by:
    
    isLowerConstraint in interface Optimisation.Constraint
  - isLowerLimitSet
```
public final boolean isLowerLimitSet()
```
  - isObjective
```
public final boolean isObjective()
```
    Specified by:
    
    isObjective in interface Optimisation.Objective
    
    Returns:
    
    true if this Objective has a non zero contribution weight - it actually is contributing to the objective function.
  - isUpperConstraint
```
public final boolean isUpperConstraint()
```
    Description copied from interface: Optimisation.Constraint
    
    The Constraint has an upper limit, and the lower limit (if it exists) is different.
    
    Specified by:
    
    isUpperConstraint in interface Optimisation.Constraint
  - isUpperLimitSet
```
public final boolean isUpperLimitSet()
```
  - level
```
public final ME level(Number level)
```
    See Also:
    
    getLowerLimit(), getUpperLimit()
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - weight
```
public final ME weight(Number weight)
```
    See Also:
    
    getContributionWeight()
  - appendLeftPart
```
protected void appendLeftPart(StringBuilder builder)
```
  - appendRightPart
```
protected void appendRightPart(StringBuilder builder)
```
  - getAdjustmentExponent
```
protected final int getAdjustmentExponent()
```
  - validate
```
protected final boolean validate(BasicLogger.Printer appender)
```
    Validate model parameters, like lower and upper limits. Does not validate the solution/value.

Class Variable

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.optimisation.Optimisation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Variable

Variable

Method Detail

make

makeBinary

binary

compareTo

copy

getLowerSlack

getUpperSlack

getValue

integer

isBinary

isInteger

isNegative

isPositive

isValueSet

lower

quantifyContribution

relax

setInteger

setValue

upper

appendMiddlePart

destroy

doIntegerRounding

validate

equals

getAdjustedLowerLimit

getAdjustedUpperLimit

getAdjustmentFactor

getContributionWeight

getLowerLimit

getName

getUnadjustedLowerLimit

getUnadjustedUpperLimit

getUpperLimit

hashCode

isConstraint

isContributionWeightSet

isEqualityConstraint

isLowerConstraint

isLowerLimitSet

isObjective

isUpperConstraint

isUpperLimitSet

level

toString

weight

appendLeftPart

appendRightPart

getAdjustmentExponent

validate