ModelEntity (ojAlgo 51.2.0 API)

java.lang.Object
- org.ojalgo.optimisation.ModelEntity<ME>

All Implemented Interfaces:

Comparable<ME>, Optimisation, Optimisation.Constraint, Optimisation.Objective

Direct Known Subclasses:

Expression, Variable
```
public abstract class ModelEntity<ME extends ModelEntity<ME>>
extends Object
implements Optimisation.Constraint, Optimisation.Objective, Comparable<ME>
```
Model entities are identified and compared by their names only. Any/all other members/attributes are NOT part of equals(), hashCode() or compareTo().

Author:

apete

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected ModelEntity(ME entityToCopy)

protected ModelEntity(String name)

Constructors
Modifier	Constructor and Description
`protected`	`ModelEntity(ME entityToCopy)`
`protected`	`ModelEntity(String name)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addTo(Expression target, BigDecimal scale)`
`BigDecimal`	`adjust(BigDecimal factor)`
`protected void`	`appendLeftPart(StringBuilder builder)`
`protected void`	`appendMiddlePart(StringBuilder builder)`
`protected void`	`appendRightPart(StringBuilder builder)`
`protected void`	`destroy()`
`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.
`String`	`getName()`
`double`	`getUnadjustedLowerLimit()`
`double`	`getUnadjustedUpperLimit()`
`BigDecimal`	`getUpperLimit()` The upper limit/bound - may return null.
`int`	`hashCode()`
`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.
`abstract boolean`	`isInteger()` Is this entity (all involved variables) integer?
`boolean`	`isLowerConstraint()` The Constraint has a lower limit, and the upper limit (if it exists) is different.
`boolean`	`isLowerLimitSet()`
`boolean`	`isObjective()`
`boolean`	`isUpperConstraint()` The Constraint has an upper limit, and the lower limit (if it exists) is different.
`boolean`	`isUpperLimitSet()`
`ME`	`level(Comparable<?> level)`
`ME`	`level(double level)`
`ME`	`level(long level)`
`ME`	`lower(Comparable<?> 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`.
`ME`	`lower(double lower)`
`ME`	`lower(long lower)`
`BigDecimal`	`reverseAdjustment(BigDecimal adjusted)` Purely the reverse scaling part of `toUnadjusted(double, NumberContext)`
`void`	`shift(BigDecimal shift)` Add this shift to the lower/upper limits, if they exist.
`double`	`toAdjusted(BigDecimal unadjusted)` Will convert a `BigDecimal` model parameter to a corresponing `double` solver parameter, in the process scaling it.
`String`	`toString()`
`BigDecimal`	`toUnadjusted(double adjusted, NumberContext context)` The inverse of `toAdjusted(BigDecimal)`.
`ME`	`upper(Comparable<?> 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`.
`ME`	`upper(double upper)`
`ME`	`upper(long upper)`
`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(Comparable<?> weight)`
`ME`	`weight(double weight)`
`ME`	`weight(long weight)`

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

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - ModelEntity
```
protected ModelEntity(ME entityToCopy)
```
  - ModelEntity
```
protected ModelEntity(String name)
```
- Method Detail
  - addTo
```
public abstract void addTo(Expression target,
                           BigDecimal scale)
```
  - adjust
```
public final BigDecimal adjust(BigDecimal factor)
```
  - 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
  - isInteger
```
public abstract boolean isInteger()
```
    Is this entity (all involved variables) integer?
  - 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(Comparable<?> level)
```
    See Also:
    
    getLowerLimit(), getUpperLimit()
  - level
```
public final ME level(double level)
```
  - level
```
public final ME level(long level)
```
  - lower
```
public ME lower(Comparable<?> 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.
  - lower
```
public final ME lower(double lower)
```
  - lower
```
public final ME lower(long lower)
```
  - reverseAdjustment
```
public final BigDecimal reverseAdjustment(BigDecimal adjusted)
```
    Purely the reverse scaling part of toUnadjusted(double, NumberContext)
  - shift
```
public void shift(BigDecimal shift)
```
    Add this shift to the lower/upper limits, if they exist.
  - toAdjusted
```
public final double toAdjusted(BigDecimal unadjusted)
```
    Will convert a BigDecimal model parameter to a corresponing double solver parameter, in the process scaling it. This operation is reversed by toUnadjusted(double, NumberContext) and/or reverseAdjustment(BigDecimal).
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - toUnadjusted
```
public final BigDecimal toUnadjusted(double adjusted,
                                     NumberContext context)
```
    The inverse of toAdjusted(BigDecimal). This will also enforce the lower and upper limits as well as the NumberContext. To "only" do the reverse adjustment call reverseAdjustment(BigDecimal).
  - upper
```
public ME upper(Comparable<?> 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.
  - upper
```
public final ME upper(double upper)
```
  - upper
```
public final ME upper(long upper)
```
  - weight
```
public final ME weight(Comparable<?> weight)
```
    See Also:
    
    getContributionWeight()
  - weight
```
public final ME weight(double weight)
```
  - weight
```
public final ME weight(long weight)
```
  - appendLeftPart
```
protected void appendLeftPart(StringBuilder builder)
```
  - appendMiddlePart
```
protected void appendMiddlePart(StringBuilder builder)
```
  - appendRightPart
```
protected void appendRightPart(StringBuilder builder)
```
  - destroy
```
protected void destroy()
```
  - 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.
  - validate
```
protected boolean validate(BigDecimal value,
                           NumberContext context,
                           BasicLogger.Printer appender)
```

Class ModelEntity<ME extends ModelEntity<ME>>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Constructor Detail

ModelEntity

ModelEntity

Method Detail

addTo

adjust

equals

getAdjustedLowerLimit

getAdjustedUpperLimit

getAdjustmentFactor

getContributionWeight

getLowerLimit

getName

getUnadjustedLowerLimit

getUnadjustedUpperLimit

getUpperLimit

hashCode

isConstraint

isContributionWeightSet

isEqualityConstraint

isInteger

isLowerConstraint

isLowerLimitSet

isObjective

isUpperConstraint

isUpperLimitSet

level

level

level

lower

lower

lower

reverseAdjustment

shift

toAdjusted

toString

toUnadjusted

upper

upper

upper

weight

weight

weight

appendLeftPart

appendMiddlePart

appendRightPart

destroy

getAdjustmentExponent

validate

validate