content: /*
   * Copyright (c) 2017-2020 Siemens AG
   * All rights reserved.
   * 
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions are met:
   * 
   * 1) Redistributions of source code must retain the above copyright notice, this
   *    list of conditions and the following disclaimer.
   * 
   * 2) Redistributions in binary form must reproduce the above copyright notice,
   *    this list of conditions and the following disclaimer in the documentation
   *    and/or other materials provided with the distribution.
   * 
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package at.ac.tuwien.kr.alpha.core.solver.heuristics;
  
  import java.util.List;
  import java.util.Random;
  
  import at.ac.tuwien.kr.alpha.core.grounder.Grounder;
  import at.ac.tuwien.kr.alpha.core.solver.ChoiceManager;
  import at.ac.tuwien.kr.alpha.core.solver.WritableAssignment;
  import at.ac.tuwien.kr.alpha.core.solver.heuristics.activity.BodyActivityProviderFactory.BodyActivityType;
  
  public final class BranchingHeuristicFactory {
  
  	public static BranchingHeuristic getInstance(HeuristicsConfiguration heuristicsConfiguration, Grounder grounder, WritableAssignment assignment, ChoiceManager choiceManager, Random random) {
  		BranchingHeuristic heuristicWithoutReplay = getInstanceWithoutReplay(heuristicsConfiguration, grounder, assignment, choiceManager, random);
  		List<Integer> replayChoices = heuristicsConfiguration.getReplayChoices();
  		if (replayChoices != null && !replayChoices.isEmpty()) {
  			return ChainedBranchingHeuristics.chainOf(
  					new ReplayHeuristic(replayChoices, choiceManager),
  					heuristicWithoutReplay);
  		}
  		return heuristicWithoutReplay;
  	}
  	
  	private static BranchingHeuristic getInstanceWithoutReplay(HeuristicsConfiguration heuristicsConfiguration, Grounder grounder, WritableAssignment assignment, ChoiceManager choiceManager, Random random) {
  		switch (heuristicsConfiguration.getHeuristic()) {
  		case NAIVE:
  			return new NaiveHeuristic(choiceManager);
  		case BERKMIN:
  			return new BerkMin(assignment, choiceManager, random);
  		case BERKMINLITERAL:
  			return new BerkMinLiteral(assignment, choiceManager, random);
  		case DD:
  			return new DependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.DEFAULT);
  		case DD_SUM:
  			return new DependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.SUM);
  		case DD_AVG:
  			return new DependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.AVG);
  		case DD_MAX:
  			return new DependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.MAX);
  		case DD_MIN:
  			return new DependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.MIN);
  		case DD_PYRO:
  			return new DependencyDrivenPyroHeuristic(assignment, choiceManager, random, BodyActivityType.DEFAULT);
  		case GDD:
  			return new GeneralizedDependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.DEFAULT);
  		case GDD_SUM:
  			return new GeneralizedDependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.SUM);
  		case GDD_AVG:
  			return new GeneralizedDependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.AVG);
  		case GDD_MAX:
  			return new GeneralizedDependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.MAX);
  		case GDD_MIN:
  			return new GeneralizedDependencyDrivenHeuristic(assignment, choiceManager, random, BodyActivityType.MIN);
  		case GDD_PYRO:
  			return new GeneralizedDependencyDrivenPyroHeuristic(assignment, choiceManager, random, BodyActivityType.DEFAULT);
  		case ALPHA_ACTIVE_RULE:
  			return new AlphaActiveRuleHeuristic(assignment, choiceManager, random);
  		case ALPHA_HEAD_MBT:
  			return new AlphaHeadMustBeTrueHeuristic(assignment, choiceManager, random);
  		case VSIDS:
  			return new VSIDS(assignment, choiceManager, heuristicsConfiguration.getMomsStrategy());
  		case GDD_VSIDS:
  			return new DependencyDrivenVSIDS(assignment, choiceManager, random, heuristicsConfiguration.getMomsStrategy());
  		}
  		throw new IllegalArgumentException("Unknown branching heuristic requested.");
  	}
  }
  