Module ojalgo

Package org.ojalgo.optimisation.convex

Class ConvexData<N extends Comparable<N>>

java.lang.Object

org.ojalgo.optimisation.convex.ConvexData<N>

All Implemented Interfaces:

ExpressionsBasedModel.EntityMap, Optimisation, Optimisation.ProblemStructure

public final class ConvexData<N extends Comparable<N>>
extends Object
implements ExpressionsBasedModel.EntityMap

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.ProblemStructure, Optimisation.Result, Optimisation.Sense, Optimisation.Solver, Optimisation.State

Field Summary

Fields inherited from interface org.ojalgo.optimisation.Optimisation.ProblemStructure

DEBUG

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()
PhysicalStore<N>	getAE()	Equality constraints body: [AE][X] == [BE]
MatrixStore<N>	getBE()	Equality constraints RHS: [AE][X] == [BE]
double	getBE(int row)
MatrixStore<N>	getBI()	Inequality constraints RHS: [AI][X] invalid input: '<'= [BI]
double	getBI(int row)
EntryPair<ModelEntity<?>,Optimisation.ConstraintType>	getConstraint(int idc)
double	getDensityAE()
double	getDensityAI()
ConvexObjectiveFunction<N>	getObjective()
Access2D.RowView<N>	getRowsAE()
Access2D.RowView<N>	getRowsAI()
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	indexOf(int idm)	Converts from a solver specific variable index to the corresponding index of the variable in the model.
boolean	isNegated(int idm)	Is this solver variable negated relative to the corresponding model variable?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAE

public PhysicalStore<N> getAE()

Equality constraints body: [AE][X] == [BE]

getBE

public MatrixStore<N> getBE()

Equality constraints RHS: [AE][X] == [BE]

getBE

public double getBE(int row)

getBI

public MatrixStore<N> getBI()

Inequality constraints RHS: [AI][X] invalid input: '<'= [BI]

getBI

public double getBI(int row)

getConstraint

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

Specified by:

getConstraint in interface ExpressionsBasedModel.EntityMap

getDensityAE

public double getDensityAE()

getDensityAI

public double getDensityAI()

getObjective

public ConvexObjectiveFunction<N> getObjective()

getRowsAE

public Access2D.RowView<N> getRowsAE()

getRowsAI

public Access2D.RowView<N> getRowsAI()

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].)

indexOf

public int indexOf(int idm)

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:

idm - Index of solver variable

Returns:

Index of model variable (negative if no map)

isNegated

public boolean isNegated(int idm)

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:

idm - Index of solver variable

Returns:

true if this solver variable represents a negated model variable