source: branches/ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Encoding.cs @ 13396

Last change on this file since 13396 was 13396, checked in by abeham, 4 years ago

#2521:

  • Refactored QuadraticAssignmentProblem to use new SingleObjectiveProblem
    • Removed QAPEvaluator
    • Adapted RobustTabooSearch
  • Introduced several interfaces in PermutationEncoding necessary for wiring
  • Changed all Encodings to use IItem instead of IOperator in ConfigureOperators (name still unchanged)
  • Added a protected MaximizationParameter property in SingleObjectiveProblem (necessary for wiring)
  • Changed AlleleFrequnencyAnalyzer to use ISolution interface instead of IItem
  • Added a comment to ISolutionCreator<TSolution> of some changes that would be welcomed
File size: 4.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Parameters;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Optimization {
31  [Item("Encoding", "Base class for describing different encodings.")]
32  [StorableClass]
33  public abstract class Encoding<TSolution> : ParameterizedNamedItem, IEncoding<TSolution>
34    where TSolution : class,ISolution {
35    public override sealed bool CanChangeName {
36      get { return false; }
37    }
38
39    private ItemSet<IOperator> encodingOperators = new ItemSet<IOperator>(new TypeEqualityComparer<IOperator>());
40
41    [Storable(Name = "Operators")]
42    private IEnumerable<IOperator> StorableOperators {
43      get { return encodingOperators; }
44      set { encodingOperators = new ItemSet<IOperator>(value, new TypeEqualityComparer<IOperator>()); ; }
45    }
46
47    public IEnumerable<IOperator> Operators {
48      get { return encodingOperators; }
49      set {
50        if (!value.OfType<ISolutionCreator<TSolution>>().Any())
51          throw new ArgumentException("The provided operators contain no suitable solution creator");
52        encodingOperators.Clear();
53        foreach (var op in value) encodingOperators.Add(op);
54
55        ISolutionCreator<TSolution> newSolutionCreator = (ISolutionCreator<TSolution>)encodingOperators.FirstOrDefault(o => o.GetType() == solutionCreator.GetType()) ??
56                               encodingOperators.OfType<ISolutionCreator<TSolution>>().First();
57        SolutionCreator = newSolutionCreator;
58        OnOperatorsChanged();
59      }
60    }
61
62    ISolutionCreator IEncoding.SolutionCreator {
63      get { return solutionCreator; }
64    }
65
66    [Storable]
67    private ISolutionCreator<TSolution> solutionCreator;
68    public ISolutionCreator<TSolution> SolutionCreator {
69      get {
70        return solutionCreator;
71      }
72      set {
73        if (value == null) throw new ArgumentNullException("SolutionCreator must not be null.");
74        if (solutionCreator == value) return;
75        encodingOperators.Remove(solutionCreator);
76        encodingOperators.Add(value);
77        solutionCreator = value;
78        OnSolutionCreatorChanged();
79      }
80    }
81
82    [StorableConstructor]
83    protected Encoding(bool deserializing) : base(deserializing) { }
84    protected Encoding(Encoding<TSolution> original, Cloner cloner)
85      : base(original, cloner) {
86      encodingOperators = cloner.Clone(original.encodingOperators);
87      solutionCreator = cloner.Clone(original.solutionCreator);
88    }
89    protected Encoding(string name)
90      : base(name) {
91      Parameters.Add(new FixedValueParameter<ReadOnlyItemSet<IOperator>>(name + ".Operators", "The operators that the encoding specifies.", encodingOperators.AsReadOnly()));
92    }
93
94    protected bool AddOperator(IOperator @operator) {
95      return encodingOperators.Add(@operator);
96    }
97
98    protected bool RemoveOperator(IOperator @operator) {
99      return encodingOperators.Remove(@operator);
100    }
101
102    public void ConfigureOperator(IItem @operator) { ConfigureOperators(new[] { @operator }); }
103    public abstract void ConfigureOperators(IEnumerable<IItem> operators);
104
105    public event EventHandler SolutionCreatorChanged;
106    protected virtual void OnSolutionCreatorChanged() {
107      ConfigureOperator(SolutionCreator);
108      var handler = SolutionCreatorChanged;
109      if (handler != null) handler(this, EventArgs.Empty);
110    }
111
112    public event EventHandler OperatorsChanged;
113    protected virtual void OnOperatorsChanged() {
114      ConfigureOperators(Operators);
115      var handler = OperatorsChanged;
116      if (handler != null) handler(this, EventArgs.Empty);
117    }
118  }
119}
Note: See TracBrowser for help on using the repository browser.