source: branches/ProgrammableProblem/HeuristicLab.Problems.Programmable/3.3/Encodings/Encoding.cs @ 11598

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

namespace HeuristicLab.Problems.Programmable {
  [Item("Encoding", "Base class for describing different encodings.")]
  [StorableClass]
  public abstract class Encoding<T> : ParameterizedNamedItem, IEncoding
    where T : class,ISolutionCreator {
    public override sealed bool CanChangeName {
      get { return false; }
    }

    protected HashSet<IOperator> encodingOperators = new HashSet<IOperator>(new TypeEqualityComparer<IOperator>());
    [Storable]
    public IEnumerable<IOperator> Operators {
      get { return encodingOperators; }
      private set { encodingOperators = new HashSet<IOperator>(value, new TypeEqualityComparer<IOperator>()); }
    }

    ISolutionCreator IEncoding.SolutionCreator {
      get { return SolutionCreator; }
      set {
        if (!(value is T)) throw new ArgumentException(string.Format("Cannot assign the solution creator {0} to the encoding {1}.", value.GetType().GetPrettyName(), GetType().GetPrettyName()));
        SolutionCreator = (T)value;
      }
    }
    private T solutionCreator;
    public T SolutionCreator {
      get {
        return solutionCreator;
      }
      set {
        if (value == null) throw new ArgumentNullException("SolutionCreator must not be null.");
        if (solutionCreator == value) return;
        encodingOperators.Remove(solutionCreator);
        encodingOperators.Add(value);
        solutionCreator = value;
        OnSolutionCreatorChanged();
      }
    }

    [StorableConstructor]
    protected Encoding(bool deserializing) : base(deserializing) { }

    protected Encoding(Encoding<T> original, Cloner cloner)
      : base(original, cloner) {
      encodingOperators = new HashSet<IOperator>(original.Operators.Select(cloner.Clone));
      solutionCreator = cloner.Clone(original.solutionCreator);
    }
    protected Encoding(string name) : base(name) { }

    public virtual  Individual CreateIndividual(IScope scope) {
      return new Individual(this, scope);
    }

    public abstract void ConfigureOperators(IEnumerable<IOperator> operators);
    public void ConfigureOperator(IOperator @operator) { ConfigureOperators(new[] { @operator }); }

    public event EventHandler SolutionCreatorChanged;
    protected virtual void OnSolutionCreatorChanged() {
      ConfigureOperator(SolutionCreator);
      var handler = SolutionCreatorChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }


    public event EventHandler ParameterConfigurationChanged;
    protected virtual void OnParameterConfigurationChanged() {
      var handler = ParameterConfigurationChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
  }
}