source: branches/2521_ProblemRefactoring/HeuristicLab.Problems.GeneticProgramming/3.3/robocode/Problem.cs @ 17778

#region License Information
/* HeuristicLab
 * Copyright (C) Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System.Threading;
using HEAL.Attic;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;

namespace HeuristicLab.Problems.GeneticProgramming.Robocode {
  [StorableType("0B4FE44B-3044-4531-8CA9-3C4D3BB3A4BB")]
  [Creatable(CreatableAttribute.Categories.GeneticProgrammingProblems, Priority = 360)]
  [Item("Robocode Problem", "Evolution of a robocode program in java using genetic programming.")]
  public class Problem : SymbolicExpressionTreeProblem {
    
    #region Parameters
    [Storable] public IFixedValueParameter<DirectoryValue> RobocodePathParameter { get; private set; }
    [Storable] public IFixedValueParameter<IntValue> NrOfRoundsParameter { get; private set; }
    [Storable] public IValueParameter<EnemyCollection> EnemiesParameter { get; private set; }

    public string RobocodePath {
      get { return RobocodePathParameter.Value.Value; }
      set { RobocodePathParameter.Value.Value = value; }
    }

    public int NrOfRounds {
      get { return NrOfRoundsParameter.Value.Value; }
      set { NrOfRoundsParameter.Value.Value = value; }
    }

    public EnemyCollection Enemies {
      get { return EnemiesParameter.Value; }
      set { EnemiesParameter.Value = value; }
    }
    #endregion

    [StorableConstructor]
    protected Problem(StorableConstructorFlag _) : base(_) { }
    protected Problem(Problem original, Cloner cloner)
      : base(original, cloner) {
      RobocodePathParameter = cloner.Clone(original.RobocodePathParameter);
      NrOfRoundsParameter = cloner.Clone(original.NrOfRoundsParameter);
      EnemiesParameter = cloner.Clone(original.EnemiesParameter);

      RegisterEventHandlers();
    }

    public Problem() : base(new SymbolicExpressionTreeEncoding(new Grammar(), maximumLength: 1000, maximumDepth: 10)) {
      Maximization = true;
      DirectoryValue robocodeDir = new DirectoryValue { Value = @"robocode" };

      var robotList = EnemyCollection.ReloadEnemies(robocodeDir.Value);
      robotList.RobocodePath = robocodeDir.Value;


      Parameters.Add(RobocodePathParameter = new FixedValueParameter<DirectoryValue>("RobocodePath", "Path of the Robocode installation.", robocodeDir));
      Parameters.Add(NrOfRoundsParameter = new FixedValueParameter<IntValue>("NrOfRounds", "Number of rounds a robot has to fight against each opponent.", new IntValue(3)));
      Parameters.Add(EnemiesParameter = new ValueParameter<EnemyCollection>("Enemies", "The enemies that should be battled.", robotList));

      Encoding.FunctionArguments = 0;
      Encoding.FunctionDefinitions = 0;
      Encoding.GrammarParameter.ReadOnly = GrammarRefParameter.ReadOnly = true;

      RegisterEventHandlers();
    }

    public override IDeepCloneable Clone(Cloner cloner) {
      return new Problem(this, cloner);
    }

    [StorableHook(HookType.AfterDeserialization)]
    private void AfterDeserialization() { RegisterEventHandlers(); }

    public override ISingleObjectiveEvaluationResult Evaluate(ISymbolicExpressionTree tree, IRandom random, CancellationToken cancellationToken) {
      var quality = Interpreter.EvaluateTankProgram(tree, RobocodePath, Enemies, null, false, NrOfRounds);
      return new SingleObjectiveEvaluationResult(quality);
    }

    //TODO: change to new analyze interface//TODO: change to new analyze interface
    //public override void Analyze(ISymbolicExpressionTree[] trees, double[] qualities, ResultCollection results, IRandom random) {
    //  // find the tree with the best quality
    //  double maxQuality = double.NegativeInfinity;
    //  ISymbolicExpressionTree bestTree = null;
    //  for (int i = 0; i < qualities.Length; i++) {
    //    if (qualities[i] > maxQuality) {
    //      maxQuality = qualities[i];
    //      bestTree = trees[i];
    //    }
    //  }

    //  // create a solution instance
    //  var bestSolution = new Solution(bestTree, RobocodePath, NrOfRounds, Enemies);

    //  // also add the best solution as a result to the result collection
    //  // or alternatively update the existing result
    //  if (!results.ContainsKey("BestSolution")) {
    //    results.Add(new Result("BestSolution", "The best tank program", bestSolution));
    //  } else {
    //    results["BestSolution"].Value = bestSolution;
    //  }
    //}

    private void RegisterEventHandlers() {
      RobocodePathParameter.Value.StringValue.ValueChanged += RobocodePathParameter_ValueChanged;
    }

    private void RobocodePathParameter_ValueChanged(object sender, System.EventArgs e) {
      EnemiesParameter.Value.RobocodePath = RobocodePathParameter.Value.Value;
    }
  }
}