Best first iterator for the combination of a VehicleRoutingSpace with a collection of sum constraints. More...

Inheritance diagram for frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator:

[legend]

Public Member Functions
	BestFirstIterator (VehicleRoutingSpace< U > vrpSpace, List< UtilitySolutionSpace< AddableInteger, U > > spaces, String[] variablesOrder, String ownVariable)
	Constructor.
U	getCurrentUtility ()
U	getCurrentUtility (U bound, final boolean minimize)
U	nextUtility ()
U	nextUtility (U bound, final boolean minimize)
void	setCurrentUtility (U util)
AddableInteger[]	getCurrentSolution ()
AddableInteger[][]	getDomains ()
long	getNbrSolutions ()
String[]	getVariablesOrder ()
boolean	hasNext ()
AddableInteger[]	nextSolution ()
void	update ()
U	maximalCut ()

Protected Member Functions
void	combineVRPAndSum ()
	Method to combine the nandAssignment and the packetAssignment in the currentAssignment variable.

Protected Attributes
HashMap< String, Integer >	variablePointer
	For each variable its position in the assignment array.

Private Member Functions
void	iter ()
	Method used to iterate over the assignments in a best first order.
void	iterateSumVars ()
	Iterate of the possible combinations of NAND variables.

Private Attributes
AddableInteger[]	currentSolution
	The current solution.
U	currentUtility
	The utility of the current solution.
String[]	vehicleRoutingVariables
	The variables occuring in the VRP problem.
String[]	sumVariables
	The variables occuring in the sum constraints.
boolean	hasVehicleRoutingProblem
	`true` when this space contains a VRP space, and `false` otherwise
boolean	hasSumVariables
	`true` when this space contrains sum variables, and `false` otherwise
Iterator< AddableInteger, U >	vehicleIterBestFirst
	An iterator over the VRP space.
int	nbrSolsLeft
	The number of solutions left.
int	nbrSumSolsLeft
	The number of possible assignments for the sum variables left.
int	nbrSumSols
	the total number of possible assignments to the sum variables
int	nbrSumVariables
	The total number of sum variables.
int	nbrVRPvariables
	The total number of VRP variables.
AddableInteger	one = new AddableInteger(1)
	Domain value 1.
AddableInteger	zero = new AddableInteger(0)
	Domain value 0.
AddableInteger[]	sumAssignment
	The current assignment to the sum variables.
AddableInteger[]	vrpAssignment
	The current assignment to the VRP variables.
int	ownVariableAssignmentVRPIndex
	The index of the own variable in the list of variables for the VRP problem.
U	zeroUtil
	The zero utility.

Detailed Description

Best first iterator for the combination of a VehicleRoutingSpace with a collection of sum constraints.

Author: Brammert Ottens, 28 apr 2010

Constructor & Destructor Documentation

◆ BestFirstIterator()

frodo2.solutionSpaces.vehiclerouting.CompoundSpace< U extends Addable< U > >.BestFirstIterator.BestFirstIterator	(	VehicleRoutingSpace< U >	vrpSpace,
		List< UtilitySolutionSpace< AddableInteger, U > >	spaces,
		String[]	variablesOrder,
		String	ownVariable )

Constructor.

Parameters

vrpSpace	the vehicle routing space
spaces	the sum constraint spaces
variablesOrder	the order in which the variables should be reported to the outside world
ownVariable	The ID of the variable that owns this constraint

References currentSolution, hasSumVariables, hasVehicleRoutingProblem, nbrSolsLeft, nbrSumSolsLeft, nbrSumVariables, nbrVRPvariables, one, frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.ownVariable, ownVariableAssignmentVRPIndex, sumAssignment, sumVariables, variablePointer, frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.variables, vehicleIterBestFirst, vehicleRoutingVariables, vrpAssignment, frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.vrpSpace, and zeroUtil.

Member Function Documentation

◆ combineVRPAndSum()

void frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.combineVRPAndSum ( )

protected

Method to combine the nandAssignment and the packetAssignment in the currentAssignment variable.

Author: Brammert Ottens, 25 nov 2009

References currentSolution, sumAssignment, sumVariables, variablePointer, vehicleRoutingVariables, and vrpAssignment.

Referenced by iter().

◆ getCurrentSolution()

AddableInteger[] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.getCurrentSolution ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.getCurrentSolution()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.SparseIterator< V >.

References currentSolution.

◆ getCurrentUtility() [1/2]

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.getCurrentUtility ( )

See also: frodo2.solutionSpaces.BasicUtilitySolutionSpace.Iterator.getCurrentUtility()

Implements frodo2.solutionSpaces.BasicUtilitySolutionSpace< V extends Addable< V >, U extends Serializable >.SparseIterator< V, U >.

References currentUtility.

Referenced by getCurrentUtility(), and nextUtility().

◆ getCurrentUtility() [2/2]

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace< U extends Addable< U > >.BestFirstIterator.getCurrentUtility	(	U	bound,
		final boolean	minimize )

See also: frodo2.solutionSpaces.UtilitySolutionSpace.Iterator.getCurrentUtility(java.lang.Object, boolean)

Implements frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.SparseIterator< V, U >.

References getCurrentUtility().

Here is the call graph for this function:

◆ getDomains()

AddableInteger[][] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.getDomains ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.getDomains()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.SparseIterator< V >.

◆ getNbrSolutions()

long frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.getNbrSolutions ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.getNbrSolutions()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.Iterator< V >.

◆ getVariablesOrder()

String[] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.getVariablesOrder ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.getVariablesOrder()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.SparseIterator< V >.

◆ hasNext()

boolean frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.hasNext ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.hasNext()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.Iterator< V >.

Referenced by nextUtility().

◆ iter()

void frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.iter ( )

private

Method used to iterate over the assignments in a best first order.

Author: Brammert Ottens, 28 apr 2010

References combineVRPAndSum(), currentUtility, hasSumVariables, hasVehicleRoutingProblem, iterateSumVars(), nbrSolsLeft, nbrSumSols, nbrSumSolsLeft, one, ownVariableAssignmentVRPIndex, sumAssignment, vehicleIterBestFirst, vrpAssignment, and zero.

Referenced by nextSolution(), and nextUtility().

Here is the call graph for this function:

◆ iterateSumVars()

void frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.iterateSumVars ( )

private

Iterate of the possible combinations of NAND variables.

References nbrSumSolsLeft, nbrSumVariables, one, sumAssignment, and zero.

Referenced by iter().

◆ maximalCut()

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.maximalCut ( )

See also: frodo2.solutionSpaces.UtilitySolutionSpace.IteratorBestFirst.maximalCut()

Implements frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.IteratorBestFirst< V, U >.

References zeroUtil.

◆ nextSolution()

AddableInteger[] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nextSolution ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.nextSolution()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.SparseIterator< V >.

References currentSolution, and iter().

Here is the call graph for this function:

◆ nextUtility() [1/2]

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nextUtility ( )

See also: frodo2.solutionSpaces.BasicUtilitySolutionSpace.Iterator.nextUtility()

Implements frodo2.solutionSpaces.BasicUtilitySolutionSpace< V extends Addable< V >, U extends Serializable >.SparseIterator< V, U >.

References currentUtility, and iter().

Referenced by nextUtility().

Here is the call graph for this function:

◆ nextUtility() [2/2]

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace< U extends Addable< U > >.BestFirstIterator.nextUtility	(	U	bound,
		final boolean	minimize )

See also: frodo2.solutionSpaces.UtilitySolutionSpace.Iterator.nextUtility(java.lang.Object, boolean)

Implements frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.SparseIterator< V, U >.

References getCurrentUtility(), hasNext(), and nextUtility().

Here is the call graph for this function:

◆ setCurrentUtility()

void frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.setCurrentUtility ( U util )

See also: frodo2.solutionSpaces.BasicUtilitySolutionSpace.Iterator.setCurrentUtility(java.lang.Object)

Implements frodo2.solutionSpaces.BasicUtilitySolutionSpace< V extends Addable< V >, U extends Serializable >.SparseIterator< V, U >.

◆ update()

void frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.update ( )

See also: frodo2.solutionSpaces.SolutionSpace.Iterator.update()

Implements frodo2.solutionSpaces.SolutionSpace< V extends Addable< V > >.SparseIterator< V >.

Member Data Documentation

◆ currentSolution

AddableInteger [] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.currentSolution

private

The current solution.

Referenced by BestFirstIterator(), combineVRPAndSum(), getCurrentSolution(), and nextSolution().

◆ currentUtility

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.currentUtility

private

The utility of the current solution.

Referenced by getCurrentUtility(), iter(), and nextUtility().

◆ hasSumVariables

boolean frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.hasSumVariables

private

true when this space contrains sum variables, and false otherwise

Referenced by BestFirstIterator(), and iter().

◆ hasVehicleRoutingProblem

boolean frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.hasVehicleRoutingProblem

private

true when this space contains a VRP space, and false otherwise

Referenced by BestFirstIterator(), and iter().

◆ nbrSolsLeft

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nbrSolsLeft

private

The number of solutions left.

Referenced by BestFirstIterator(), and iter().

◆ nbrSumSols

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nbrSumSols

private

the total number of possible assignments to the sum variables

Referenced by iter().

◆ nbrSumSolsLeft

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nbrSumSolsLeft

private

The number of possible assignments for the sum variables left.

Referenced by BestFirstIterator(), iter(), and iterateSumVars().

◆ nbrSumVariables

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nbrSumVariables

private

The total number of sum variables.

Referenced by BestFirstIterator(), and iterateSumVars().

◆ nbrVRPvariables

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.nbrVRPvariables

private

The total number of VRP variables.

Referenced by BestFirstIterator().

◆ one

AddableInteger frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.one = new AddableInteger(1)

private

Domain value 1.

Referenced by BestFirstIterator(), iter(), and iterateSumVars().

◆ ownVariableAssignmentVRPIndex

int frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.ownVariableAssignmentVRPIndex

private

The index of the own variable in the list of variables for the VRP problem.

Referenced by BestFirstIterator(), and iter().

◆ sumAssignment

AddableInteger [] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.sumAssignment

private

The current assignment to the sum variables.

Referenced by BestFirstIterator(), combineVRPAndSum(), iter(), and iterateSumVars().

◆ sumVariables

String [] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.sumVariables

private

The variables occuring in the sum constraints.

Referenced by BestFirstIterator(), and combineVRPAndSum().

◆ variablePointer

HashMap<String, Integer> frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.variablePointer

protected

For each variable its position in the assignment array.

Referenced by BestFirstIterator(), and combineVRPAndSum().

◆ vehicleIterBestFirst

Iterator<AddableInteger, U> frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.vehicleIterBestFirst

private

An iterator over the VRP space.

Referenced by BestFirstIterator(), and iter().

◆ vehicleRoutingVariables

String [] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.vehicleRoutingVariables

private

The variables occuring in the VRP problem.

Referenced by BestFirstIterator(), and combineVRPAndSum().

◆ vrpAssignment

AddableInteger [] frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.vrpAssignment

private

The current assignment to the VRP variables.

Referenced by BestFirstIterator(), combineVRPAndSum(), and iter().

◆ zero

AddableInteger frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.zero = new AddableInteger(0)

private

Domain value 0.

Referenced by iter(), and iterateSumVars().

◆ zeroUtil

U frodo2.solutionSpaces.vehiclerouting.CompoundSpace >.BestFirstIterator.zeroUtil

private

The zero utility.

Referenced by BestFirstIterator(), and maximalCut().

The documentation for this class was generated from the following file:

src/frodo2/solutionSpaces/vehiclerouting/CompoundSpace.java

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BestFirstIterator()

Member Function Documentation

◆ combineVRPAndSum()

◆ getCurrentSolution()

◆ getCurrentUtility() [1/2]

◆ getCurrentUtility() [2/2]

◆ getDomains()

◆ getNbrSolutions()

◆ getVariablesOrder()

◆ hasNext()

◆ iter()

◆ iterateSumVars()

◆ maximalCut()

◆ nextSolution()

◆ nextUtility() [1/2]

◆ nextUtility() [2/2]

◆ setCurrentUtility()

◆ update()

Member Data Documentation

◆ currentSolution

◆ currentUtility

◆ hasSumVariables

◆ hasVehicleRoutingProblem

◆ nbrSolsLeft

◆ nbrSumSols

◆ nbrSumSolsLeft

◆ nbrSumVariables

◆ nbrVRPvariables

◆ one

◆ ownVariableAssignmentVRPIndex

◆ sumAssignment

◆ sumVariables

◆ variablePointer

◆ vehicleIterBestFirst

◆ vehicleRoutingVariables

◆ vrpAssignment

◆ zero

◆ zeroUtil