org.ojalgo.optimisation

Class ModelEntity<ME extends ModelEntity<ME>>

java.lang.Object

org.ojalgo.optimisation.ModelEntity<ME>

All Implemented Interfaces:

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

Direct Known Subclasses:

Expression, MathProgSysModel.Column, MathProgSysModel.Row, Variable

public abstract class ModelEntity<ME extends ModelEntity<ME>>
extends java.lang.Object
implements Optimisation.Constraint, Optimisation.Objective, java.lang.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.Model, Optimisation.Objective, Optimisation.Options, Optimisation.Result, Optimisation.Solver, Optimisation.State

Method Summary

Modifier and Type	Method and Description
int	compareTo(ME obj)
boolean	equals(java.lang.Object obj)
double	getAdjustedLowerLimit()
double	getAdjustedUpperLimit()
double	getAdjustmentFactor()
java.math.BigDecimal	getContributionWeight() May return null
java.math.BigDecimal	getLowerLimit() May return null
java.lang.String	getName()
java.math.BigDecimal	getUpperLimit() May return null
int	hashCode()
boolean	isActiveInequalityConstraint()
boolean	isConstraint() The Constraint has a lower or an upper limit (possibly both).
boolean	isContributionWeightSet()
boolean	isEqualityConstraint() The Constraint has both a lower limit and an upper limit, and they are equal.
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(java.lang.Number aLowerAndUpperLimit)
ME	lower(java.lang.Number lowerLimit)
java.lang.String	toString()
ME	upper(java.lang.Number upperLimit)
ME	weight(java.lang.Number contributionWeight)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public final int compareTo(ME obj)

Specified by:

compareTo in interface java.lang.Comparable<ME extends ModelEntity<ME>>

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getAdjustedLowerLimit

public final double getAdjustedLowerLimit()

getAdjustedUpperLimit

public final double getAdjustedUpperLimit()

getAdjustmentFactor

public final double getAdjustmentFactor()

getContributionWeight

public final java.math.BigDecimal getContributionWeight()

Description copied from interface: Optimisation.Objective

May return null

Specified by:

getContributionWeight in interface Optimisation.Objective

See Also:

org.ojalgo.optimisation.Objective#getContributionWeight()

getLowerLimit

public final java.math.BigDecimal getLowerLimit()

Description copied from interface: Optimisation.Constraint

May return null

Specified by:

getLowerLimit in interface Optimisation.Constraint

See Also:

org.ojalgo.optimisation.Constraint#getLowerLimit()

getName

public final java.lang.String getName()

getUpperLimit

public final java.math.BigDecimal getUpperLimit()

Description copied from interface: Optimisation.Constraint

May return null

Specified by:

getUpperLimit in interface Optimisation.Constraint

See Also:

org.ojalgo.optimisation.Constraint#getUpperLimit()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

isActiveInequalityConstraint

public final boolean isActiveInequalityConstraint()

isConstraint

public final boolean isConstraint()

Description copied from interface: Optimisation.Constraint

The Constraint has a lower or an upper limit (possibly both).

Specified by:

isConstraint in interface Optimisation.Constraint

See Also:

org.ojalgo.optimisation.Constraint#isConstraint()

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

See Also:

org.ojalgo.optimisation.Constraint#isEqualityConstraint()

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

See Also:

org.ojalgo.optimisation.Constraint#isLowerConstraint()

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.

See Also:

org.ojalgo.optimisation.Objective#isObjective()

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

See Also:

org.ojalgo.optimisation.Constraint#isUpperConstraint()

isUpperLimitSet

public final boolean isUpperLimitSet()

level

public final ME level(java.lang.Number aLowerAndUpperLimit)

lower

public final ME lower(java.lang.Number lowerLimit)

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

upper

public final ME upper(java.lang.Number upperLimit)

weight

public final ME weight(java.lang.Number contributionWeight)