/*
* Copyright 2011 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.drools.planner.core.constructionheuristic;
import java.util.Iterator;
import java.util.List;
import org.drools.planner.core.constructionheuristic.placer.entity.EntityPlacer;
import org.drools.planner.core.constructionheuristic.scope.ConstructionHeuristicSolverPhaseScope;
import org.drools.planner.core.constructionheuristic.scope.ConstructionHeuristicStepScope;
import org.drools.planner.core.move.Move;
import org.drools.planner.core.phase.AbstractSolverPhase;
import org.drools.planner.core.solver.scope.DefaultSolverScope;
/**
* Default implementation of {@link ConstructionHeuristicSolverPhase}.
*/
public class DefaultConstructionHeuristicSolverPhase extends AbstractSolverPhase implements ConstructionHeuristicSolverPhase {
protected List<EntityPlacer> entityPlacerList;
protected boolean assertStepScoreIsUncorrupted = false;
public void setEntityPlacerList(List<EntityPlacer> entityPlacerList) {
this.entityPlacerList = entityPlacerList;
}
public void setAssertStepScoreIsUncorrupted(boolean assertStepScoreIsUncorrupted) {
this.assertStepScoreIsUncorrupted = assertStepScoreIsUncorrupted;
}
// ************************************************************************
// Worker methods
// ************************************************************************
public void solve(DefaultSolverScope solverScope) {
ConstructionHeuristicSolverPhaseScope phaseScope = new ConstructionHeuristicSolverPhaseScope(solverScope);
phaseStarted(phaseScope);
// TODO FIXME
if (entityPlacerList.size() != 1) {
throw new UnsupportedOperationException();
}
EntityPlacer hackEntityPlacer = entityPlacerList.get(0);
ConstructionHeuristicStepScope stepScope = createNextStepScope(phaseScope, null);
while (!termination.isPhaseTerminated(phaseScope) && hackEntityPlacer.hasPlacement()) {
stepStarted(stepScope);
hackEntityPlacer.doPlacement(stepScope);
Move nextStep = stepScope.getStep();
if (nextStep == null) {
logger.warn(" Cancelled step index ({}), time spend ({}): there is no doable move. Terminating phase early.",
stepScope.getStepIndex(),
phaseScope.calculateSolverTimeMillisSpend());
break;
}
nextStep.doMove(stepScope.getScoreDirector());
// there is no need to recalculate the score, but we still need to set it
phaseScope.getWorkingSolution().setScore(stepScope.getScore());
if (assertStepScoreIsUncorrupted) {
phaseScope.assertWorkingScore(stepScope.getScore());
}
if (!hackEntityPlacer.hasPlacement()) {
stepScope.setSolutionInitialized(true);
}
stepEnded(stepScope);
stepScope = createNextStepScope(phaseScope, stepScope);
}
phaseEnded(phaseScope);
}
private ConstructionHeuristicStepScope createNextStepScope(ConstructionHeuristicSolverPhaseScope phaseScope,
ConstructionHeuristicStepScope completedStepScope) {
if (completedStepScope == null) {
completedStepScope = new ConstructionHeuristicStepScope(phaseScope);
completedStepScope.setScore(phaseScope.getStartingScore());
completedStepScope.setStepIndex(-1);
}
phaseScope.setLastCompletedStepScope(completedStepScope);
ConstructionHeuristicStepScope stepScope = new ConstructionHeuristicStepScope(phaseScope);
stepScope.setStepIndex(completedStepScope.getStepIndex() + 1);
stepScope.setSolutionInitialized(false);
return stepScope;
}
@Override
public void solvingStarted(DefaultSolverScope solverScope) {
super.solvingStarted(solverScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.solvingStarted(solverScope);
}
}
public void phaseStarted(ConstructionHeuristicSolverPhaseScope phaseScope) {
super.phaseStarted(phaseScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.phaseStarted(phaseScope);
}
}
public void stepStarted(ConstructionHeuristicStepScope stepScope) {
super.stepStarted(stepScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.stepStarted(stepScope);
}
}
public void stepEnded(ConstructionHeuristicStepScope stepScope) {
super.stepEnded(stepScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.stepEnded(stepScope);
}
if (logger.isDebugEnabled()) {
long timeMillisSpend = stepScope.getPhaseScope().calculateSolverTimeMillisSpend();
logger.debug(" Step index ({}), time spend ({}), score ({}) for constructing step ({}).",
new Object[]{stepScope.getStepIndex(), timeMillisSpend,
stepScope.getScore(), stepScope.getStep()});
}
}
public void phaseEnded(ConstructionHeuristicSolverPhaseScope phaseScope) {
super.phaseEnded(phaseScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.phaseEnded(phaseScope);
}
logger.info("Phase constructionHeuristic ended: step total ({}), time spend ({}), best score ({}).",
new Object[]{phaseScope.getLastCompletedStepScope().getStepIndex() + 1,
phaseScope.calculateSolverTimeMillisSpend(),
phaseScope.getBestScore()});
}
@Override
public void solvingEnded(DefaultSolverScope solverScope) {
super.solvingStarted(solverScope);
for (EntityPlacer entityPlacer : entityPlacerList) {
entityPlacer.solvingEnded(solverScope);
}
}
}