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

Last change on this file since 13336 was 13336, checked in by mkommend, 5 years ago

#2521: Refactored encodings and problems.

File size: 4.5 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    [Storable]
63    private ISolutionCreator<TSolution> solutionCreator;
64    public ISolutionCreator<TSolution> SolutionCreator {
65      get {
66        return solutionCreator;
67      }
68      set {
69        if (value == null) throw new ArgumentNullException("SolutionCreator must not be null.");
70        if (solutionCreator == value) return;
71        encodingOperators.Remove(solutionCreator);
72        encodingOperators.Add(value);
73        solutionCreator = value;
74        OnSolutionCreatorChanged();
75      }
76    }
77
78    [StorableConstructor]
79    protected Encoding(bool deserializing) : base(deserializing) { }
80    protected Encoding(Encoding<TSolution> original, Cloner cloner)
81      : base(original, cloner) {
82      encodingOperators = cloner.Clone(original.encodingOperators);
83      solutionCreator = cloner.Clone(original.solutionCreator);
84    }
85    protected Encoding(string name)
86      : base(name) {
87      Parameters.Add(new FixedValueParameter<ReadOnlyItemSet<IOperator>>(name + ".Operators", "The operators that the encoding specifies.", encodingOperators.AsReadOnly()));
88    }
89
90    protected bool AddOperator(IOperator @operator) {
91      return encodingOperators.Add(@operator);
92    }
93
94    protected bool RemoveOperator(IOperator @operator) {
95      return encodingOperators.Remove(@operator);
96    }
97
98    public void ConfigureOperator(IOperator @operator) { ConfigureOperators(new[] { @operator }); }
99    public abstract void ConfigureOperators(IEnumerable<IOperator> operators);
100
101    public event EventHandler SolutionCreatorChanged;
102    protected virtual void OnSolutionCreatorChanged() {
103      ConfigureOperator(SolutionCreator);
104      var handler = SolutionCreatorChanged;
105      if (handler != null) handler(this, EventArgs.Empty);
106    }
107
108    public event EventHandler OperatorsChanged;
109    protected virtual void OnOperatorsChanged() {
110      ConfigureOperators(Operators);
111      var handler = OperatorsChanged;
112      if (handler != null) handler(this, EventArgs.Empty);
113    }
114  }
115}
Note: See TracBrowser for help on using the repository browser.