Class LinearStructure

java.lang.Object

org.ojalgo.optimisation.linear.LinearStructure

All Implemented Interfaces:

ExpressionsBasedModel.EntityMap, Optimisation, Optimisation.ProblemStructure

final class LinearStructure
extends Object
implements ExpressionsBasedModel.EntityMap

LP (simplex tableau) meta data.

Nested Class Summary

Nested classes/interfaces inherited from interface Optimisation

Optimisation.Constraint, Optimisation.ConstraintType, Optimisation.Integration<M,S>, Optimisation.Model, Optimisation.Objective, Optimisation.Options, Optimisation.ProblemStructure, Optimisation.Result, Optimisation.Sense, Optimisation.Solver, Optimisation.State

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ConstraintsMetaData	constraints
(package private) final int	nbArti	The number of artificial variables
(package private) final int	nbEqus	The number of equality constraints
(package private) final int	nbIdty	The number of slack variables that also form an identity sub-matrix (in the tableau).
(package private) final int	nbInes	The number of inequality constraints
(package private) final int	nbNegs	The number of negated model variables
(package private) final int	nbSlck	The number of slack variables (not known to be "identity")
(package private) final int	nbVars	The number of positive (as-is) model variables
(package private) final int[]	negativePartVariables
(package private) final int[]	positivePartVariables

Fields inherited from interface Optimisation.ProblemStructure

DEBUG

Constructor Summary

Constructors

Constructor	Description
LinearStructure(boolean inclMap, int constrIn, int constrEq, int varsPos, int varsNeg, int varsSlk, int varsEye)
LinearStructure(int nbConstraints, int nbVariables)

Method Summary

Modifier and Type	Method	Description
int	countAdditionalConstraints()	Not included in Optimisation.ProblemStructure.countConstraints() (because they are not simple linear equality or inequality constraints),
int	countConstraints()
int	countEqualityConstraints()
int	countInequalityConstraints()
int	countModelVariables()	The number of variables, in the solver, that directly correspond to a model variable.
int	countSlackVariables()	The number of slack variables.
int	countVariables()
(package private) int	countVariablesExcluded()	The number of non-basic variables.
(package private) int	countVariablesIncluded()	The number of basic variables.
(package private) int	countVariablesTotally()
boolean	equals(Object obj)
EntryPair<ModelEntity<?>, Optimisation.ConstraintType>	getConstraint(int idc)
(package private) double	getProblemRatio()
(package private) long	getProblemSize()
EntryPair<ModelEntity<?>, Optimisation.ConstraintType>	getSlack(int ids)	Returns which model entity, and constraint type, that corresponds to the slack variable at the supplied index.
int	hashCode()
int	indexOf(int j)	Converts from a solver specific variable index to the corresponding index of the variable in the model.
(package private) boolean	isAnyArtificials()
(package private) boolean	isArtificialVariable(int variableIndex)
boolean	isConstraintNegated(int i)
(package private) boolean	isFullSetOfArtificials()
(package private) boolean	isModelVariable(int variableIndex)
boolean	isNegated(int j)	Is this solver variable negated relative to the corresponding model variable?
boolean	negated(int i, boolean negated)
void	setConstraintMap(int i, ModelEntity<?> entity, Optimisation.ConstraintType type)
void	setConstraintMap(int i, ModelEntity<?> entity, Optimisation.ConstraintType type, boolean negated)
void	setConstraintNegated(int i, boolean negated)
(package private) void	setObjectiveAdjustmentFactor(double multiplierScale)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

constraints

final ConstraintsMetaData constraints

nbArti

final int nbArti

The number of artificial variables

nbEqus

final int nbEqus

The number of equality constraints

nbIdty

final int nbIdty

The number of slack variables that also form an identity sub-matrix (in the tableau).

nbInes

final int nbInes

The number of inequality constraints

nbNegs

final int nbNegs

The number of negated model variables

nbSlck

final int nbSlck

The number of slack variables (not known to be "identity")

nbVars

final int nbVars

The number of positive (as-is) model variables

negativePartVariables

final int[] negativePartVariables

positivePartVariables

final int[] positivePartVariables

Constructor Details

LinearStructure

LinearStructure(boolean inclMap,
 int constrIn,
 int constrEq,
 int varsPos,
 int varsNeg,
 int varsSlk,
 int varsEye)

LinearStructure

LinearStructure(int nbConstraints,
 int nbVariables)

Method Details

countAdditionalConstraints

public int countAdditionalConstraints()

Description copied from interface: Optimisation.ProblemStructure

Not included in Optimisation.ProblemStructure.countConstraints() (because they are not simple linear equality or inequality constraints),

Specified by:

countAdditionalConstraints in interface Optimisation.ProblemStructure

countConstraints

public int countConstraints()

Specified by:

countConstraints in interface Optimisation.ProblemStructure

countEqualityConstraints

public int countEqualityConstraints()

Specified by:

countEqualityConstraints in interface Optimisation.ProblemStructure

countInequalityConstraints

public int countInequalityConstraints()

Specified by:

countInequalityConstraints in interface Optimisation.ProblemStructure

countModelVariables

public int countModelVariables()

Description copied from interface: ExpressionsBasedModel.EntityMap

The number of variables, in the solver, that directly correspond to a model variable. (Not slack or artificial variables.)

This defines the range of the indices that can be used with the ExpressionsBasedModel.EntityMap.indexOf(int) and ExpressionsBasedModel.EntityMap.isNegated(int) methods.

Specified by:

countModelVariables in interface ExpressionsBasedModel.EntityMap

countSlackVariables

public int countSlackVariables()

Description copied from interface: ExpressionsBasedModel.EntityMap

The number of slack variables.

This defines the range of the indices that can be used with the ExpressionsBasedModel.EntityMap.getSlack(int) method.

Specified by:

countSlackVariables in interface ExpressionsBasedModel.EntityMap

countVariables

public int countVariables()

Specified by:

countVariables in interface Optimisation.ProblemStructure

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getConstraint

public EntryPair<ModelEntity<?>, Optimisation.ConstraintType> getConstraint(int idc)

Specified by:

getConstraint in interface ExpressionsBasedModel.EntityMap

getSlack

public EntryPair<ModelEntity<?>, Optimisation.ConstraintType> getSlack(int ids)

Description copied from interface: ExpressionsBasedModel.EntityMap

Returns which model entity, and constraint type, that corresponds to the slack variable at the supplied index.

Specified by:

getSlack in interface ExpressionsBasedModel.EntityMap

Parameters:

ids - Index of solver slack variable (If there are 3 slack variables this input argument should be in the range [0.2].)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

indexOf

public int indexOf(int j)

Description copied from interface: ExpressionsBasedModel.EntityMap

Converts from a solver specific variable index to the corresponding index of the variable in the model. Note that not all model variables are necessarily represented in the solver, and a model variable may result in multiple solver variables. Further, slack variables, artificial variables and such are typically not represented in the model.

Specified by:

indexOf in interface ExpressionsBasedModel.EntityMap

Parameters:

j - Index of solver variable

Returns:

Index of model variable (negative if no map)

isConstraintNegated

public boolean isConstraintNegated(int i)

isNegated

public boolean isNegated(int j)

Description copied from interface: ExpressionsBasedModel.EntityMap

Is this solver variable negated relative to the corresponding model variable?

Specified by:

isNegated in interface ExpressionsBasedModel.EntityMap

Parameters:

j - Index of solver variable

Returns:

true if this solver variable represents a negated model variable

negated

public boolean negated(int i,
 boolean negated)

setConstraintMap

public void setConstraintMap(int i,
 ModelEntity<?> entity,
 Optimisation.ConstraintType type)

setConstraintMap

public void setConstraintMap(int i,
 ModelEntity<?> entity,
 Optimisation.ConstraintType type,
 boolean negated)

setConstraintNegated

public void setConstraintNegated(int i,
 boolean negated)

toString

public String toString()

Overrides:

toString in class Object

countVariablesExcluded

int countVariablesExcluded()

The number of non-basic variables.

countVariablesIncluded

int countVariablesIncluded()

The number of basic variables.

countVariablesTotally

int countVariablesTotally()

getProblemRatio

double getProblemRatio()

getProblemSize

long getProblemSize()

isAnyArtificials

boolean isAnyArtificials()

isArtificialVariable

boolean isArtificialVariable(int variableIndex)

isFullSetOfArtificials

boolean isFullSetOfArtificials()

isModelVariable

boolean isModelVariable(int variableIndex)

setObjectiveAdjustmentFactor

void setObjectiveAdjustmentFactor(double multiplierScale)