source: branches/DataAnalysis.IslandAlgorithms/HeuristicLab.Algorithms.DataAnalysis.Symbolic/3.3/SymbolicDataAnalysisIslandGeneticAlgorithm.cs @ 10177

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2012 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;
using System.Collections.Generic;
using System.Linq;
using HeuristicLab.Algorithms.GeneticAlgorithm;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Problems.DataAnalysis.Symbolic;

namespace HeuristicLab.Algorithms.DataAnalysis.Symbolic {
  [Item("Symbolic Data Analysis Island Genetic Algorithm", "A symbolic data analysis island genetic algorithm.")]
  [Creatable("Data Analysis")]
  [StorableClass]
  public sealed class SymbolicDataAnalysisIslandGeneticAlgorithm : IslandGeneticAlgorithm {
    private const string FixedSamplesParameterName = "NumberOfFixedSamples";
    private const string FixedSamplesPartitionParameterName = "FixedSamplesPartition";
    private const string FixedSamplesPartitionsParameterName = "FixedSamplesPartitions";
    private const string EvaluatorParameterName = "IslandEvaluator";
    private const string IslandIndexParameterName = "IslandIndex";
    private const string ProblemEvaluatorParameterName = "ProblemEvaluator";

    #region Problem Properties
    public override Type ProblemType {
      get { return typeof(ISymbolicDataAnalysisSingleObjectiveProblem); }
    }
    public new ISymbolicDataAnalysisSingleObjectiveProblem Problem {
      get { return (ISymbolicDataAnalysisSingleObjectiveProblem)base.Problem; }
      set { base.Problem = value; }
    }
    #endregion

    #region parameters
    public IFixedValueParameter<IntValue> FixedSamplesParameter {
      get { return (IFixedValueParameter<IntValue>)Parameters[FixedSamplesParameterName]; }
    }
    public IValueParameter<ItemArray<IntRange>> FixedSamplesPartitionsParameter {
      get { return (IValueParameter<ItemArray<IntRange>>)Parameters[FixedSamplesPartitionsParameterName]; }
    }
    public IValueParameter<ISymbolicDataAnalysisIslandGeneticAlgorithmEvaluator> EvaluatorParameter {
      get { return (IValueParameter<ISymbolicDataAnalysisIslandGeneticAlgorithmEvaluator>)Parameters[EvaluatorParameterName]; }
    }
    private ILookupParameter<ISingleObjectiveEvaluator> ProblemEvaluatorParameter {
      get { return (ILookupParameter<ISingleObjectiveEvaluator>)Parameters[ProblemEvaluatorParameterName]; }
    }
    #endregion

    #region properties
    public int FixedSamples {
      get { return FixedSamplesParameter.Value.Value; }
      set { FixedSamplesParameter.Value.Value = value; }
    }
    public ItemArray<IntRange> FixedSamplesPartitions {
      get { return FixedSamplesPartitionsParameter.Value; }
      set { FixedSamplesPartitionsParameter.Value = value; }
    }
    #endregion

    [StorableConstructor]
    private SymbolicDataAnalysisIslandGeneticAlgorithm(bool deserializing) : base(deserializing) { }
    [StorableHook(HookType.AfterDeserialization)]
    private void AfterDeserialization() {
      RegisterParameterEvents();
    }
    private SymbolicDataAnalysisIslandGeneticAlgorithm(SymbolicDataAnalysisIslandGeneticAlgorithm original, Cloner cloner)
      : base(original, cloner) {
      RegisterParameterEvents();
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new SymbolicDataAnalysisIslandGeneticAlgorithm(this, cloner);
    }

    public SymbolicDataAnalysisIslandGeneticAlgorithm()
      : base() {
      Parameters.Add(new FixedValueParameter<IntValue>(FixedSamplesParameterName, "The number of fixed samples used for fitness calculation in each island.", new IntValue(0)));
      Parameters.Add(new ValueParameter<ItemArray<IntRange>>(FixedSamplesPartitionsParameterName, "The fixed samples partitions used for fitness calculation for every island."));
      Parameters.Add(new OptionalValueParameter<ISymbolicDataAnalysisIslandGeneticAlgorithmEvaluator>(EvaluatorParameterName, "The evaluator of the algorithm."));
      Parameters.Add(new LookupParameter<ISingleObjectiveEvaluator>(ProblemEvaluatorParameterName, "Internal parameter for name translation", "Evaluator"));

      ScopeTreeAssigner<IntValue> islandIndexAssigner = new ScopeTreeAssigner<IntValue>();
      islandIndexAssigner.Name = "Insert island index";
      islandIndexAssigner.LeftSideParameter.ActualName = IslandIndexParameterName;
      var readonlyIslandIndexes = Enumerable.Range(0, NumberOfIslands.Value).Select(x => (IntValue)new IntValue(x).AsReadOnly());
      islandIndexAssigner.RightSideParameter.Value = new ItemArray<IntValue>(readonlyIslandIndexes);

      ScopeTreeAssigner<IntRange> fixedSamplesPartitionCreator = new ScopeTreeAssigner<IntRange>();
      fixedSamplesPartitionCreator.Name = "Create fixed evaluation partition";
      fixedSamplesPartitionCreator.LeftSideParameter.ActualName = FixedSamplesPartitionParameterName;
      fixedSamplesPartitionCreator.RightSideParameter.ActualName = FixedSamplesPartitionsParameterName;

      SubScopesCreator insertionPoint = OperatorGraph.Iterate().OfType<SubScopesCreator>().First();
      islandIndexAssigner.Successor = fixedSamplesPartitionCreator;
      fixedSamplesPartitionCreator.Successor = insertionPoint.Successor;
      insertionPoint.Successor = islandIndexAssigner;

      //RandomCreator insertionPoint = OperatorGraph.Iterate().OfType<RandomCreator>().Skip(1).First();
      //fixedSamplesPartitionCreator.Successor = insertionPoint.Successor;
      //insertionPoint.Successor = fixedSamplesPartitionCreator;

      RegisterParameterEvents();
      RecalculateFixedSamplesPartitions();
    }

    private void RegisterParameterEvents() {
      if (Problem != null) Problem.FitnessCalculationPartition.ValueChanged += Problem_Reset;
      NumberOfIslandsParameter.ValueChanged += NumberOfIslandsParameter_ValueChanged;
      NumberOfIslandsParameter.Value.ValueChanged += (o, ev) => RecalculateFixedSamplesPartitions();
      FixedSamplesParameter.Value.ValueChanged += (o, e) => {
        RecalculateFixedSamplesPartitions();
        ReevaluateImmigrants = FixedSamples >= Problem.FitnessCalculationPartition.Size;
      };
      Analyzer.Operators.PropertyChanged += (o, e) => ParameterizeAnalyzers();
      EvaluatorParameter.ValueChanged += (o, e) => ParameterizeEvaluator();
    }

    protected override void ParameterizeSolutionsCreator() {
      base.ParameterizeSolutionsCreator();
      SolutionsCreator.EvaluatorParameter.ActualName = EvaluatorParameterName;
    }

    protected override void ParameterizeMainLoop() {
      base.ParameterizeMainLoop();
      MainLoop.EvaluatorParameter.ActualName = EvaluatorParameterName;
      MainLoop.QualityParameter.ActualName = EvaluatorParameter.Value.QualityParameter.ActualName;
    }

    protected override void ParameterizeAnalyzers() {
      base.ParameterizeAnalyzers();
      foreach (var analyzer in Analyzer.Operators.OfType<ISymbolicDataAnalysisAnalyzer>()) {
        IParameter evaluatorParameter;
        if (analyzer.Parameters.TryGetValue("Evaluator", out evaluatorParameter)) {
          ILookupParameter param = evaluatorParameter as ILookupParameter;
          if (evaluatorParameter != null) param.ActualName = ProblemEvaluatorParameterName;
        }
      }
    }

    private void ParameterizeEvaluator() {
      var evaluator = EvaluatorParameter.Value;

      var randomEvaluator = evaluator as RandomSamplesEvaluator;
      if (randomEvaluator != null) {
        ReevaluteElites = randomEvaluator.RandomSamples != 0;
      }

      var consecutiveEvaluator = evaluator as ConsecutiveSamplesEvaluator;
      if (consecutiveEvaluator != null) {
        consecutiveEvaluator.DataMigrationIntervalParameter.ActualName = MigrationIntervalParameter.Name;
      }
    }

    private void NumberOfIslandsParameter_ValueChanged(object sender, EventArgs e) {
      NumberOfIslands.ValueChanged += (o, ev) => RecalculateFixedSamplesPartitions();
      RecalculateFixedSamplesPartitions();
    }

    protected override void Problem_Reset(object sender, EventArgs e) {
      FixedSamples = Problem.FitnessCalculationPartition.Size / NumberOfIslands.Value;
      base.Problem_Reset(sender, e);
    }

    protected override void OnProblemChanged() {
      Problem.FitnessCalculationPartition.ValueChanged += Problem_Reset;
      FixedSamples = Problem.FitnessCalculationPartition.Size / NumberOfIslands.Value;

      if (Problem != null && EvaluatorParameter.Value == null) {
        EvaluatorParameter.Value = new RandomSamplesEvaluator();
      } else if (Problem == null)
        EvaluatorParameter.Value = null;

      ParameterizeStochasticOperator(EvaluatorParameter.Value);
      RecalculateFixedSamplesPartitions();
      base.OnProblemChanged();
    }

    private void RecalculateFixedSamplesPartitions() {
      if (Problem == null) {
        FixedSamplesPartitions = new ItemArray<IntRange>(Enumerable.Repeat(new IntRange(), NumberOfIslands.Value));
        return;
      }
      var samplesStart = Problem.FitnessCalculationPartition.Start;
      var samplesEnd = Problem.FitnessCalculationPartition.End;
      var totalSamples = Problem.FitnessCalculationPartition.Size;
      var fixedSamples = FixedSamples;
      var islands = NumberOfIslands.Value;

      int offset = (int)Math.Ceiling(((double)(totalSamples - fixedSamples)) / (islands - 1));
      List<IntRange> partitions = new List<IntRange>();
      for (int i = 0; i < islands; i++) {
        var partitionStart = samplesStart + offset * i;
        partitions.Add(new IntRange(partitionStart, partitionStart + fixedSamples));
      }

      //it can be the case that the last partitions exceeds the allowed samples
      //move the last partition forward.
      int exceedsSamples = partitions[partitions.Count - 1].End - samplesEnd;
      if (exceedsSamples > 0) {
        partitions[partitions.Count - 1].Start -= exceedsSamples;
        partitions[partitions.Count - 1].End -= exceedsSamples;
      }
      FixedSamplesPartitions = new ItemArray<IntRange>(partitions);
    }

  }
}