source: branches/ALPS/HeuristicLab.Algorithms.ALPS/3.3/LayerReseeder.cs @ 13096

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2015 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.Drawing;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Selection;

namespace HeuristicLab.Algorithms.ALPS {
  [Item("LayerReseeder", "An operator that encapsulates the reseeding of the lowest layer in ALPS.")]
  [StorableClass]
  public sealed class LayerReseeder : SingleSuccessorOperator, IOperatorGraphOperator {
    public static new Image StaticItemImage {
      get { return HeuristicLab.Common.Resources.VSImageLibrary.Module; }
    }
    public override Image ItemImage {
      get {
        if (Breakpoint) return HeuristicLab.Common.Resources.VSImageLibrary.BreakpointActive;
        else return base.ItemImage;
      }
    }

    private ILookupParameter<BoolValue> ContinuousReseedingParameter {
      get { return (ILookupParameter<BoolValue>)Parameters["ContinuousReseeding"]; }
    }
    private ILookupParameter<IntValue> GenerationsParameter {
      get { return (ILookupParameter<IntValue>)Parameters["Generations"]; }
    }
    private ILookupParameter<IntValue> AgeGapParameter {
      get { return (ILookupParameter<IntValue>)Parameters["AgeGap"]; }
    }

    [Storable]
    private OperatorGraph operatorGraph;
    public OperatorGraph OperatorGraph {
      get { return operatorGraph; }
    }

    [StorableConstructor]
    private LayerReseeder(bool deserializing)
      : base(deserializing) { }

    private LayerReseeder(LayerReseeder original, Cloner cloner)
      : base(original, cloner) {
      operatorGraph = cloner.Clone(original.operatorGraph);
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new LayerReseeder(this, cloner);
    }

    public LayerReseeder()
      : base() {
      Parameters.Add(new LookupParameter<BoolValue>("ContinuousReseeding"));
      Parameters.Add(new LookupParameter<IntValue>("Generations"));
      Parameters.Add(new LookupParameter<IntValue>("AgeGap"));

      operatorGraph = new OperatorGraph();

      var subScopesCounter = new SubScopesCounter();
      var numberOfReplacedCalculator = new ExpressionCalculator() { Name = "NumberOfReplaced = if ContinuousReseeding then max(LayerPopulationSize - (PopulationSize - PopulationSize / AgeGap), 0) else PopulationSize" };
      var numberOfNewIndividualsCalculator = new ExpressionCalculator() { Name = "NumberOfNewIndividuals = PopulationSize - (LayerPopulatioSize - NumberOfReplaced)" };
      var oldestSelector = new BestSelector();
      var processOldest = new SubScopesProcessor();
      var removeIndividuals = new SubScopesRemover();
      var createIndividuals = new SolutionsCreator();
      var mergeIndididuals = new MergingReducer();
      var initializeAgeProsessor = new UniformSubScopesProcessor();
      var initializeAge = new VariableCreator() { Name = "Initialize Age" };
      var incrEvaluatedSolutionsAfterReseeding = new SubScopesCounter() { Name = "Update EvaluatedSolutions" };
      var subScopesCounter2 = new SubScopesCounter();

      OperatorGraph.InitialOperator = subScopesCounter;

      subScopesCounter.ValueParameter.ActualName = "LayerPopulationSize";
      subScopesCounter.AccumulateParameter.Value = new BoolValue(false);
      subScopesCounter.Successor = numberOfReplacedCalculator;

      numberOfReplacedCalculator.CollectedValues.Add(new LookupParameter<BoolValue>("ContinuousReseeding"));
      numberOfReplacedCalculator.CollectedValues.Add(new LookupParameter<IntValue>("LayerPopulationSize"));
      numberOfReplacedCalculator.CollectedValues.Add(new LookupParameter<IntValue>("PopulationSize"));
      numberOfReplacedCalculator.CollectedValues.Add(new LookupParameter<IntValue>("AgeGap"));
      numberOfReplacedCalculator.ExpressionResultParameter.ActualName = "NumberOfReplaced";
      const string numSelected = "LayerPopulationSize PopulationSize PopulationSize AgeGap / - -";
      numberOfReplacedCalculator.ExpressionParameter.Value = new StringValue(numSelected + " 0 0 " + numSelected + " < if PopulationSize ContinuousReseeding if toint");
      numberOfReplacedCalculator.Successor = numberOfNewIndividualsCalculator;

      numberOfNewIndividualsCalculator.CollectedValues.Add(new LookupParameter<IntValue>("PopulationSize"));
      numberOfNewIndividualsCalculator.CollectedValues.Add(new LookupParameter<IntValue>("NumberOfReplaced"));
      numberOfNewIndividualsCalculator.CollectedValues.Add(new LookupParameter<IntValue>("LayerPopulationSize"));
      numberOfNewIndividualsCalculator.ExpressionResultParameter.ActualName = "NumberOfNewIndividuals";
      numberOfNewIndividualsCalculator.ExpressionParameter.Value = new StringValue("PopulationSize LayerPopulationSize NumberOfReplaced - - toint");
      numberOfNewIndividualsCalculator.Successor = oldestSelector;

      oldestSelector.QualityParameter.ActualName = "Age";
      oldestSelector.NumberOfSelectedSubScopesParameter.ActualName = "NumberOfReplaced";
      oldestSelector.MaximizationParameter.Value = new BoolValue(true);
      oldestSelector.CopySelected = new BoolValue(false);
      oldestSelector.Successor = processOldest;

      processOldest.Operators.Add(new EmptyOperator());
      processOldest.Operators.Add(removeIndividuals);
      processOldest.Successor = mergeIndididuals;

      removeIndividuals.Successor = createIndividuals;

      createIndividuals.NumberOfSolutionsParameter.ActualName = "NumberOfNewIndividuals";
      createIndividuals.Successor = initializeAgeProsessor;

      initializeAgeProsessor.Operator = initializeAge;
      initializeAgeProsessor.Successor = incrEvaluatedSolutionsAfterReseeding;

      initializeAge.CollectedValues.Add(new ValueParameter<DoubleValue>("Age", new DoubleValue(0)));
      initializeAge.Successor = null;

      incrEvaluatedSolutionsAfterReseeding.ValueParameter.ActualName = "EvaluatedSolutions";
      incrEvaluatedSolutionsAfterReseeding.AccumulateParameter.Value = new BoolValue(true);
      incrEvaluatedSolutionsAfterReseeding.Successor = null;

      mergeIndididuals.Successor = subScopesCounter2;

      subScopesCounter2.ValueParameter.ActualName = "LayerPopulationSize";
      subScopesCounter2.AccumulateParameter.Value = new BoolValue(false);
    }

    public override IOperation Apply() {
      bool continuousReseeding = ContinuousReseedingParameter.ActualValue.Value;
      int generations = GenerationsParameter.ActualValue.Value;
      int ageGap = AgeGapParameter.ActualValue.Value;

      var next = new OperationCollection(base.Apply());
      if (continuousReseeding || generations % ageGap == 0) {
        var layerZeroScope = ExecutionContext.Scope.SubScopes[0];
        if (operatorGraph.InitialOperator != null)
          next.Insert(0, ExecutionContext.CreateChildOperation(operatorGraph.InitialOperator, layerZeroScope));
      }
      return next;
    }
  }
}