org.jorlib.frameworks.columnGeneration.master.cutGeneration

Class AbstractCutGenerator<T extends ModelInterface,W extends MasterData>

java.lang.Object

org.jorlib.frameworks.columnGeneration.master.cutGeneration.AbstractCutGenerator<T,W>

Type Parameters:

T - Type of data model

W - Type of MasterData

public abstract class AbstractCutGenerator<T extends ModelInterface,W extends MasterData>
extends Object

This class is used to separate valid inequalities. It can access data from the the master problem through a MasterData object. Each time inequalities have to be separated, the generateInqualities method is invoked. Given the data from the master, the AbstractCutGenerator can then check whether there are any violated inequalities. Typically, one wants to store any inequalities generated for a particular master problem in the corresponding MasterData object such that the master problem has access to the inequalities.

Version:

13-4-2015

Author:

Joris Kinable

Field Summary

Fields

Modifier and Type	Field and Description
protected T	dataModel Data model
protected org.slf4j.Logger	logger Logger for this class
protected W	masterData Data object coming from the master
protected String	name Name of the generator

Constructor Summary

Constructors

Constructor and Description
AbstractCutGenerator(T dataModel, String name) Creates a new AbstractCutGenerator

Method Summary

Modifier and Type	Method and Description
abstract void	addCut(AbstractInequality cut) Add an inequality of the type generated by this AbstractCutGenerator to the model.
abstract void	close() Close the generator
abstract List<AbstractInequality>	generateInqualities() Separate valid inequalities
abstract List<AbstractInequality>	getCuts() Returns all inequalities maintained by this generator
void	setMasterData(W masterData) Set the data object containing data from the master problem
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class

dataModel

protected final T extends ModelInterface dataModel

Data model

masterData

protected W extends MasterData masterData

Data object coming from the master

name

protected final String name

Name of the generator

Constructor Detail

AbstractCutGenerator

public AbstractCutGenerator(T dataModel,
                            String name)

Creates a new AbstractCutGenerator

Parameters:

dataModel - data model instance

name - name of the CutGenerator

Method Detail

generateInqualities

public abstract List<AbstractInequality> generateInqualities()

Separate valid inequalities

Returns:

returns a list of violated inequality which have been found

addCut

public abstract void addCut(AbstractInequality cut)

Add an inequality of the type generated by this AbstractCutGenerator to the model. The inequality may have been generated elsewhere, e.g. by a different node, or the user may provide an initial set of inequalities.

Parameters:

cut - cut to be added

getCuts

public abstract List<AbstractInequality> getCuts()

Returns all inequalities maintained by this generator

Returns:

list of inequalities maintained by the generator

setMasterData

public void setMasterData(W masterData)

Set the data object containing data from the master problem

Parameters:

masterData - masterData

close

public abstract void close()

Close the generator

toString

public String toString()

Overrides:

toString in class Object