A solution iterator for JaCoPutilSpace that runs a JaCoP search in an extra thread. More...

Inheritance diagram for frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >:

[legend]

Public Member Functions
	JaCoPutilSpaceIter2 (JaCoPutilSpace< V > space, String[] variables, AddableInteger[][] domains)
	Constructor.
String	toString ()
V	getCurrentUtility ()
V	nextUtility ()
void	setCurrentUtility (V valuation)
AddableInteger[]	getCurrentSolution ()
AddableInteger[][]	getDomains ()
String[]	getVariablesOrder ()
AddableInteger[]	nextSolution ()
void	update ()
V	getCurrentUtility (V bound, boolean minimize)
V	nextUtility (V bound, boolean minimize)
Public Member Functions inherited from frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable< U > >.SparseIterator< V, U >
U	nextUtility (U bound, boolean minimize)
	Returns the next solution strictly better than the input bound.
U	getCurrentUtility (U bound, boolean minimize)
Public Member Functions inherited from frodo2.solutionSpaces.BasicUtilitySolutionSpace< V extends Addable< V >, U extends Serializable >.SparseIterator< V, U >
void	setCurrentUtility (U util)
	Sets the utility of the current solution.

Protected Member Functions
void	finalize () throws Throwable

Protected Attributes
JaCoPutilSpace< V >	space
	The JaCoPutilSpace we are iterating over.
V	valuation
	Current valuation.
AddableInteger[]	assignments
	Current variable assignments.
String[]	variables
	The order of iteration over the variables.
int	nbrVars
	The number of variables.
AddableInteger[][]	domains
	The variables' domains.

Private Member Functions
void	getNextFromSearch (final boolean first)
	The transaction between the current thread and the search thread.
void	terminateSearch ()
	As long as the search has not ended its thread is kept alive.
void	initSearch (final V strictBound)
	This method starts the search thread.

Private Attributes
V	strictBound
	Any solution returned by this iterator has to be strictly better than this bound.
final boolean	maximize
	Whether to maximize utility or minimize cost.
StoreCloneable	store
	The JaCoP Store.
JaCoPiterSearch< V >	search
	The JaCoPSearch object that wraps the JaCoP search.
Thread	searchThread
	The thread that carries out the JaCoP search.
boolean	searchTerminated = false
	Whether the search has already finished going through all solutions.
boolean	searchInitiated
	If `true`, the JaCoP search has already been initiated.
final Lock	lock = new ReentrantLock()
	The lock used to ensure that only a single thread is running at a time.
final Condition	nextAsked = lock.newCondition()
	The condition used to signal the search to continue until a next solution is found.
final Condition	nextDelivered = lock.newCondition()
	The condition used to signal this thread that a new solution has been found and has been delivered.
final V	infeasibleValuation
	The infeasible valuation.

Detailed Description

A solution iterator for JaCoPutilSpace that runs a JaCoP search in an extra thread.

This iterator uses less space as all the solutions are not temporarily stored but are computed one by one by pausing the JaCoP search. Additionally, the variables whose projection has been requested are projected in an optimization search that is performed on top of the first search in the same way as a master/slave search combination.

Author: Arnaud Jutzeler, Thomas Leaute

Parameters

<V>	the type used for valuations

Constructor & Destructor Documentation

◆ JaCoPutilSpaceIter2()

frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.JaCoPutilSpaceIter2	(	JaCoPutilSpace< V >	space,
		String[]	variables,
		AddableInteger	domains[][] )

Constructor.

Parameters

space	the space over which to iterate
variables	the variable order for the iteration
domains	the domains of the variables

References domains, space, and variables.

Member Function Documentation

◆ finalize()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.finalize ( ) throws Throwable

protected

See also: java.lang.Object#finalize()

References finalize(), and terminateSearch().

Referenced by finalize().

Here is the call graph for this function:

◆ getCurrentSolution()

AddableInteger[] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getCurrentSolution ( )

See also: SparseIterator.getCurrentSolution()

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

◆ getCurrentUtility() [1/2]

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getCurrentUtility ( )

See also: SparseIterator.getCurrentUtility()

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

◆ getCurrentUtility() [2/2]

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getCurrentUtility	(	V	bound,
		boolean	minimize )

See also: SparseIterator.getCurrentUtility(java.lang.Object, boolean)

Todo: Auto-generated method stub

◆ getDomains()

AddableInteger[][] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getDomains ( )

See also: SparseIterator.getDomains()

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

◆ getNextFromSearch()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getNextFromSearch ( final boolean first )

private

The transaction between the current thread and the search thread.

The control is given to the search thread that will search for the next solution. When the next solution is found, the search records it in its fields and gives back the control to the current thread. Finally, we get the next solution and its valuation using the corresponding getter of the search.

Parameters

first whether the search thread must be created and started

Bug: handle spurious wake-ups

References assignments, frodo2.solutionSpaces.JaCoP.JaCoPutilSpace< V extends Addable< V > >.defaultValuation, lock, nextAsked, nextDelivered, search, searchInitiated, and terminateSearch().

Referenced by initSearch(), nextSolution(), nextUtility(), and nextUtility().

Here is the call graph for this function:

◆ getVariablesOrder()

String[] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.getVariablesOrder ( )

See also: SparseIterator.getVariablesOrder()

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

◆ initSearch()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.initSearch ( final V strictBound )

private

This method starts the search thread.

Parameters

strictBound the initial strict valuation bound, null if we do not want to set one

Bug: Potential name clash with a user-specified variable name

Bug: Potential name clash with a user-specified variable name

References getNextFromSearch(), frodo2.solutionSpaces.JaCoP.JaCoPutilSpace< V extends Addable< V > >.imposeConstraints(), frodo2.solutionSpaces.JaCoP.JaCoPutilSpace< V extends Addable< V > >.initStore(), frodo2.solutionSpaces.JaCoP.JaCoPutilSpace< V extends Addable< V > >.isConsistent, lock, nbrVars, nextAsked, nextDelivered, space, store, strictBound, and terminateSearch().

Referenced by nextSolution(), nextUtility(), and nextUtility().

Here is the call graph for this function:

◆ nextSolution()

AddableInteger[] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nextSolution ( )

See also: SparseIterator.nextSolution()

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

References getNextFromSearch(), and initSearch().

Here is the call graph for this function:

◆ nextUtility() [1/2]

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nextUtility ( )

See also: SparseIterator.nextUtility()

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

References getNextFromSearch(), and initSearch().

Here is the call graph for this function:

◆ nextUtility() [2/2]

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nextUtility	(	V	bound,
		boolean	minimize )

See also: SparseIterator.nextUtility(java.lang.Object, boolean)

References frodo2.solutionSpaces.JaCoP.JaCoPutilSpace< V extends Addable< V > >.defaultValuation, getNextFromSearch(), initSearch(), maximize, frodo2.solutionSpaces.JaCoP.JaCoPiterSearch< V extends Addable< V > >.setNewBound(), and strictBound.

Here is the call graph for this function:

◆ setCurrentUtility()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.setCurrentUtility ( V valuation )

See also: SparseIterator.setCurrentUtility(java.lang.Object)

Todo: Auto-generated method stub

References valuation.

◆ terminateSearch()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.terminateSearch ( )

private

As long as the search has not ended its thread is kept alive.

We might want to kill this thread if we do not need any longer the iterator. This method can be used for that purpose.

References searchThread.

Referenced by finalize(), getNextFromSearch(), and initSearch().

◆ toString()

String frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.toString ( )

See also: java.lang.Object#toString()

◆ update()

void frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.update ( )

See also: SparseIterator.update()

Todo: Auto-generated method stub

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

Member Data Documentation

◆ assignments

AddableInteger [] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.assignments

protected

Current variable assignments.

Referenced by getNextFromSearch().

◆ domains

AddableInteger [][] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.domains

protected

The variables' domains.

Referenced by JaCoPutilSpaceIter2().

◆ infeasibleValuation

final V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.infeasibleValuation

private

The infeasible valuation.

Todo: One condition should actually be enough.

◆ lock

final Lock frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.lock = new ReentrantLock()

private

The lock used to ensure that only a single thread is running at a time.

Referenced by getNextFromSearch(), and initSearch().

◆ maximize

final boolean frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.maximize

private

Whether to maximize utility or minimize cost.

Referenced by nextUtility().

◆ nbrVars

int frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nbrVars

protected

The number of variables.

Referenced by initSearch().

◆ nextAsked

final Condition frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nextAsked = lock.newCondition()

private

The condition used to signal the search to continue until a next solution is found.

Referenced by getNextFromSearch(), and initSearch().

◆ nextDelivered

final Condition frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.nextDelivered = lock.newCondition()

private

The condition used to signal this thread that a new solution has been found and has been delivered.

Referenced by getNextFromSearch(), and initSearch().

◆ search

JaCoPiterSearch<V> frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.search

private

The JaCoPSearch object that wraps the JaCoP search.

Referenced by getNextFromSearch().

◆ searchInitiated

boolean frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.searchInitiated

private

If true, the JaCoP search has already been initiated.

Referenced by getNextFromSearch().

◆ searchTerminated

boolean frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.searchTerminated = false

private

Whether the search has already finished going through all solutions.

◆ searchThread

Thread frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.searchThread

private

The thread that carries out the JaCoP search.

Referenced by terminateSearch().

◆ space

JaCoPutilSpace<V> frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.space

protected

The JaCoPutilSpace we are iterating over.

Referenced by initSearch(), and JaCoPutilSpaceIter2().

◆ store

StoreCloneable frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.store

private

The JaCoP Store.

Referenced by initSearch().

◆ strictBound

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.strictBound

private

Any solution returned by this iterator has to be strictly better than this bound.

Referenced by initSearch(), and nextUtility().

◆ valuation

V frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.valuation

protected

Current valuation.

Referenced by setCurrentUtility().

◆ variables

String [] frodo2.solutionSpaces.JaCoP.JaCoPutilSpaceIter2< V extends Addable< V > >.variables

protected

The order of iteration over the variables.

Referenced by JaCoPutilSpaceIter2().

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

src/frodo2/solutionSpaces/JaCoP/JaCoPutilSpaceIter2.java

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JaCoPutilSpaceIter2()

Member Function Documentation

◆ finalize()

◆ getCurrentSolution()

◆ getCurrentUtility() [1/2]

◆ getCurrentUtility() [2/2]

◆ getDomains()

◆ getNextFromSearch()

◆ getVariablesOrder()

◆ initSearch()

◆ nextSolution()

◆ nextUtility() [1/2]

◆ nextUtility() [2/2]

◆ setCurrentUtility()

◆ terminateSearch()

◆ toString()

◆ update()

Member Data Documentation

◆ assignments

◆ domains

◆ infeasibleValuation

◆ lock

◆ maximize

◆ nbrVars

◆ nextAsked

◆ nextDelivered

◆ search

◆ searchInitiated

◆ searchTerminated

◆ searchThread

◆ space

◆ store

◆ strictBound

◆ valuation

◆ variables