source: branches/2936_GQAPIntegration/HeuristicLab.Problems.GeneralizedQuadraticAssignment/3.3/Operators/Crossovers/MultiGQAPCrossover.cs @ 16712

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 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.Linq;
using HeuristicLab.Collections;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Encodings.IntegerVectorEncoding;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.PluginInfrastructure;
using HEAL.Attic;

namespace HeuristicLab.Problems.GeneralizedQuadraticAssignment {
  [Item("MultiGQAPCrossover", "Randomly selects and applies one of its crossovers every time it is called.")]
  [StorableType("C8AA967E-11CF-48A0-BEC2-71A9ABEB1801")]
  public class MultiGQAPCrossover : StochasticMultiBranch<IGQAPCrossover>, IGQAPCrossover, IProblemInstanceAwareGQAPOperator, IStochasticOperator {
    public override bool CanChangeName {
      get { return false; }
    }
    protected override bool CreateChildOperation {
      get { return true; }
    }

    public IScopeTreeLookupParameter<IntegerVector> ParentsParameter {
      get { return (ScopeTreeLookupParameter<IntegerVector>)Parameters["Parents"]; }
    }
    public ILookupParameter<IntegerVector> ChildParameter {
      get { return (ILookupParameter<IntegerVector>)Parameters["Child"]; }
    }
    public ILookupParameter<GQAPInstance> ProblemInstanceParameter {
      get { return (ILookupParameter<GQAPInstance>)Parameters["ProblemInstance"]; }
    }

    [StorableConstructor]
    protected MultiGQAPCrossover(StorableConstructorFlag _) : base(_) { }
    protected MultiGQAPCrossover(MultiGQAPCrossover original, Cloner cloner) : base(original, cloner) { }
    public MultiGQAPCrossover()
      : base() {
      Parameters.Add(new ScopeTreeLookupParameter<IntegerVector>("Parents", "The parent vectors which should be crossed.", "Assignment"));
      Parameters.Add(new LookupParameter<IntegerVector>("Child", "The child vector resulting from the crossover.", "Assignment"));
      Parameters.Add(new LookupParameter<GQAPInstance>("ProblemInstance", GQAP.ProblemInstanceDescription));

      foreach (Type type in ApplicationManager.Manager.GetTypes(typeof(IGQAPCrossover))) {
        if (!typeof(MultiOperator<IGQAPCrossover>).IsAssignableFrom(type))
          Operators.Add((IGQAPCrossover)Activator.CreateInstance(type), true);
      }
    }

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

    protected override void Operators_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<IGQAPCrossover>> e) {
      base.Operators_ItemsAdded(sender, e);
      Parameterize();
    }
    protected override void Operators_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<IGQAPCrossover>> e) {
      base.Operators_ItemsRemoved(sender, e);
      Parameterize();
    }

    private void Parameterize() {
      foreach (var op in Operators.OfType<IGQAPCrossover>()) {
        op.ParentsParameter.ActualName = ParentsParameter.Name;
        op.ParentsParameter.Hidden = true;
        op.ChildParameter.ActualName = ChildParameter.Name;
        op.ChildParameter.Hidden = true;
      }
      foreach (var op in Operators.OfType<IStochasticOperator>()) {
        op.RandomParameter.ActualName = RandomParameter.Name;
        op.RandomParameter.Hidden = true;
      }
      foreach (var op in Operators.OfType<IProblemInstanceAwareGQAPOperator>()) {
        op.ProblemInstanceParameter.ActualName = ProblemInstanceParameter.Name;
        op.ProblemInstanceParameter.Hidden = true;
      }
    }

    public override IOperation InstrumentedApply() {
      if (Operators.Count == 0) throw new InvalidOperationException(Name + ": Please add at least one crossover to choose from.");
      return base.InstrumentedApply();
    }
  }
}