org.jorlib.frameworks.columnGeneration.master.cutGeneration

Class CutHandler<T extends ModelInterface,W extends MasterData>

java.lang.Object

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

public class CutHandler<T extends ModelInterface,W extends MasterData>
extends Object

The CutHandler is a manager class which maintains various AbstractCutGenerator(s) to generate inequalities of different types.

Version:

13-4-2015

Author:

Joris Kinable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CutHandler.CHNotifier Inner Class which notifies CHListeners

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config Configuration file for this class
protected Set<AbstractCutGenerator<T,W>>	cutGenerators Set of CutGenerators
protected org.slf4j.Logger	logger Logger for this class

Constructor Summary

Constructors

Constructor and Description
CutHandler() Creates a new CutHandler

Method Summary

Modifier and Type	Method and Description
void	addCHEventListener(CHListener listener) Adds a CHlistener
void	addCutGenerator(AbstractCutGenerator<T,W> cutGenerator) Add a new cutGenerator
void	addCuts(Collection<AbstractInequality> cuts) Add a set of inequalities from an external source.
void	close() Close the Cut Generators
boolean	generateInequalities() Generates inequalities for the master problem of the column generation model, by invoking the generateInequalities method for each of the registered cut generators.
List<AbstractInequality>	getCuts() Gets a list of all inequalities generated by the Cut Generators
void	removeCHEventListener(CHListener listener) Removes a CHlistener
void	removeCutGenerator(AbstractCutGenerator<T,W> cutGenerator) Remove a cutGenerator
void	setMasterData(W masterData) Supply the data object containing the data from the master problem which is required by the cutGenerators to separate valid inequalities.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class

config

protected final Configuration config

Configuration file for this class

cutGenerators

protected Set<AbstractCutGenerator<T extends ModelInterface,W extends MasterData>> cutGenerators

Set of CutGenerators

Constructor Detail

CutHandler

public CutHandler()

Creates a new CutHandler

Method Detail

setMasterData

public void setMasterData(W masterData)

Supply the data object containing the data from the master problem which is required by the cutGenerators to separate valid inequalities.

Parameters:

masterData - Master data object

addCutGenerator

public void addCutGenerator(AbstractCutGenerator<T,W> cutGenerator)

Add a new cutGenerator

Parameters:

cutGenerator - cut generator

removeCutGenerator

public void removeCutGenerator(AbstractCutGenerator<T,W> cutGenerator)

Remove a cutGenerator

Parameters:

cutGenerator - cut generator

generateInequalities

public boolean generateInequalities()

Generates inequalities for the master problem of the column generation model, by invoking the generateInequalities method for each of the registered cut generators. Returns as soon as a single cut has been found!

Returns:

true if inequalities have been found

addCuts

public void addCuts(Collection<AbstractInequality> cuts)

Add a set of inequalities from an external source. Can be used to add a number of initial inequalities which are not separated from the master problem.

Parameters:

cuts - Collection of inequalities

getCuts

public List<AbstractInequality> getCuts()

Gets a list of all inequalities generated by the Cut Generators

Returns:

A list of all inequalities generated by the Cut Generators

close

public void close()

Close the Cut Generators

addCHEventListener

public void addCHEventListener(CHListener listener)

Adds a CHlistener

Parameters:

listener - listener

removeCHEventListener

public void removeCHEventListener(CHListener listener)

Removes a CHlistener

Parameters:

listener - listener