org.processmining.lpengines.implementations

Class LPEngineLpSolveImpl

java.lang.Object

org.processmining.lpengines.implementations.LPEngineLpSolveImpl

All Implemented Interfaces:

java.lang.Cloneable, LPEngine

Direct Known Subclasses:

LPEngineLpSolveDisposableImpl

public class LPEngineLpSolveImpl
extends java.lang.Object
implements LPEngine

Nested Class Summary

Nested classes/interfaces inherited from interface org.processmining.lpengines.interfaces.LPEngine

LPEngine.EngineType, LPEngine.ObjectiveTargetType, LPEngine.Operator, LPEngine.VariableType

Field Summary

Fields

Modifier and Type	Field and Description
protected lpsolve.LpSolve	engine
protected java.lang.Object	lock

Constructor Summary

Constructors

Constructor and Description
LPEngineLpSolveImpl()
LPEngineLpSolveImpl(int rows, int columns)

Method Summary

Modifier and Type	Method and Description
void	accept(LPEngineVisitor visitor)
int	addConstraint(double[] constraint, LPEngine.Operator operator, double value) Add a constraints to the LP Engine
int	addConstraint(java.util.Map<java.lang.Integer,java.lang.Double> constraint, LPEngine.Operator operator, double value) Add a constraints to the LP Engine
int	addVariable(double[] column, LPEngine.VariableType type) Add a variable.
int	addVariable(java.util.Map<java.lang.Integer,java.lang.Double> nonZeroValues, LPEngine.VariableType type) Add a variable.
protected boolean	boolCheck(double value)
LPEngine	clone()
void	destroy() destroy the ILP problem and (try to) free the memory;
double[]	emptyConstraint() Return an empty constraint ([0,0,...0]) with the appropriate length for addition.
double[]	emptyVariable() Return an empty objective array ([0,0,...0]) with the appropriate length for addition.
LPEngine.EngineType	engineType() Returns what engineType is actually used by the implementing class.
double	getVariableLowerBound(int variableIndex)
double	getVariableUpperBound(int variableIndex)
static void	init()
protected boolean	intCheck(double value)
boolean	isFeasible() Assess whether is at least one solution
protected org.processmining.framework.util.Pair<int[],double[]>	mapToIndexValueArrayPair(java.util.Map<java.lang.Integer,java.lang.Double> map)
int	minimalConstraintIndex() Given a specific engine type (e.g.
int	minimalVariableIndex() Given a specific engine type (e.g.
int	numConstraints() Query the total number of constraints (== rows in matrix)
int	numVariables() Query the total number of variables (== columns in matrix)
void	pop() pop a constraint out of the engine (that is the constraint with the max.
void	print() Print the current state of the LP.
boolean	removeConstraint(int row) Remove the given constraints.
boolean	removeVariable(int column) Remove a variable from the LP.
boolean	setConstraint(int row, double[] constraint) Set the given row with the provided constraints Note: the size of the array should equal the number of constraints.
boolean	setConstraint(int row, double[] constraint, double rhs) Set the given row with the provided constraint and rhs.
boolean	setConstraint(int row, double[] constraint, LPEngine.Operator op, double rhs) Set the given row with the provided constraint, operator and rhs
boolean	setConstraint(int row, java.util.Map<java.lang.Integer,java.lang.Double> constraint) Renew the given row with the provided constraints.
boolean	setConstraintOperator(int row, LPEngine.Operator op) Set the given constraint's operator (e.g.
void	setEngine(lpsolve.LpSolve engine)
boolean	setLowerBound(int column, double lowerBound) Set a variable's lower-bound.
void	setMat(int rowIndex, int columnIndex, double value) Set a cell within the engine.
boolean	setObjective(double[] objective, LPEngine.ObjectiveTargetType target) Set the objectives value of the P
boolean	setObjective(java.util.Map<java.lang.Integer,java.lang.Double> objective, LPEngine.ObjectiveTargetType target) Set the objectives value of the LP
boolean	setObjectiveType(LPEngine.ObjectiveTargetType target) Set the type of the objectives, either minimize or maximize.
boolean	setRightHandSide(int row, double rhs)
void	setTimeOut(long seconds)
boolean	setType(int column, LPEngine.VariableType type) Set a variable's type to be of type int.
void	setup()
boolean	setUpperBound(int variable, double upperBound) Set a variable upperbound.
java.util.Map<java.lang.Integer,java.lang.Double>	solve() Solve the LP and return the best variable assignment
org.processmining.framework.util.Pair<double[],java.lang.Double>	solveAndResetAndValueNative()
org.processmining.framework.util.Pair<java.util.Map<java.lang.Integer,java.lang.Double>,java.lang.Double>	solveAndValue() Solve the LP and return the best variable assignment and the assignment value.
org.processmining.framework.util.Pair<double[],java.lang.Double>	solveAndValueNative() Solve the LP and return the best variable assignment and the assignment value.
double[]	solveNative() Solve the LP and return the best variable assignment
org.processmining.framework.util.Pair<org.processmining.framework.util.Pair<double[],java.lang.Double>,java.lang.Long>	solveValueNativeSolveTimeNano()
protected boolean	valueMatchesType(double d, LPEngine.VariableType type)
protected double[]	variableMapToArray(java.util.Map<java.lang.Integer,java.lang.Double> variableMap) translates a variable map (i.e.
protected boolean	variableMatchesType(double[] values, LPEngine.VariableType type)
protected boolean	variableMatchesType(java.util.Map<java.lang.Integer,java.lang.Double> nonZeroValues, LPEngine.VariableType type)
void	writeToFile(java.lang.String dest)

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected lpsolve.LpSolve engine

lock

protected final java.lang.Object lock

Constructor Detail

LPEngineLpSolveImpl

public LPEngineLpSolveImpl()

LPEngineLpSolveImpl

public LPEngineLpSolveImpl(int rows,
                           int columns)

Method Detail

init

public static void init()

accept

public void accept(LPEngineVisitor visitor)

Specified by:

accept in interface LPEngine

addConstraint

public int addConstraint(double[] constraint,
                         LPEngine.Operator operator,
                         double value)

Description copied from interface: LPEngine

Add a constraints to the LP Engine

Specified by:

addConstraint in interface LPEngine

Parameters:

constraint - to add

operator - of constraints

value - target value of constraints

Returns:

row index of the constraints

addConstraint

public int addConstraint(java.util.Map<java.lang.Integer,java.lang.Double> constraint,
                         LPEngine.Operator operator,
                         double value)

Description copied from interface: LPEngine

Add a constraints to the LP Engine

Specified by:

addConstraint in interface LPEngine

Parameters:

constraint - map of variable to double value

operator - of constraints

value - target value of constraints

Returns:

row index of the constraints

addVariable

public int addVariable(double[] column,
                       LPEngine.VariableType type)

Description copied from interface: LPEngine

Add a variable. Note: the double array should equal the number of rows in the LP. The type parameter specifies the variable's type

Specified by:

addVariable in interface LPEngine

Parameters:

column - an array of double's specifying the column

type - type of the variable

Returns:

column index of variable, -1 upon failure

addVariable

public int addVariable(java.util.Map<java.lang.Integer,java.lang.Double> nonZeroValues,
                       LPEngine.VariableType type)

Description copied from interface: LPEngine

Add a variable. The map, maps a variable index to a coefficient. The type parameter specifies the variable's type

Specified by:

addVariable in interface LPEngine

Parameters:

nonZeroValues - mapping of row number to non-zero elements

Returns:

column index of lp variable, -1 upon failure.

boolCheck

protected boolean boolCheck(double value)

clone

public LPEngine clone()
               throws java.lang.CloneNotSupportedException

Specified by:

clone in interface LPEngine

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

destroy

public void destroy()

Description copied from interface: LPEngine

destroy the ILP problem and (try to) free the memory;

Specified by:

destroy in interface LPEngine

emptyConstraint

public double[] emptyConstraint()

Description copied from interface: LPEngine

Return an empty constraint ([0,0,...0]) with the appropriate length for addition.

Specified by:

emptyConstraint in interface LPEngine

Returns:

constraint

emptyVariable

public double[] emptyVariable()

Description copied from interface: LPEngine

Return an empty objective array ([0,0,...0]) with the appropriate length for addition.

Specified by:

emptyVariable in interface LPEngine

Returns:

objective array

engineType

public LPEngine.EngineType engineType()

Description copied from interface: LPEngine

Returns what engineType is actually used by the implementing class. This knowledge can be used for variable mappings etc.

Specified by:

engineType in interface LPEngine

Returns:

the engineType used.

getVariableLowerBound

public double getVariableLowerBound(int variableIndex)

Specified by:

getVariableLowerBound in interface LPEngine

getVariableUpperBound

public double getVariableUpperBound(int variableIndex)

Specified by:

getVariableUpperBound in interface LPEngine

intCheck

protected boolean intCheck(double value)

isFeasible

public boolean isFeasible()

Description copied from interface: LPEngine

Assess whether is at least one solution

Specified by:

isFeasible in interface LPEngine

Returns:

true iff the LP is feasible

mapToIndexValueArrayPair

protected org.processmining.framework.util.Pair<int[],double[]> mapToIndexValueArrayPair(java.util.Map<java.lang.Integer,java.lang.Double> map)

minimalConstraintIndex

public int minimalConstraintIndex()

Description copied from interface: LPEngine

Given a specific engine type (e.g. LPSOLVE, GUROBI, etc.) this utility returns the minimal constraint index. LPSOLVE for example can not have a variable with index 0.

Specified by:

minimalConstraintIndex in interface LPEngine

Returns:

minimal constraint index

minimalVariableIndex

public int minimalVariableIndex()

Description copied from interface: LPEngine

Given a specific engine type (e.g. LPSOLVE, GUROBI, etc.) this utility returns the minimal variable index. LPSOLVE for example can not have a variable with index 0.

Specified by:

minimalVariableIndex in interface LPEngine

Returns:

minimal variable index

numConstraints

public int numConstraints()

Description copied from interface: LPEngine

Query the total number of constraints (== rows in matrix)

Specified by:

numConstraints in interface LPEngine

Returns:

number of constraints

numVariables

public int numVariables()

Description copied from interface: LPEngine

Query the total number of variables (== columns in matrix)

Specified by:

numVariables in interface LPEngine

Returns:

number of variables

pop

public void pop()

Description copied from interface: LPEngine

pop a constraint out of the engine (that is the constraint with the max. constr index)

Specified by:

pop in interface LPEngine

print

public void print()

Description copied from interface: LPEngine

Print the current state of the LP.

Specified by:

print in interface LPEngine

removeConstraint

public boolean removeConstraint(int row)

Description copied from interface: LPEngine

Remove the given constraints. Be careful to update your constraints administration!

Specified by:

removeConstraint in interface LPEngine

Parameters:

row - to be removed

Returns:

success indication

removeVariable

public boolean removeVariable(int column)

Description copied from interface: LPEngine

Remove a variable from the LP. Note that this causes a shift in all variables (columns) with an id > column!

Specified by:

removeVariable in interface LPEngine

Parameters:

column - to remove

Returns:

success indication

setConstraint

public boolean setConstraint(int row,
                             double[] constraint)

Description copied from interface: LPEngine

Set the given row with the provided constraints Note: the size of the array should equal the number of constraints.

Specified by:

setConstraint in interface LPEngine

Parameters:

row - to set

constraint - new row

Returns:

success indication

setConstraint

public boolean setConstraint(int row,
                             double[] constraint,
                             double rhs)

Description copied from interface: LPEngine

Set the given row with the provided constraint and rhs.

Specified by:

setConstraint in interface LPEngine

Parameters:

row - to set

constraint - new constraint

rhs - right hand side

Returns:

setConstraint

public boolean setConstraint(int row,
                             double[] constraint,
                             LPEngine.Operator op,
                             double rhs)

Description copied from interface: LPEngine

Set the given row with the provided constraint, operator and rhs

Specified by:

setConstraint in interface LPEngine

Parameters:

row - to set

constraint - new constraint

op - operator

rhs - right hand side

Returns:

setConstraint

public boolean setConstraint(int row,
                             java.util.Map<java.lang.Integer,java.lang.Double> constraint)

Description copied from interface: LPEngine

Renew the given row with the provided constraints. Note: the size of the map should equal the number of constraints.

Specified by:

setConstraint in interface LPEngine

Parameters:

row - number of constraints to renew

constraint - to update

Returns:

success indication

setConstraintOperator

public boolean setConstraintOperator(int row,
                                     LPEngine.Operator op)

Description copied from interface: LPEngine

Set the given constraint's operator (e.g. > < ==)

Specified by:

setConstraintOperator in interface LPEngine

Parameters:

row - to set

op - operator

Returns:

success indication

setEngine

public void setEngine(lpsolve.LpSolve engine)

setLowerBound

public boolean setLowerBound(int column,
                             double lowerBound)

Description copied from interface: LPEngine

Set a variable's lower-bound.

Specified by:

setLowerBound in interface LPEngine

Parameters:

column - identifier of variable

lowerBound - to assing to variable

Returns:

engineType manipulation succeeded

setMat

public void setMat(int rowIndex,
                   int columnIndex,
                   double value)

Description copied from interface: LPEngine

Set a cell within the engine.

Specified by:

setMat in interface LPEngine

setObjective

public boolean setObjective(double[] objective,
                            LPEngine.ObjectiveTargetType target)

Description copied from interface: LPEngine

Set the objectives value of the P

Specified by:

setObjective in interface LPEngine

Parameters:

objective - of the LP

target - type of objectives

Returns:

success indication

setObjective

public boolean setObjective(java.util.Map<java.lang.Integer,java.lang.Double> objective,
                            LPEngine.ObjectiveTargetType target)

Description copied from interface: LPEngine

Set the objectives value of the LP

Specified by:

setObjective in interface LPEngine

Parameters:

objective - Objective of the ILP in terms of column id's

target - type of objectives

Returns:

success indication

setObjectiveType

public boolean setObjectiveType(LPEngine.ObjectiveTargetType target)

Description copied from interface: LPEngine

Set the type of the objectives, either minimize or maximize.

Specified by:

setObjectiveType in interface LPEngine

Parameters:

target - of objectives

Returns:

success indication

setRightHandSide

public boolean setRightHandSide(int row,
                                double rhs)

Specified by:

setRightHandSide in interface LPEngine

setTimeOut

public void setTimeOut(long seconds)

Specified by:

setTimeOut in interface LPEngine

setType

public boolean setType(int column,
                       LPEngine.VariableType type)

Description copied from interface: LPEngine

Set a variable's type to be of type int.

Specified by:

setType in interface LPEngine

Parameters:

column - index of variable

Returns:

operation success indicaton

setup

public void setup()

setUpperBound

public boolean setUpperBound(int variable,
                             double upperBound)

Description copied from interface: LPEngine

Set a variable upperbound.

Specified by:

setUpperBound in interface LPEngine

Parameters:

variable - identifier of variable

upperBound - to assing to variable

Returns:

engineType manipulation succeeded

solve

public java.util.Map<java.lang.Integer,java.lang.Double> solve()

Description copied from interface: LPEngine

Solve the LP and return the best variable assignment

Specified by:

solve in interface LPEngine

Returns:

A non-empty map with variable-assignment pairs. An empty map if no solution is found

solveAndResetAndValueNative

public org.processmining.framework.util.Pair<double[],java.lang.Double> solveAndResetAndValueNative()

Specified by:

solveAndResetAndValueNative in interface LPEngine

solveAndValue

public org.processmining.framework.util.Pair<java.util.Map<java.lang.Integer,java.lang.Double>,java.lang.Double> solveAndValue()

Description copied from interface: LPEngine

Solve the LP and return the best variable assignment and the assignment value.

Specified by:

solveAndValue in interface LPEngine

Returns:

a non-empty map with assignment and associated value. Empty map and -1 if no solution.

solveAndValueNative

public org.processmining.framework.util.Pair<double[],java.lang.Double> solveAndValueNative()

Description copied from interface: LPEngine

Solve the LP and return the best variable assignment and the assignment value.

Specified by:

solveAndValueNative in interface LPEngine

Returns:

a non-empty map with assignment and associated value. Empty map and -1 if no solution.

solveNative

public double[] solveNative()

Description copied from interface: LPEngine

Solve the LP and return the best variable assignment

Specified by:

solveNative in interface LPEngine

Returns:

solveValueNativeSolveTimeNano

public org.processmining.framework.util.Pair<org.processmining.framework.util.Pair<double[],java.lang.Double>,java.lang.Long> solveValueNativeSolveTimeNano()

Specified by:

solveValueNativeSolveTimeNano in interface LPEngine

valueMatchesType

protected boolean valueMatchesType(double d,
                                   LPEngine.VariableType type)

variableMapToArray

protected double[] variableMapToArray(java.util.Map<java.lang.Integer,java.lang.Double> variableMap)

translates a variable map (i.e. variableIndex-value map) to a LpSolve compliant array of doubles.

Parameters:

variableMap -

Returns:

variableMatchesType

protected boolean variableMatchesType(double[] values,
                                      LPEngine.VariableType type)

variableMatchesType

protected boolean variableMatchesType(java.util.Map<java.lang.Integer,java.lang.Double> nonZeroValues,
                                      LPEngine.VariableType type)

writeToFile

public void writeToFile(java.lang.String dest)

Specified by:

writeToFile in interface LPEngine